HLR/HSS

Protei HLR/HSS

User Guide

Saint-Petersburg
2016
 Copyright
No reproduction or usage of this document or any extracts herefrom with modifications or
in translation shall be allowed without a preliminary permission from PROTEI.
 TABLE OF CONTENTS
1 GENERAL INFORMATION ........................................................................................................................ 5
1.1 PURPOSE OF THE DOCUMENT ....................................................................................................................... 5
1.2 STRUCTURE OF THE DOCUMENT ................................................................................................................... 5
1.3 TECHNICAL SUPPORT ................................................................................................................................... 6
1.3.1 Manufacturer ...................................................................................................................................... 6
1.3.2 Technical support group ..................................................................................................................... 6
1.4 LIST OF ACRONYMS USED IN THE DOCUMENT .............................................................................................. 7
2 SYSTEM DESCRIPTION ............................................................................................................................. 8
2.1 FUNCTIONALITY .......................................................................................................................................... 8
2.2 SYSTEM ARCHITECTURE .............................................................................................................................. 9
2.3 PRINCIPLES OF INTERACTION WITH EXTERNAL APPLICATIONS OF A COMMUNICATION NETWORK
OPERATOR 10
2.3.1 Requests over http ............................................................................................................................. 11
2.3.2 Requests over MAP ........................................................................................................................... 11
2.3.3 Requests over Diameter S6A/S6D ..................................................................................................... 13
2.3.4 Requests over Cx Interface ............................................................................................................... 13
2.3.5 Requests over Sh Interface ................................................................................................................ 13
3 CONFIGURATION ...................................................................................................................................... 14
3.1 LEGEND ..................................................................................................................................................... 14
3.2 SIGTRAN AND DIAMETER LEVEL CONFIGURING ...................................................................................... 14
3.2.1 Determining the Sigtran and Diameter configuration in-use files (config.cfg) ................................ 14
3.2.2 Configuring the SCCP level parameters (SCCP.cfg) ........................................................................ 15
3.2.3 Configuring the TCAP-interaction parameters (TCAP.cfg) ............................................................. 15
3.2.4 Configuration of Interaction over the Protocol (m2pa.cfg) .............................................................. 16
3.2.5 Configuring interaction parameters via the m3ua protocol (m3ua.cfg) ........................................... 17
3.2.6 Configuring the Diameter-interaction parameters (diameter.cfg) .................................................... 21
3.3 CONFIGURATION OF GENERAL PARAMETERS OF THE SYSTEM (PROTEI.CFG) .............................................. 22
3.4 MAIN PARAMETERS OF THE HLR/HSS ...................................................................................................... 23
3.4.1 Configuration of Loading of Subscribers .......................................................................................... 23
3.4.2 Loading of CAMEL Profile ............................................................................................................... 24
3.4.3 Loading of PDP ................................................................................................................................ 26
3.4.4 Loading of White Lists ...................................................................................................................... 27
3.4.1 Configuration of Local Host of Diameter interface (diameter.cfg) .................................................. 28
3.5 CONFIGURATION OF GENERAL PARAMETERS OF THE BS (DB.CFG) ............................................................. 30
3.6 CONFIGURATION OF PARAMETERS OF THE INTERFACE WITH THE MOBILE NETWORK (GSM.CFG) ................ 32
3.7 CONFIGURATION OF OMI-CONNECTION PARAMETERS (OM_INTERFACE.CFG) ........................................... 35
3.8 CONFIGURATION OF THE LICENSE FILE (LICENSE.CFG) ............................................................................... 39
3.9 ROUTING PARAMETERS CONFIGURATION (SCCP_ROUTING.CFG) ................................................................ 40
3.10 CONFIGURATION OF PARAMETERS OF STATISTICS (STATISTICS.CFG)......................................................... 41
3.11 TRACING SYSTEM (TRACE.CFG) ................................................................................................................. 41
3.12 ALARM INDICATION SUBSYSTEM PARAMETERS (AP.CFG) ...................................................................... 49
3.13 RULES OF ASSIGNING THE TRAPS OF SPECIFICTRAP (AP_DISTIONARY.CFG) ........................................... 52
4 LOGS ............................................................................................................................................................. 53
4.1 CDR RECORDS OF DIAMETER-INTERACTION ............................................................................................. 53
4.1.1 CDR records of transactions from MME/SGSN to HSS.................................................................... 53
4.1.2 CDR records of transactions from HSS to MME/SGSN.................................................................... 54
4.1.3 CDR records of transactions from I-CSCF to HSS ........................................................................... 55
4.1.4 CDR records of transactions from S-CSCF to HSS .......................................................................... 55
4.1.5 CDR records of transactions from HSS to S-CSCF .......................................................................... 56
4.1.6 CDR records of transactions from AS to HSS ................................................................................... 57
4.1.7 CDR records of transactions from HSS to AS ................................................................................... 57
4.1.8 Description of fields .......................................................................................................................... 58
4.2 CDR RECORDS ABOUT SUBSCRIBER LOADING OPERATIONS ..................................................................... 59
4.2.1 Parameters of the direction from VLR/MSC to HLR/HSS ................................................................ 60
4.2.2 Parameters of the direction from HLR/HSS to VLR/MSC ................................................................ 61
4.2.3 Description of parameters ................................................................................................................ 62
4.3 TRAFFIC STATISTICS .................................................................................................................................. 67
4.3.1 CDR records of traffic statistics ........................................................................................................ 67
 User Guide HLR/HSS

4.4 STATISTICS ON SUBSCRIBERS .................................................................................................................... 68

4.4.1 CDR records of subscriber statistics................................................................................................. 69
5 ALARM INDICATION ................................................................................................................................ 70
5.1 GENERATING TRAPS WITH TRAP.PL SCRIPT ................................................................................................ 72
5.2 RELOAD OF PARAMETERS .......................................................................................................................... 73
6 APPENDICES ............................................................................................................................................... 74
APPENDIX1: PROTEI HLR/HSS API ...................................................................................................................... 74
PURPOSE ............................................................................................................................................................... 74
DEFINITIONS, ACRONYMS AND ABBREVIATIONS .................................................................................................. 74
OVERVIEW ............................................................................................................................................................ 74
JSON OVER HTTP INTERFACE .............................................................................................................................. 75
GENERAL .............................................................................................................................................................. 75
6.1 REQUESTS TO PROTEI ................................................................................................................................ 75
6.1.1 Add subscriber (/SubscriberService/AddSubscriber) ........................................................................ 75
6.1.2 Delete subscriber (DeleteSubscriber) ............................................................................................... 77
6.1.3 Change status (ChangeStatus) .......................................................................................................... 78
6.1.4 Change MSISDN (SetMSISDN) ........................................................................................................ 79
6.1.5 Change Profile (ProfileControl) ....................................................................................................... 80
6.1.6 Get Profile (ProfileControl).............................................................................................................. 82
6.1.7 Change IMSI (Change IMSI) ............................................................................................................ 85
6.1.8 AddAndActivateEmptySubscribers (/SubscriberService/AddAndActivateEmptySubscribers) .......... 86
6.2 SUBSCRIBER PROFILE ENTRIES ................................................................................................................... 87
6.2.1 ODB Parameters ............................................................................................................................... 87
6.2.2 CAMEL Parameters .......................................................................................................................... 88
6.2.3 SS Parameters ................................................................................................................................... 88
6.2.4 PDP Parameters ............................................................................................................................... 90
6.2.5 EPS Parameters ................................................................................................................................ 92
6.2.6 AUC Data ......................................................................................................................................... 95
BEARER SERVICE CODE ................................................................................................................................ 96
TELESERVICE ................................................................................................................................................... 98
SUPPLEMENTARY SERVICE CODES ......................................................................................................... 100

Page 4 of 100
 User Guide HLR/HSS

1 General Information
1.1 Purpose of the document
This user guide describes the functions of the system, its software, configuration, logs,
as well as storage and transportation requirements.

1.2 Structure of the document

This guide comprises the following principal sections:
“General Information” – this section describes the purpose and structure of the
document, and also provides information about the manufacturer and technical support.
“System Description” – this section describes the purpose, functionality and architecture
of the system, as well as the interaction between the architectural elements.
“Configuration” – this section describes the configuration files used for configuring the
system.
“Logs” – this section describes CDR and log-files generated by the system.
“Alarm indication” - this section describes Alarms generated by the system.
“Appendix” – additional information, contains describes API.

Attention!
Please familiarize yourself with the certificate of the device and the operating
documentation prior to installing and operating the system.
This document must be kept near the device at all times.

Page 5 of 100
 User Guide HLR/HSS

1.3 Technical support

Technical support and any additional consulting regarding issues that may arise during
the installation and operation of the product are provided by the manufacturer and the
technical support group.

1.3.1 Manufacturer
PROTEI Scientific Technical Center
St. Petersburg, 194044, Russia
60A B. Sampsonievsky
Business Center “Telecom SPb”
Tel.: +7 (812) 449-47-27
Fax: +7 (812) 449-47-29
WEB: http://www.protei.ru
Е-mail: [email protected]

1.3.2 Technical support group

PROTEI Scientific Technical Center
St. Petersburg, 194044, Russia
60A B. Sampsonievsky
Business Center “Telecom SPb”
Tel.: +7 (812) 449-47-27 ext. 5888 (round-the-clock)
Fax: +7 (812) 449-47-29
WEB: http://www.protei.ru
Е-mail: [email protected]

Page 6 of 100
 User Guide HLR/HSS

1.4 List of acronyms used in the document

API — application programming interface.
AUC — Authentification Center.
CAMEL — Customized Applications for Mobile network Enhanced Logic.
CAP — CAMEL Application Part.
DP — Detection Point.
D-CSI — Dialled Services CAMEL Subscription Information.
GGSN — Gateway GPRS Support Node.
GMSC — Gateway MSC.
GPRS — General Packet Radio Service.
gprsSSF — GPRS Service Switching Function.
GPRS-CSI — GPRS CAMEL Subscription Information.
gsmSCF — GSM Service Control Function.
gsmSRF — GSM Specialised Resource Function.
gsmSSF — GSM Service Switching Function.
HLR — Home Location Register.
HSS—Home Subscriber Server.
HPLMN — Home PLMN.
IMSI — International Mobile Subscriber Identity.
MME — Mobility Management Entity
MO-SMS-CSI — Mobile Originated Short Message Service CAMEL Subscription
Information.
MSC — Mobile service Switching Centre.
MSISDN — Mobile Subscriber Integrated Services Digital Number.
MT-SMS-CSI — Mobile Terminating Short Message Service CAMEL Subscription
Information.
O-CSI — Originating CAMEL Subscription Information.
PDP — Packet Data Protocol.
PLMN — Public Land Mobile Network.
SGSN — Serving GPRS Support Node.
SMS — Short Message Service.
SMSC — Short Message Service Centre.
SMS-CSI — Short Message Service CAMEL Subscription Information.
SS-CSI — Supplementary Service Notification CAMEL Subscription Information.
T-CSI — Terminating CAMEL Subscription Information.
TDP — Trigger Detection Point.
VLR — Visitor Location Register.
VPLMN — Visited PLMN.

Page 7 of 100
 User Guide HLR/HSS

2 System Description
HLR/HSS is a distributed database that can be installed in networks of mobile network
operators providing communications services.
The HLR/HSS contains complete information on subscriber profiles of the operator,
including IMSI (unique SIM-card identifier), MSISDN (phone number), information on the last
site of subscriber registration, the list of available services and some other parameters.
In the HLR/HSS the key data field of a subscriber is the IMSI — International Mobile
Subscriber Identity. IMSI contained in the SIM card, that subscriber receives after signing the
contract with the operator.
Main purpose of the HLR/HSS is to control the process of moving mobile subscribers by:
• sending subscriber information to the VLR, MME or the SGSN when the subscriber
connects to the network for the first time;
• acting as an intermediary between the GMSC or the SMS and the VLR in order to
support incoming calls or incoming text messages;
• deleting subscriber data from the VLR, or the SGSN, or the MME after the subscriber
leaves its service area.
In order to fulfil these functions, the HLR/HSS stores the following information for each
subscriber:
• IMSI-MSISDN relation and the subscriber status;
• current subscriber location (VLR, MME, SGSN);
• CAMEL profiles of the subscriber;
• GPRS profile for allowing subscriber access to packet data transfer network;
• VAS provided to the subscriber.
An integrated Authentification Center (AuC) for authenticating subscribers is
implemented in PROTEI HLR/HSS.

2.1 Functionality
1. Authentication procedure, which uses the integrated Authentification Centre (AuC)
system. AuC ensures security and protects the network from unauthorized access.
• Storing Ki and the encryption algorithm for each subscriber (IMSI)
• Generation of triplets/quintuplets
2. Procedure of subscriber registration in GSM/UMTS/GPRS/LTE.
• Allowing/denying registration in this particular network;
• Sending subscriber profile to a new VLR/SGSN/MME;
• Updating information on subscriber location;
• Deleting subscriber profile from the "old" VLR/SGSN;
3. Providing information about subscriber location in order to support incoming calls
and incoming SMS messages;
4. Allowing subscribers to manage their own profiles (VAS services);
5. Interaction with the USSDC in order to send USSD phase 1, 2;
6. Allowing to manage subscriber profiles through API:
load/edit/delete profiles in the HLR/HSS using http/xml.

Page 8 of 100
 User Guide HLR/HSS

2.2 System Architecture

PROTEI
HSS/HLR
Cellular
Network Core omi BS jdbc DB

Diameter omi jdbc

EPS S6A/S6D

SIGTRAN API

Diameter
IMS
Cx, Sh
Http

Operator

Figure 1. System Architecture

The system consists of the following software modules:
• Core — the system core, which is responsible for the main functions of all
software modules;
• BS — supports interaction with the database;
• DB — database of the system;
• API — supports requests to the system over http protocol.
Interaction with external network elements is supported over the following protocols:
• Sigtran — protocol for data exchange between HLR/HSS and STP;
• Diameter S6A / S6D — protocol for data exchange between HLR/HSS and
MME/SGSN;
• http — protocol for receiving requests for uploading data to the database
from communication network operators;
• omi — used for communication between system modules (Core / JS / API);
• Diameter Cx, Sh — protocol for data exchange between HLR/HSS and IMS
Core.

Page 9 of 100
 User Guide HLR/HSS

2.3 Principles of Interaction with External

Applications of a Communication Network
Operator
Http-requests from external system with data in json format are handled by HLR/HSS
API module. Interaction with elements of GSM networks is realized over Sigtran.
General diagram provided in the figure below shows how data received from the
external system are saved in the HLR/HSS_API module and how they are sent in the direction
of GSM network elements and IMS:

Figure 2. Diagram of interaction while handling requests through HLR/HSS_API with

GSM network elements and IMS
Operating principles:
• Operator of an external system updates subscriber profiles. The information
arrives in the HLR/HSS_API module over http protocol.
• Depending on the command, the data is written or modified in the HLR/HSS_DB
database.
• Depending on the executed command, the HLR/HSS sends to the VLR/SGSN,
MME/SGSN, S-CSCF and AS a message informing about subscriber profile
changes.
• HLR/HSS sends a request over Sigtran or Diameter S6A/S6D, Cx, Sh, which
contains the modified subscriber profile.
• Network response specifies the status of the operation.
• The operation status is sent in the direction of the operator's external system.
The API is described in the appendices.

Page 10 of 100
 User Guide HLR/HSS

2.3.1 Requests over http

1. Add a subscriber. The following command is used:
/SubscriberService/AddSubscriber
2. Delete a subscriber. The following command is used:
/SubscriberService/DeleteSubscriber
3. Change the status (ChangeStatus). The following command is used:
/SubscriberService/ChangeStatus
Statuses:
• 0 — not provisioned — the SIM-card is not associated with an MSISDN;
• 1 — provisioned/locked — the SIM-card is associated with an MSISDN and
locked;
• 2 — provisioned/unlocked — in service;
• 3 — provisioned/suspended — service is suspended, e.g. due to phone being
stolen;
• 4 — terminated — subscriber deleted.
4. Change MSISDN (SetMSISDN)
The following command allows changing the MSISDN:
/ProfileService/SetMSISDN
5. Change profile (ProfileControl)
The following command allows changing the profile:
/ProfileService/ProfileControl
6. Get profile (ProfileControl)
The following command allows obtaining the profile:
/ProfileService/GetProfile
7. Change IMSI (ChangeIMSI)
The following command allows changing the IMSI:
/ProfileService/ChangeIMSI
Description of the requests parameters presented in Appendix.

2.3.2 Requests over MAP

The list of MAP messages supported by the HLR/HSS:
1. Messages exchanged between the VLR and the HLR/HSS:
• UPDATE_LOCATION message (update information about location of a mobile
subscriber), sent to the HLR/HSS from the VLR of the new service area of the
MS (mobile subscriber);
• CANCEL_LOCATION message (delete information about location of a mobile
subscriber), sent from the HLR/HSS to the VLR of the previous service area of
the MS;
• PURGE_MS message (notification about subscriber data deletion), sent from the
VLR to the HLR/HSS;
• SEND_AUTHENTICATION_INFO message (send information about subscriber
authentication), sent from the VLR to the HLR/HSS;

Page 11 of 100
 User Guide HLR/HSS

• INSERT_SUBSCRIBER_DATA message (send subscriber profile), sent from the

HLR/HSS to the VLR;
• DELETE_SUBSCRIBER_DATA message (delete subscriber profile data), sent from
the HLR/HSS to the VLR;
• PROVIDE_ROAMING_NUMBER message (MSRN request), sent from the HLR/HSS
to the VLR;
• PROVIDE_SUBSCRIBER_INFO message (request subscriber information), sent
from the HLR/HSS to the VLR;
• RESTORE_DATA message (restore data), sent from the VLR to the HLR/HSS;
• AUTHENTICATION_FAILURE_REPORT message (report about authentication
error), sent from the VLR to the HLR/HSS;
• SEND_IMSI message (send IMSI), sent from the VLR to the HLR/HSS;
• READY_FOR_SM message (subscriber ready to receive SMS), sent from the VLR
to the HLR/HSS.
2. Messages exchanged between the SGSN and the HLR/HSS:
• UPDATE_LOCATION_GPRS message (update information about location of a
mobile subscriber), sent to the HLR/HSS from the SGSN of the new service
area of the MS;
• CANCEL_LOCATION message (delete information about location of a mobile
subscriber), sent from the HLR/HSS to the SGSN of the previous service area of
the MS;
• PURGE_MS message (notification about subscriber data deletion), sent from the
SGSN to the HLR/HSS;
• SEND_AUTHENTICATION_INFO message (send information about subscriber
authentication), sent from the SGSN to the HLR/HSS;
• INSERT_SUBSCRIBER_DATA message (send subscriber profile), sent from the
SGSN to the VLR.
3. Messages exchanged between the SMSC and the HLR/HSS:
• SEND_ROUTING_INFORMATION_FOR_SM message (information on subscriber
location), sent from the SMSC to the HLR/HSS;
• REPORT_SM_DELIVERY_STATUS message, sent from the SMSC to the HLR/HSS;
• ALERT_SERVICE_CENTER message (notification on subscriber availability), sent
from the HLR/HSS to the SMSC.
4. Messages exchanged between the GMSC and the HLR/HSS:
• SEND_ROUTING_INFORMATION message (send routing information), sent from
the GMSC to the HLR/HSS.
5. Messages sent between MSC — HLR/HSS — USSDC:
• MAP_PSSD message (Process Unstructured SS Data), sent in the direction of
USSDC;
• MAP_USSR message (Unstructured SS Request), sent in the direction of MSC;
• MAP_USSN message (Unstructured SS Notify), sent in the direction of MSC.
6. Messages exchanged between the gsmSCF and the HLR/HSS:
• MAP_ Any_Time_Interrogation message.

Page 12 of 100
 User Guide HLR/HSS

2.3.3 Requests over Diameter S6A/S6D

1. Messages exchanged between the MME/SGSN and the HSS:
• Update-Location-Request message (update of location information in the HSS), sent
to the HSS from the MME/SGSN;
• Purge-UE-Request message (indication of subscriber profile deletion from the
MME/SGSN), sent to the HSS from the MME/SGSN;
• Authentication-Info-Request message (authentication information), sent to the HSS
from the MME/SGSN;
• ME-Identity-Check-Request message (check of mobile equipment’s identity status),
sent to the HSS from the MME/SGSN;
• Notify-Request message – (notification procedure when an inter MME or SGSN
location update does not occur but the HSS needs to be notified about), sent to the
HSS from the MME/SGSN.
• Insert-Subscriber-Data-Request message (addition of subscriber data), sent to the
MME/SGSN from the HSS;
• Delete-Subscriber-Data-Request message (removal of data of the HSS user profile
stored in the MME or SGSN), sent to the MME/SGSN from the HSS;
• Cancel-Location-Request (detachment of a subscriber), sent to the MME/SGSN from
the HSS.

2.3.4 Requests over Cx Interface

1. Messages exchanged between the I-CSCF and the HSS:
• User-Authorization-Request message (user registration status query), sent to the
HSS from the I-CSCF;
• Location-Info-Request message (user location query), sent to the HSS from the I-
CSCF;
2. Messages exchanged between the S-CSCF and the HSS:
• Server-Assignment-Request message (type of update, request or notification that
the S-CSCF requests in the HSS), sent to the HSS from the S-CSCF;
• Multimedia-Auth-Request (authentication between the end user and the home IMS
network), sent to the HSS from the S-CSCF;
• Registration-Termination-Request (network initiated de-registration by the HSS)
sent to the S-CSCF from the HSS;
• Push-Profile-Request (update of user information initiated by HSS), sent to the S-
CSCF from the HSS.

2.3.5 Requests over Sh Interface

1. Messages exchanged between the AS and the HSS:
• User-Data-Request message (user data request) sent to the HSS from the AS;
• Subscriber-Notify-Request message (notification of changes in user data), sent to the
HSS from the AS;
• Profile-Update-Request message (update of user data in the server), sent to the HSS
from the AS;
• Push-Notification-Request message (notification of changes in the user data in the
server), sent to the AS from the HSS.

Page 13 of 100
 User Guide HLR/HSS

3 Configuration
3.1 Legend
The “Significance of the parameter / restart” field in the configuration tables contains
the following alphabetic codes.

Code Description

O Optional. An optional parameter that can be omitted in the configuration (the default
value of the parameter will be used in this case).

M Mandatory. Required parameter. If this parameter is omitted in the configuration,

the system will not start; during reload of the configuration an error will be shown.

X Parameter is reserved. Using this parameter is forbidden.

P Permanent. Parameter is not reloaded dynamically. It is read when the system

starts.

R Reloadable. This parameter can be changed without restarting the system.

Number (Int) - a parameter format. Possible values from (-2)32 to 232. If no special
parameter values are specified in the description of configuration files to limit the range of
possible values, any possible values may be specified for the optional parameters. It is
prohibited to change the values of mandatory parameters!
String - a parameter format.
Flag (bool) - a parameter format. May take the values of 0 or 1 (true or false).
Template (mask) - a parameter format, set using regular expressions (see Appendices).

3.2 SIGTRAN and Diameter level configuring

The SigTran and Diameter settings are configured by editing configuration files located
in the ./config/component:
− component/config.cfg – file determining the Sigtran and Diameter configuration in-use
files;
− component/diameter.cfg – Diameter level configuring;
− component/m3ua.cfg – main file to configure association parameters;
− component/SCCP.cfg – SCCP level configuring;
− component/TCAP.cfg – TCAP level configuring.

3.2.1 Determining the Sigtran and Diameter configuration in-use files

(config.cfg)
Section [Options]

Parameter Parameter Description

significance/
restart
Flag. Disabling recording to configuration files.
DisableBackup O/P Possible values: 1 – configuration backup is not
used, 0 – is used. Default value = 0

Page 14 of 100
 User Guide HLR/HSS

It is recommended to use the present file with no changes of its parameters.

Example:

[Options]
DisableBackup = 1

[Conformity]
{"Sg$";config/component/m3ua.cfg;}
{"Sg.SS7.SCCP$";config/component/SCCP.cfg;}
{"Sg.SS7.TCAP$";config/component/TCAP.cfg;}
{"Sg.DIAM$";config/component/diameter.cfg;}

[InitialLoadSequence]
config/component/m3ua.cfg;
config/component/SCCP.cfg;
config/component/TCAP.cfg;
config/component/diameter.cfg;

3.2.2 Configuring the SCCP level parameters (SCCP.cfg)

Parameter Parameter Description
significance/restart

NI O/P Int. Network indicator.

PC O/P PC list.

Int. Maximum data size. Values range

MaxDataSizе O/P
is from 160 to 254;

TransportCA M/P String. AS transport address.

Example:

{
ComponentAddr = Sg.SS7.SCCP;
ComponentType = Sg.SS7.SCCP;
Params = {NI=3;PC=1;MaxDataSize=254;TransportCA=Sg.SIGTRAN.M3UA.AS.0;};
}

3.2.3 Configuring the TCAP-interaction parameters (TCAP.cfg)

Parameter Parameter Description
significance/
restart

Handlers O/P Int. The TCAP logics number. Default value =

100.
It is not reloaded dynamically. To be restarted in
case of changing the parameters values.

Page 15 of 100
 User Guide HLR/HSS

Parameter Parameter Description

significance/
restart

SCCP M/P String. SCCP component-address.

RestoreTransactions M/P Flag. It includes the TCAP-transactions

restoration.

Example:

{
ComponentAddr = Sg.SS7.TCAP;
ComponentType = Sg.SS7.TCAP;
Params = {Handlers=1000;SCCP=Sg.SS7.SCCP;RestoreTransactions=0;};
}

3.2.4 Configuration of Interaction over the Protocol (m2pa.cfg)

Client configuration. You only need to specify the address of server with which to
connect. If it is necessary, you can specify the local address from which the connection will be
made.

Parameter Significance of Description

the parameter
/ restart

ComponentAddr M/P String. Address.

ComponentType M/P String. Component type.

Params M Set of parameters.

connect_ip Number. Address of server with which SCTP association

will be established.

local_ip Number. Local address (IP header).

local_interfaces List of additional local IP addresses (SCTP header).

Server configuration. You only need to specify the address at which the server will be
listening.

Parameter Significance of Description

the parameter
/ restart

ComponentAddr M/P String. Address.

ComponentType M/P String. Component type.

Params M Set of parameters.

listen_ip Number. Address of server at which incoming connections

are expected (IP header).

Page 16 of 100
 User Guide HLR/HSS

L2
Linkset configuration. It should specify the network that the linkset, local and adjacent
signaling point codes belong to. Also it should specify the non-adjacent signaling points
available through this linkset. These data will be used for creating the static routing table.

Parameter Significance of Description

the parameter
/ restart

ComponentAddr M/P String. Component address.

ComponentType M/P String. Component type.

Params M Set of parameters.

NI Network indicator (0|1|2|3)

OPC Code of "our" signaling point (local).

AdjacentDPC Code of adjacent signaling point (remote).

NonAdjacentDPCs Signaling points available through this LinkSet

Link configuration. You only need to specify the address of the first-level component
that will be used.

Parameter Significance of Description

the parameter
/ restart

ComponentAddr M/P String. Address.

ComponentType M/P String. Component type.

Params M Set of parameters.

L1 String. Format:
"Sg.SIGTRAN.M2PA.L1.x.y",
where x is either Client or Server, and y is its number
(component address of level L1).

L3
Configuration of the third level of MTP. No parameters.

3.2.5 Configuring interaction parameters via the m3ua protocol (m3ua.cfg)

Configuring the ASP

Parameter Parameter Description

significance/
restart

ComponentAddr M/P String. The ASP address.

ComponentType M/P String. Component type.

Page 17 of 100
 User Guide HLR/HSS

Parameter Parameter Description

significance/
restart

Params ‒ Set of parameters (M)

srv_ip M/P IP-address. IP–address of the server which the

ASP is connected with (the SCTP-connection is
established). Filled in in quotes.

srv_port O/P Int. The port which "listens to" the server.
Default value = 2905.

local_port O/P Int. The port which is opened on the client while
establishing the SCTP connection. Default value
– 0 (a port will be assigned dynamically).

hrbt O/P Flag. The m3ua_heartbeat message sending

parameter. Possible values:
1 – heartbeat is used
0 – (default value) – heartbeat is not used

hrbt_timer O/P Int (in msec). The m3ua_heartbeat messages

sending period. It is used if the hrbt = 1. Default
value – 1000

instreams O/P Int. The number of incoming threads in the

SCTP-connection. Default value = 10.

outstreams O/P Int. The number of outgoing threads in the

SCTP-connection. Default value = 10

local_interfaces O/P List. List of interfaces (ip-addresses) being sent

by the client to the server in the SCTP_INIT.
Default value – "all available interfaces". Filled
in in quotes.

Example:
{
ComponentAddr = Sg.SIGTRAN.M3UA.ASP.0;
ComponentType = Sg.SIGTRAN.M3UA.ASP;
Params = { srv_ip="10.100.72.21";
srv_port="2907";
local_port="2905";
hrbt="1";
hrbt_timer="2000";
instreams="10";
outstreams="10";
rto_max="800";
rto_min="200";

Page 18 of 100
 User Guide HLR/HSS

remote_interfaces={
"10.100.72.21";
"10.100.72.151";
};
local_interfaces={
"10.100.88.193";
};
};
}
{
ComponentAddr = Sg.SIGTRAN.M3UA.AS.0;
ComponentType = Sg.SIGTRAN.M3UA.AS;
Params = {
OPC=638;
DistributeByASP=1;
TMT=2;

routing_table={
{
DPC="101";
ASP={
ASP="Sg.SIGTRAN.M3UA.ASP.0";
};
};
};

};
}

Configuring the AS

Parameter Parameter Description

significance/
restart

ComponentAddr M/P String. The AS address.

ComponentType M/P String. Component type

Params M Set of parameters

TMT M/P Int. Traffic Mode Type. Possible values:

1 – override.
2 – loadshare.
3 – broadcast.

Page 19 of 100
 User Guide HLR/HSS

Parameter Parameter Description

significance/
restart

OPC M/P Set of numbers. Originating point code. All the

outgoing M3UA_DATA (towards the server) will
have this OPC.

DistributeByASP Flag. It includes the TCAP-transactions

restoration

SIC O/P Set of numbers. Optional parameter. Service

information code.

routing_table={ O/P Table. Optional parameter. Routing table (AS

ASP). May contain the following parameters:

DPC M/P Int. Destination point code. The value is

specified in quotes. Specification examples:
DPC="1";
DPC="1-10"; corresponds to the range of [1-10]

RC O/P Int. Routing context.

ASP M/P List. List of the ASP via those the given DPC
(specified in the routing_table) are available.
The values are specified in quotes.

Example:

{
ComponentAddr = Sg.SIGTRAN.M3UA.AS.0;
ComponentType = Sg.SIGTRAN.M3UA.AS;
Params = {
OPC=639;
DistributeByASP=1;
TMT=2;

routing_table={
{
DPC="101";
ASP={
ASP="Sg.SIGTRAN.M3UA.ASP.0";
ASP="Sg.SIGTRAN.M3UA.ASP.1";
};
};
};

};
}

Page 20 of 100
 User Guide HLR/HSS

3.2.6 Configuring the Diameter-interaction parameters (diameter.cfg)

Diameter Interface configuration is realized with the requirements COM. Configuration
of the components is defined in the file /config/component/diameter.cfg.

Parameter Description

destination-hostN Diameter-Identity for Diameter peers

ComponentAddr_for_hostN Component addresses of corresponding PCSM.

ip_addressN IP address of peer.

portN Port.

If there is no need to initiate the connection, you can specify IP = «»; Port = 0;

Example of configuration of interface with two connections:

{
ComponentAddr = Sg.DIAM;
ComponentType = Sg.DIAM;
Params = {
PeerTable={
{
Host-Identity="192.168.1.23";
PCSM="Sg.DIAM.PCSM.0";
};
{
Host-Identity="192.168.100.204";
PCSM="Sg.DIAM.PCSM.1";
};
};
};
}
{
ComponentAddr = Sg.DIAM.PCSM.0;
ComponentType = Sg.DIAM.PCSM;
Params = {
PeerIP="192.168.1.23";
PeerPort="37890";
};
}
{
ComponentAddr = Sg.DIAM.PCSM.1;
ComponentType = Sg.DIAM.PCSM;
Params = {
PeerIP="192.168.1.23";

Page 21 of 100
 User Guide HLR/HSS

PeerPort="37891";
};
}

3.3 Configuration of general parameters of the

system (protei.cfg)
Configuration of the restrictions can be reloaded by means of the following dynamic
command ./reload protei.cfg

Parameter Significance of the Description

parameter /
restart

Section [General].

Watchdog O/P Flag. Configuration of the Watchdog timer that

ensures continuous operation of the SW. Possible
values: 1 – Watchdog enabled; 0 – Watchdog
disabled. Default value is 0.
When the Watchdog is enabled, the system
checks that data is written into a special port with
a specific frequency. If the operation is not
performed by the end of the corresponding time
period, SW failure is inferred, and the system is
restarted after the Watchdog timer expires.

TCM_ID М/P Int. Global identifier of the application. This

identifier must be unique within the group of
interworking applications of the service platform.
Possible values: from 0 to 65535.

Example:

[General]

# Watchdog :
# 1 - Watchdog ON
# 0 - Watchdog OFF
Watchdog =0

# TCM ID
TCM_ID = 38

Page 22 of 100
 User Guide HLR/HSS

3.4 Main Parameters of the HLR/HSS

The HLR/HSS parameters are configured in file protei/hlr.cfg.

Parameter Description Example of configuration

Section [HPLMN]

If MAP_VLR in UL message matches the {1; "7925.(0,7)";}; — the

mask then the roaming is allowed. If it mask is enabled
doesn't, the system checks the database to {0; "7921.(0,7)";}; — the
see if roaming is allowed for this IMSI. mask is disabled
If MAP_SGSN_Number in UL_GPRS message
matches the mask then the roaming is
allowed. If it doesn't, the system checks the
database to see if roaming is allowed for this
IMSI.

Section [SRI_GT_GMSC]

List of GT GMSC's from which SRI is allowed {1; "7925.(0,7)";}; — the

mask is enabled
{0; "7921.(0,7)";}; — the
mask is disabled

Section [ATI_GT]

List of GT's from which ATI is allowed {1; "7925.(0,7)";}; — the

mask is enabled
{0; "7921.(0,7)";}; — the
mask is disabled

Section [USSD]

Mask for USSD code; GT USSDC; allows {"*111\#"; 79584499009;

choosing the parameter that will be added to msisdn};
destinationReference — imsi or msisdn. {"*222\#"; 79584499009;
imsi}

Section [International]

Rules for changing {1; Mask="8926.(0,7)"; Delete

MAP_RegisterSS_Arg::e_forwardedToNumber = 1; Insert = "7";}; — the rule
parameter, Delete — delete first N symbols is enabled
of the number, Insert — add a new prefix. {0; Mask="8926.(0,7)"; Delete
= 1; Insert = "7";}; — the rule
is disabled

3.4.1 Configuration of Loading of Subscribers

Subscribers can be loaded by placing a text file with the list of subscribers to the
directory specified in hlr.cfg or the default directory
/usr/protei/protei_hlr/LoadSubscriber/Subscriber/reload. HLR/HSS parses the data in the file
and sends them to the billing server for loading to the database. The result of writing the data
to the database is written to common_cdr as LS type.

Page 23 of 100
 User Guide HLR/HSS

Parameter Description

[Profile]

O_CSI "int,int"

T_CSI "int,int"

SMS_CSI "int,int"

PDP_DATA "int,int"

TeleServices "int,int"

ActiveSS "int,int"

NotActiveSS "int,int"

DefaultForwardingNumber <string>

DefaultForwardingStatus <int(def=0)>

DM_EPS_DATA "int,int"

DM_DEF_ContextID int

DM_UE_MaxUL int

DM_UE_MaxDL int

DM_RatType int

DM_RatFreqPriorID int

Section [Subscribers]. Format of a record { IMSI; Ki; MSISDN; Algoritm}

IMSI = <string>

Ki <string(len=32)

MSISDN <string>

Algoritm <int(def=4)

3.4.2 Loading of CAMEL Profile

Camel profile is loaded by separately loading profiles O_CSI, T_CSI, SMS_CSI,
GPRS_CSI. Files with description of these profiles are placed to the directory specified in hlr.cfg
in parameter LoadDataDir+/Camel/reload or to the default directory
/usr/protei/protei_hlr/LoadSubscriber/Camel/reload. HLR parses the data in the file and sends
them to the billing server for loading to the database. If data in the file are invalid (invalid
format or incorrect data), such records are written to a file in /error folder. If errors occur
while inserting subscribers into the database, the list of such profiles with corresponding error
will also be written to a file in /error folder.
Required elements of the file structure:
[O_CSI_12] — specifies the profile type: O_CSI, T_CSI, SMS_CSI, GPRS_CSI followed
by an underscore and the profile number.
[TDP] — separating sections, must always be present.

Page 24 of 100
 User Guide HLR/HSS

Format of file that can be loaded:

[O_CSI_12]
CamelCapabilityHandling = 2
NotificationToCSE = 0
csiActive = 0
BscmCamelTDPData:
[TDP]
TDP = 2
gsmSCF = 72221111111
ServiceKey = 32
defaultHandling = 22
DP_Criteria:
DestinationNumberCriteria:
MatchType = 1
DestinationNumber = 88879210001111, 88879210002222,88879210003333
DestinationNumberLength = 4, 5, 6, 7, 8
BasicServiceCriteria:
Ext_BasicServiceCode:
e_ext_BearerService = 1,2
e_ext_Teleservice = 3,8,9,
CallTypeCriteria = 1
[TDP]
TDP = 4
gsmSCF = 70003333333
ServiceKey = 33
defaultHandling = 43;
DP_Criteria:
CauseValueCriteria:
CauseValue = 111,222,333

[T_CSI_1]
CamelCapabilityHandling = 1
NotificationToCSE = 1
csiActive = 1
BscmCamelTDPData:
[TDP]
TDP = 12
gsmSCF = 70001111111
ServiceKey = 31
defaultHandling = 41
DP_Criteria: //optional
BasicServiceCriteria:

Page 25 of 100
 User Guide HLR/HSS

Ext_BasicServiceCode:
e_ext_BearerService = 41,51,61
e_ext_Teleservice = 21,31,17
CauseValueCriteria:
CauseValue = 85,86,1
[TDP]
TDP = 13
gsmSCF = 70003333333
ServiceKey = 33
defaultHandling = 43;
DP_Criteria:
BasicServiceCriteria:
Ext_BasicServiceCode:
e_ext_BearerService = 42,52,62
e_ext_Teleservice = 22,32,27
[TDP]
TDP = 14
gsmSCF = 70003333333
ServiceKey = 33
defaultHandling = 43;
DP_Criteria:
CauseValueCriteria:
CauseValue = 85,86,1

3.4.3 Loading of PDP

PDP can be loaded by placing a text file with the list of profiles to the directory specified
by LoadDataDir+/PDP/reload parameter in hlr.cfg or the default directory
/usr/protei/protei_hlr/LoadSubscriber/PDP/reload.
HLR/HSS parses the data in the file and sends them to the billing server for loading to
the database.

Page 26 of 100
 User Guide HLR/HSS

File format:

Parameter Description

[PDP]

ContextID <int>

Type <string>

Address <string>

QoS_Subscribed <string>

lVPLMN_AddressAllowed <int>

APN <string>

ExtQoS_Subscribed <string>

ChargingCharacteristics <string>

3.4.4 Loading of White Lists

White Lists (VLN/SGSN prefixes) can be loaded by placing a text file with the list of
prefixes to the directory specified by LoadWL_Dir +/reload parameter in hlr.cfg or the default
directory /usr/protei/protei_hlr/LoadWL/reload.
HLR/HSS parses the data in the file and sends them to the billing server for loading to
the database.

Parameter Description

[Add] - creating

Name <string> - name of list. Mandatory when creating a list.

Mask {
- list of prefixes in format prefix, country, network;
<string>,<string>,<string>;
<string>,<string>,<string>;
…
<string>,<string>,<string>;
};

[Add] - adding

Name <string> - name of list. Optional parameter which replace parameter ID.

Page 27 of 100
 User Guide HLR/HSS

Parameter Description

ID <int> - identifier of list. Optional parameter to replacing the parameter

Name.
Mask = {
- list of prefixes in format prefix, country, network;
<string>,<string>,<string>;
<string>,<string>,<string>;
…
<string>,<string>,<string>;
};

[Del] – deleting of prefixes

Name <string> - name of list. Optional parameter which replace parameter ID

ID <int> - identifier of list. Optional parameter to replacing the parameter

Name.

[Del] – deleting the list

Name <string> - name of list. Optional parameter which replace parameter ID

ID <int> - identifier of list. Optional parameter to replacing the parameter

Name.

3.4.4.1 Format of file-report

By default, the report is in the /usr/protei/protei_hlr/LoadWL/error.
Command;Name;ID;CountMask=CountMask;Error=success; - count of successfully
loaded/deleted prefixes;

Add;MN;54;CountMask=4354;Error=success;

Command;Name;ID;Mask,Country,Network;Error=error; - Unprocessed prefix

Add;MN;54;447970,Uk,Vodafone;Error="ORA-00001: unique constraint

(HLR.IX_WL_MASK) violated"

3.4.5 Configuration of Local Host of Diameter interface (diameter.cfg)

Configuration of local DIAMETER node includes specifying the following:
• local address of the node;
• local peer capabilities that will be used when establishing a connection;
• timer values.
Section [LocalAddress]. All parameters in the section are optional.

Parameter Significance of Description

the parameter
/ restart

LocalHost O <ip address>. Local IP address. Default value is

0.0.0.0.

LocalPort O Number. Local port. Default value is 3836.

Page 28 of 100
 User Guide HLR/HSS

Section [LocalPeerCapabilities]. All parameters in the section are required.

Parameter Significance of Description

the parameter
/ restart

Origin-Host M String. Host identifier.

Origin-Realm M String. Host realm.

Origin-State-Id M If the value of this parameter is negative or undefined,

Origin-State-Id for the system will be generated
independently.
If the value of this parameter is non-negative, it will be
used as Origin-State-Id.

Vendor-ID M Number. Manufacturer identifier.

Product-Name M String. Application name.

Firmware-Revision M Application version.

Host-IP-Address M A set of strings. Actual IP address. Several addresses

can be specified using ';' as a separator.

Auth-Application- M A set of numbers. The list of identifiers of supported

Id applications (only DCCA is supported — 4).

Inband-Security- M A set of numbers. The list of identifiers of supported

Id safety mechanisms (only NO_SECURITY is supported —
0).
Section [Timers]. All parameters in the section are optional.

Parameter Significance of Description

the parameter
/ restart

Appl_Timeout O Number. Connection timeout (msec). Counted from the

moment a TCP connection establishment request is sent
until the moment Capabilities-Exchange-Answer is
received. Default value is 40000.

Watchdog_Timeout O Number. Timeout for sending watchdog-packets

(msec). In this case the timeout is the time elapsed
from the moment the last message was sent (it does
not have to be DeviceWatchdogRequest). Default value
is 10000.

Reconnect_Timeout O Number. Timeout for re-establishing the connection

(msec). The time from the moment the connection is
terminated until the next attempt to re-establish the
connection. Default value is 30000.

Page 29 of 100
 User Guide HLR/HSS

Example:

[LocalPeerCapabilities]
Origin-Host="hss.protei.ru";
Origin-Realm="protei.ru";
Vendor-ID=10415;
Product-Name="Protei_HLR";
Firmware-Revision=0;
Host-IP-Address={"192.168.126.76";};
Auth-Application-Id={4;16777251;4294967295;};
Vendor-Specific-Application-Id = {
{Vendor-Id=10415; Auth-Application-Id=16777251;}
}
Inband-Security-Id={0;};

[Timers]
#Appl_Timeout = 40000
#Timer starting past tcp/ip initiation connection (inzializazija soketa),
ozidanie podtverzdenija
Appl_Timeout = 20000
#Vremja, zerez kotoroe powletsja soobwenie watchdog v slu4ae otsutstvija info
soobwenij (CCR/CCA)
Watchdog_Timeout = 60000
#Watchdog_Timeout = 3000000000
#Vremja, zerez kotoroe budet popitka ustanovlenija soedinenija posle 3-x
neuspewnix posilok watchdog soobwenij
Reconnect_Timeout = 30000

[LocalAddress]
LocalHost="192.168.126.76";
LocalPort="3868";
Transport="sctp";

3.5 Configuration of general parameters of the BS

(db.cfg)
This file defines the general parameters of processing requests and DB-initialization
parameters.

Parameter Description

Section [General]. All parameters are optional.

AllocateHandlers Integer. Number of allocated logics SL (request handlers). Default value =

10.

UseMultithreading Flag. Enable operation of multithread-mode or not. Possible value: 1 –

mode operation enable, 0 – mode operation disable. Default value = 0.

Page 30 of 100
 User Guide HLR/HSS

Parameter Description

MaxQueryQSize Integer. The maximum size of the query queue. Default value = 20.

TestMode Integer. 0 - test mode (without connection to the database).

Section [Oracle]. All parameters are optional.

Integer (in ms). Time interval after which the client network logic tries to
ReconnectTimeout
reconnect with database. Default value = 5000.

List of errors processing the request, in which the connection to be

ReconnectErrors closed. Format: {error1; error2;...},
where «errorN» - error code (number).

The section [SQL] determines parameters of main direction for connect to DB.

UserName String. Mandatory parameter. Username for connection to database.

Password String. Mandatory parameter. Password for connection to database.

Database String. Mandatory parameter. String for initialization of access to

database.
Format: «(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=
(PROTOCOL=<enum_string>)(HOST=<ip_addr>)(PORT=<int>)))(CONN
ECT_DATA=(SID=<enum_string>)))»,
Where, «PROTOCOL» - string. Name of protocol
«HOST» - IP-adress of DB server;
«PORT» - int. port number;
«SID» - string. Service identifier.
Example: «(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=
(PROTOCOL=TCP)(HOST=192.168.200.240)(PORT=1521)))(CONNECT_D
ATA=(SID=orcl)))»

PackageName String. Optional parameter. The name of package for operations with
functions (PG_HLR).

[ReserveDB]. Parameters of reserve direction for connect to DB:

UserName String. Mandatory parameter. Username for connection to reserve DB.

Password String. Mandatory parameter. Password for connection to reserve DB.

Database String. Mandatory parameter. String for initialization of access to

database.
Format: «(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=
(PROTOCOL=<enum_string>)(HOST=<ip_addr>)(PORT=<int>)))(CONN
ECT_DATA=(SID=<enum_string>)))»,
Where, «PROTOCOL» - string. Name of protocol
«HOST» - IP-adress of DB server;
«PORT» - int. port number;
«SID» - string. Service identifier.
Example: «(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=
(PROTOCOL=TCP)(HOST=192.168.200.240)(PORT=1521)))(CONNECT_D
ATA=(SID=orcl)))»

Page 31 of 100
 User Guide HLR/HSS

Parameter Description

CheckTimeout Integer (in seconds). Interval to check connection validity. Default

value=0 (control is not performed).

MaxErrorCount Int. Optional parameter. Maximum count of errors for connection to

reserve DB. Default value=1.

[TestAUC] Parameters for testing the encryption algorithm

RAND «622D51911F0FD2565274A5C812BA6FAB»

AddTrace Default value=1.

[Millenage] Parameters of encryption algorithm

C1-C5 String of Sets C (C1-C5).

C1 = 1 (default value = 1)
C2 = 3 (default value = 3)
C3 = 5 (default value = 5)
C4 = 7 (default value = 7)
C5 = 9 (default value = 9)

OP Set in an encrypted form, the default 22 30 14 c5 80 66 94 c0 07 ca 1e

ee f5 7f 00 4f

TransportKey Set in an encrypted form. Default is not used.

lUseQuintuplets Flag. Default value=1 (enabled)

R1-R5 String of Sets R (R1-R5).

r1 = 64 (constant, not configurable);
r2 = 0 (constant, no configuration);
r3 = 32 (the value of a constant configuration);
r4 = 64 (the value of a constant configuration);
r5 = 96 (the value of a constant configuration).

3.6 Configuration of parameters of the interface with

the mobile network (gsm.cfg)
Each section is reloaded by means of a separate command.

Parameter Significance Description

of the
parameter
/ restart

Section [SMSC] contains general parameters. It can be reloaded by means of command

./reload SMS_Routing.

Handlers O/P Number. Maximum number of logics. Default

value is 2500.

Page 32 of 100
 User Guide HLR/HSS

Parameter Significance Description

of the
parameter
/ restart

Address M/P String. Contains the digits of the GT address that

is used for substitutions in transactions.

AddressTON O/P Number. Contains the type of number for

Address. Default value is 0.

AddressRI O/P Number. Contains the RoutingIndicator GT for

substituting LocalAddress in TCAP_BEGIN
message. Default value is -1 (do not substitute
the RI).

UseChangeGTinTCAP_BEGIN O/P Flag. Specifies whether the GT substitution should

be used in RecvSM logic, or not. Default value is
0 (do not use).
Example:

[SMSC]
Handlers = 1000
#Global Title of SMSC
Address = 79270009791
#podmena GT
UseChangeGTinTCAP_BEGIN = 1

[USSD]
ErrorMessage = "Please try later. Thank you!"
WaitApplicationTimeout = 60
WaitUserTimeout = 600
#SendMSISDN = 0
USSD_UseBRT=1;

USSD_Replies = {
{"*001\#";"call *100\#\\Call *100\#"};
{"01";"call 112\Call 112"};
{"02";"call 112\Call 112"};
{"03";"call 112\Call 112"};
{"04";"call 112\Call 112"};
}

StatisticsEnabled = 1
StatisticsPeriodLength = 60
StatisticsFileNameFormat = "logs/ussd_%Y%m%d.log"

#DebugNumbers = {79272040134}

Page 33 of 100
 User Guide HLR/HSS

USSD_CDR_Enabled = 1
CDR_Enabled = 1

[SMPP_StatusErrors]
SMPP_MAP_ErrorsConverter = {
{0;32}
{1;11}
{2;12}
}

[SMPP_InternalErrors]
SMPP_MAP_ErrorsConverter = {
{0;40}
{1;41}
{2;42}
{3;43}
{4;44}
}

[SMS]
TruncateMSISDN = 0;
SMS_UseBRT = 1;
#SMS_UseBRT = 0;
#SMS_UseMapV1 = 1;
TimeZone = 3;

[BRT_to_MAP_Errors]
ErrorsConverter = {
{0;32}
{21;34}
{126;13}
}

[SMPP_to_BRT_Errors]
ErrorsConverter = {
{0;4}
{8;1}
}

[SMPP_Status_to_BRT_Errors]
ErrorsConverter = {

Page 34 of 100
 User Guide HLR/HSS

{0;1}
{254;4}
{255;255}

3.7 Configuration of OMI-connection parameters

(om_interface.cfg)
Parameter Significance Description
of the
parameter
/ restart

Section [General].

ServerIP O/R String. IP address of dynamic OM-server.

ServerPort O/R Int. Port number of dynamic OM-server. Default

value is 0.

Timers Set of parameters. Describes time intervals.

SessionResponseTimeOut O/R Int. Optional parameter. Maximum lifetime of a

session. In milliseconds. Default value is 0.

TransactionResponseTimeOut O/R Int. Optional parameter. Maximum lifetime of a

transaction. In milliseconds. Default value is 0.

SegmentResponseTimeOut O/R Int. Optional parameter. Waiting time for

response to a sent request. In milliseconds.
Default value is 0.

MaxSegmentErrorCount M/R Int. Required parameter. Number of errors (no

response to a sent request within the specified
time interval “SegmentResponseTimeOut”);
upon reaching this number the network logic
closes the current session.

LoginReqTimeOut M/R Int. Required parameter. Time interval after

establishing the connection. If no “LoginReq”
message is received within the specified time
interval “LoginReqTimeOut”, the network logic
breaks the connection. In milliseconds.

ReconnectTimeOut M/R Int. Required parameter. Time interval after

which the client network logic tries to reconnect.
In milliseconds.

KeepAliveTimeOut M/R Int. Required parameter. Time interval after

which, if network activity is present, a
“KeepAlive” message is sent. In milliseconds.

KeepAliveResponseTimeOut M/R Int. Required parameter. Waiting time for a

“KeepAliveAck” signal in response to the
“KeepAlive” signal.

Page 35 of 100
 User Guide HLR/HSS

Parameter Significance Description

of the
parameter
/ restart

Section [Server]. Contains parameters of automatic connection server.

Timers Set of parameters. Same as the "Timers" set in section

[General].

Sockets A set of automatic connection server parameters. Includes the

following parameters: "Address", "Port".

Address O/R IP address allowed for the client (0.0.0.0 —

any).

Port O/R Int. Number of the port.

ConnectionsLogics List of network logics. Network logic description comprises the

following parameters: "Priority", "MaxTransactionCount",
"Login", "Password".

CL.<number> O/R Number of the network logic.

Priority M/R Int. Priority of the network logic during allocation

of a new transaction.

MaxTransactionCount M/R Int. Required parameter. Maximum number of

transactions that can be simultaneously
processed by this network logic.

Login O/R String. Logic login.

Password O/R String. Logic password.

Directions List of autoconnection directions. Direction description

comprises the following parameters: "CL_Monitoring",
"ChangeOverTimeOut", "Primary".

Dir.< > O/R String. Name of direction.

CL_Monitoring O/R Bool. Optional parameter. Network logics

monitoring. Possible values:
1 — network logic sends a primitive
OM_CONNECTION_RESUME_IND when the
connection is established and a primitive
OM_CONNECTION_PAUSE_IND when the
connection is broken,
0 — network logic does not send these
primitives. Default value is 0.

Page 36 of 100
 User Guide HLR/HSS

Parameter Significance Description

of the
parameter
/ restart

ChangeOverTimeOut O/R Int. Optional parameter. Time interval for

awaiting restoration of primary connections after
their disconnection; upon expiry of this interval
all incoming requests will be redirected to
secondary connections. Default value is 0.

Primary Set of parameters of the primary connection. Includes the

following parameters: "MaxTraffic", "Connections".

MaxTraffic M/R Int. Maximum number of transactions that can

be simultaneously processed in this direction.

Connections M/R List of network logics.

Format of the parameter:
{“Number1”;...”NumberN”;}, where “NumberX”
is the network logic number.

Secondary O/R Optional list of parameters of the reserve

connection. Same as the "Primary" set.

Example:
[General]
ServerIP = 0.0.0.0;
ServerPort = 21000;
Timers =
{
SessionResponseTimeOut = 600000;
TransactionResponseTimeOut = 30000;
SegmentResponseTimeOut = 10000;
MaxSegmentErrorCount = 3;
LoginReqTimeOut = 10000;
ReconnectTimeOut = 10000;
KeepAliveTimeOut = 30000;
KeepAliveResponseTimeOut = 10000;
}
[Server]
Timers =
{
SessionResponseTimeOut = 600000;
TransactionResponseTimeOut = 30000;
SegmentResponseTimeOut = 10000;
MaxSegmentErrorCount = 3;
LoginReqTimeOut = 10000;
ReconnectTimeOut = 10000;
KeepAliveTimeOut = 30000;

Page 37 of 100
 User Guide HLR/HSS

KeepAliveResponseTimeOut = 10000;
}
Sockets =
{
{
Address = 10.100.98.31;
Port = 20010;
}
}
ConnectionLogics =
{
CL.1 =
{
Priority = 1;
MaxTransactionCount = 1000000;
Login = "cpe_cb_34";
Password = "cpe_cb_34";
}
CL.2 =
{
Priority = 1;
MaxTransactionCount = 1000000;
Login = "cpe_cb_37";
Password = "cpe_cb_37";
}
}
Directions =
{
Dir.565 =
{
CL_Monitoring = 1;
ChangeOverTimeOut = 10000;
Primary =
{
MaxTraffic = 10000;
Connections = {2};
}
Secondary =
{
MaxTraffic = 10000;
Connections = {1};
}
}
#[Client]

Page 38 of 100
 User Guide HLR/HSS

3.8 Configuration of the license file (license.cfg)

Configuration of the restrictions can be reloaded by means of the following dynamic
command: ./reload license.cfg

Parameter Significance Description

of the
parameter /
restart

Section [License]

HSS O/R Flag. This parameter is used to enable the HSS

functionality.
1 – enabled; 0 – off.
Default value = 0.

signature O/R <need to generate> to enable the HSS functionality.

TrafficNominal O/R Number (transactions per second). Load value that

the application should be able to handle in normal
operating mode
Default value is 40, interval of values is {1;1000}.

TrafficCriticalThreshold O/R Number (transactions per second). The number of

transactions above TrafficNominal that must be
processed during specified TrafficThresholdInterval
after the limit is exceeded (default =
TrafficNominal*1,5,
{TrafficNominal;TrafficNominal*2})

TrafficThreshold O/R Number (transactions per second).

The number of transactions that must be processed
after TrafficThresholdInterval expires (default =
TrafficNominal*1,2,
{TrafficNominal;TrafficCriticalThreshold})

TrafficTresholdInterval O/R Number (in seconds). Interval during which all calls
should be processed until TrafficCriticalThreshold.
Default value is 600 sec, range of values is {1;3600}.

Example:

[License]
TrafficNominal = 2000;
TrafficThresholdInterval = 1;

signature = 0AC8909622FD21743574A3AE8CFF4743;

Page 39 of 100
 User Guide HLR/HSS

3.9 Routing parameters configuration

(sccp_routing.cfg)
The routing configuration can be reloaded by means of the following dynamic
command: ./reload sccp_routing.cfg

Parameter Significance of the Description

parameter /
restart

Section [DefaultRouting].

DPC M/R Int. Code of the primary destination point.

RDPC O/R Int. Code of the secondary destination point.

NI M/R Int. Network indicator.

Section [Routing].

GT_AddrDigit M/R Regular expression. Mask of the GT number.

DPC M/R Int. Code of the destination point.

RDPC O/R Int. Code of the secondary destination point;

applicable only for SS7.

NI M/R Int. Network indicator.

RNI O/R Int. Reserve Network indicator.

Example:

[DefaultRouting]
DPC={182;183;}
RDPC=183;
NI=3;
RNI=3;
[Routing]
{
GT_AddrDigit=".(0,22)";
DPC={182;183;};
NI=3
}

Page 40 of 100
 User Guide HLR/HSS

3.10 Configuration of Parameters of Statistics (statistics.cfg)

Configuration of statistics can be reloaded dynamically by means of command ./reload
statistics.cfg

Parameter Significance of Description

the parameter
/ restart

Section [Statistics].

LogName O/R String. Name of directory used for statistical records.

Default value is "stat".

Intervals Set of parameters. Intervals.

Check O/R Number (in milliseconds). Interval for the speed check.
Default value is 30000.

Out O/R Number (in seconds). Interval for generating statistical

records. Default value is 3600.

Online O/R Number (in seconds). Interval for sending statistics to

an external application. Default value is 10.

Example:

[Statistics]
LogName = "stat";
Intervals = {
Check = 10000;
Out = 60;
Online = 86400; #24 hour
}

3.11 Tracing System (trace.cfg)

The configuration of logs can be reloaded by means of the following dynamic
command: ./reload trace.cfg

Parameter Significance of Description

the parameter/
restart

Section [Trace].

Set of parameters. General settings of the logging

Common system. Includes the following parameters:
tracing, dir, no signal.

Flag. Operational state of the logging system.

tracing O/R Possible values: 1 – the system is active; 0 – the
system is inactive.

Page 41 of 100
 User Guide HLR/HSS

Parameter Significance of Description

the parameter/
restart

String. Path to the folder where the logs should be

dir O/R stored. System creates any required folders that
do not exist. Default value is "./logs".

List of numbers separated by commas or a string

with value "all". Signals of OS Linux that are not
intercepted by the logging system. The system
no signal O/R
intercepts all other signals and logs them to the
main logs. Default value is "intercept all". Value
"all" means "do not intercept any signals at all".

Log parameters.

Set of parameters. Configuration of logs.

Configuration comprises parameters in the
following format:
logs
log_name = { list_of_parameters };
Description of each log is optional.

String. Name of the log. Letters, digits and ‘_’

symbol can be used. This name identifies the log
log_name within the system.
Contains the following set of parameters: file,
type, mask, separator, level, tee, period.

String. Path to the log file. System creates any

required folders that do not exist. If "level"=0, file
name can be empty; in this case logging is done
according to parameter "tee". If this parameter is
not specified, records are not written to disk.
If the path starts with "./" then the resulting folder
is calculated from the current folder; if the path
file O/R
starts with "/", the resulting folder is calculated
from the root; otherwise the resulting folder is
calculated from the default folder. The path may
contain ".." and a time format mask.
Example: cdr/%Y/%m/%d/%H_%M_%S.log will
be transformed into
cdr/2004/07/07/13_54_31.log.

Mask of output format of automatic fields in the

log. Example of a mask: date & time & tick & state
& pid & tid & level & file
Modifiers:
date – date specified as DD/MM/YY.
mask O/R
time – time specified as HH:MM:SS.
tick – milliseconds. If "time" is specified,
milliseconds are specified as ".МММ", otherwise as
"ММММММ".
state – internal state of the system; it can be
represented as a number or a string, depending on
Page 42 of 100
 User Guide HLR/HSS

Parameter Significance of Description

the parameter/
restart
the needs of the developer.
pid: process identifier. Number, 6 digits.
tid: thread identifier. Number, 6 digits.
level: level of the log specified for the record.
Number.
file: file and string in file with source code from
where the output is done.

Int. Log level. Depends on the log. Messages with

level O/R
level greater than "level" are ignored.

Type of the log and additional settings. Three pairs

of mutually exclusive values: log or cdr, truncate
or append, name_now or name_period.
Detailed description of the modifiers:
name_now – current time for the file name;
name_period – time for the file name, the
beginning of the period;
truncate – reset file upon opening;
append – do not reset file upon opening (add new
type O/R info to the end of file);
log – includes "truncate" and "name_now"; upon
failure the information about the signal is written;
cdr – includes "append" and "name_now"; upon
failure the information about the signal is not
written.
The default parameter can be redefined in another
modifier.
Examples: type = cdr & name_period – cdr with
file name according to the beginning of the period;
type = append – log without resetting the files.

String. Separator of automatic fields. Default value

is taken from the "common" parameter.
separator O/R
Note: all output of the time (date, time, tick) is
treated as one single field.

Period of update of the log file. Format of the

parameter: "length of period" "+" "shift". The
value of the shift cannot exceed the length of the
period; invalid values are ignored.
Format of the elements:
period O/R
count type, where "count" is the number of simple
periods (default value is 1),
type – type of period (year, month, week, day,
hour, min, sec).

Page 43 of 100
 User Guide HLR/HSS

Parameter Significance of Description

the parameter/
restart
Examples: day+3hour – the file will be updated
every day at 3 a.m.

Configuration of buffer logging:

cluster_size – the size of a cluster (default value is
128 Kb);
clusters_in_buffer – the length of the buffer in
buffering O/R clusters (default value is 0 – do not buffer the
output);
overflow_action – action upon overflow of the
buffer (default value is "write to disk", not erase),
(erase|dump; default=dump).

String. Duplication of output thread. Possible

values: stdout, stderr, trace, info, warning or any
other log name. If the name has "-" prefix, e.g. "-
tee O/R trace", then the name of the original log is not
written during the duplication.
Example: tee=stdout & stderr & trace & info &
warning or any your log.

Maximum (limit) number of records. As soon as

we write the limit amount of strings, the log is
automatically reopened. The actual number of
limit O/R records in the file at this particular time is not
calculated. If the name of the file depends on the
time, a new file is opened; otherwise the file is
reset.

Example:

[Trace]
common={tracing=1; dir="."; no_signal=all;}

logs=
{

stat = {
file="logs/stat.log";
# mask=file & date & time & tick;
level=10;
separator=";";
};
trafic_stat = {
file="logs/stat_trafic.log";
mask= date & time;
level=10;

Page 44 of 100
 User Guide HLR/HSS

separator=";";
};
abonent_stat = {
file="logs/stat_abonent.log";
mask= date & time;
level=10;
separator=";";
};
trace = {
file="logs/trace%Y%m%d-%H%M.log";
mask=file & date & time & tick & pid;
level=10;
# period=hour;
separator=";";
};
OM_trace =
{
file = "logs/om_trace.log";
period = hour;
mask = date & time & tick & file;
separator = ";";
level = 10;
}
OM_warning =
{
file = "logs/om_warning.log";
period = hour;
mask = date & time & tick & file;
separator = ";";
level = 1;
}
db_om_trace =
{
file = "logs/db_om_trace.log";
period = hour;
mask = date & time & tick & file;
separator = ";";
level = 10;
}
alarm =
{
file = "logs/alarm.log";
period = hour;

Page 45 of 100
 User Guide HLR/HSS

mask = date & time & tick;

separator = ";";
level = 6;
}
alarm_trace =
{
file = "logs/alarm_trace.log";
period = hour;
mask = date & time & tick;
separator = ";";
level = 0;
}
alarm_cdr =
{
file = "logs/alarm-cdr.log";
period = hour;
mask = date & time & tick;
separator = ";";
level = 6;
}

config = {
file="logs/config.log";
mask=file & time & tick;
level=10;
period=hour;
tee=trace;
};

hlr_config = {
file="logs/hlr_config.log";
mask=file & time & tick;
level=1;
period=hour;
};

alarm = {
file="logs/alarm.log";
type=cdr;
mask=date & time & tick;
level=0;
};
warning = {

Page 46 of 100
 User Guide HLR/HSS

file="logs/warning.log";
mask=date & time & tick;
level=1;
tee=trace;
};

Sg_trace = {
file="logs/SS7/sg_trace.log";
mask=date & time & tick & pid & file;
level=10;
};

Sg_info =
{
file="logs/SS7/sg_info.log";
mask=date & time & tick & pid & file;
level=10;
};

Sg_warning =
{
file="logs/SS7/sg_warning.log";
mask=date & time & tick & pid & file;
level=10;
};
SCCP_trace = {
file="logs/sccp_trace.log";
mask=date & time & tick & pid & file;
level=10;
};
SCCP_warning = {
file="logs/sccp_warning.log";
mask=date & time & tick & pid & file;
level=10;
};
sctp_trace = {
file="logs/sctp_trace.log";
mask=date & time & tick & pid & file;
level=10;
};
TCAP_trace = {
file="logs/tcap_trace.log";
mask=date & time & tick & pid & file;

Page 47 of 100
 User Guide HLR/HSS

level=10;
};
M3UA_trace =
{
file="logs/M3UA/m3ua_trace.log";
mask=date & time & tick & pid & file;
level=10;
};

M3UA_info =
{
file="logs/M3UA/m3ua_info.log";
mask=date & time & tick & pid & file;
level=10;
};

M3UA_warning =
{
file="logs/M3UA/m3ua_warning.log";
mask=date & time & tick & pid & file;
level=10;
};

si = {
file="logs/si_trace.log";
mask=date & time & tick & pid & file;
level=10;
tee=trace | fsm;
};
si_info = {
file="logs/si_info.log";
mask=date & time & tick & pid & file;
level=10;
tee=trace;
};
si_warning = {
file="logs/si_warning.log";
mask=date & time & tick & pid & file;
level=10;
tee=trace;
};
M3UA_trace =
{

Page 48 of 100
 User Guide HLR/HSS

file="logs/m3ua_trace.log";
mask=date & time & tick & pid & file;
level=10;
};

M3UA_info =
{
file="logs/m3ua_info.log";
mask=date & time & tick & pid & file;
level=10;
};

M3UA_warning =
{
file="logs/m3ua_warning.log";
mask=date & time & tick & pid & file;
level=1;
};
common_cdr = {
file = "logs/cdr_common.log";
mask = date&time;
level = 10;
separator=";";
};

3.12 Alarm Indication Subsystem Parameters

(ap.cfg)
Parameter Significance of Description
the parameter /
restart

Section [General].

Root O/R String. Root of the tree.

Default value is PROTEI(1,3,6,1,4,1,20873).
Overload key: "ap_agent.di" or "ap_manager.di".

ApplicationAddress M/R String. Application address. Must equal = IDC.

ap_agent.di

MaxConnectionCount O/R Int. Maximum number of simultaneous connections

to AP_Agent.
Default value is 10.
Overload key: "ap_agent.di" or "ap_api_client.di".

Page 49 of 100
 User Guide HLR/HSS

Parameter Significance of Description

the parameter /
restart

ManagerThread O/R Flag. Startup integrated manager in a separate

thread. Possible values: 0 – work in the main
stream; 1 – work in a separate stream.
Default value is -1 (do not start the manager).
Note: if this parameter is omitted, the integrated
manager will not be created.
Overload key: "ap_agent.di".

CyclicWalkTree O/R Flag. Cyclic traversal of trees. Possible values: 0 –

no; 1 – yes.
Default value is 0.
Overload key: "ap_agent.di" or "ap_manager.di".

Section [Dynamic].

{} Set of parameters. Optional section. List of variables and their values

that indicate that dynamic objects should be deleted.
Format: {variable_address;value;}.
Overload key: "ap_agent.di" or "ap_manager.di".

Section [SNMP]. Overload key: "ap_manager.di".

ListenIP O/R IP address. Default value is 0.0.0.0.

ListenPort O/R Int. Listening address and port at which

AP_Manager expects SNMP_Manager to connect.
Default value is 161.

OwnEnterprise O/R Format. Manufacturer address. Default value is

1.3.6.1.4.1.20873.

Section [StandardMib].

Set of parameters. Optional section. Objects from standard MIB.

{} Format: {SNMP-identifier_of_object;type;value;}.
Overload key: "ap_manager.di".

Page 50 of 100
 User Guide HLR/HSS

Parameter Significance of Description

the parameter /
restart

Section [AtePath2ObjName].

{} Set of parameters. Optional section. Describes the rules of conversion of

АТЕ-path into SNMP-path.
Format of a rule: {ctObject;caVar;},
where "ctObject" is object type; "caVar" is address of variable.
CA(1) address must be specified for each object type, otherwise the
objects will not be added to the SNMP tree.
Overload key: "ap_manager.di".

Section [SNMPTrap].

Rules for sending Traps. Optional section. Filters can be specified for
each SNMP manager. If no filters are specified, all Traps are sent to the
manager.
Format:
{SNMP_ManagerIP;SNMP_ManagerPort;caObjectFilter;ctObjectFilter;caV
arFilter;}, where:
SNMP_ManagerIP is the IP address of SNMP manager.
SNMP_ManagerPort is a number. Port number of SNMP manager.
CaObjectFilter is a regular expression. Filter by object address.
CtObjectFilter is a regular expression. Filter by object type.
CaVarFilter is a regular expression. Filter by address of variable.
Overload key: "ap_manager.di".

Section [Filter] – filtration of emergencies. Overload key: "ap_agent.di".

CA_Object O/R Filter by object address. Default value is ".*".

CT_Object O/R Filter by object type. Default value is ".*".

CA_Var O/R Filter by address of variable. Default value is ".*".

TrapIndicator O/R Filter by Trap indicator. Default value is 1.

DynamicIndicator O/R Filter by dynamic object indicator. Default value is

0.

Section [SpecificTrapCA_Object].

{} Set of parameters. Format: {caObject; specific_trap_base}

Overload key: "ap_manager.di".

Section [SpecificTrapCT_Object].

{} Set of parameters. Format: {ctObject; specific_trap_base}

Overload key: "ap_manager.di".

Page 51 of 100
 User Guide HLR/HSS

Parameter Significance of Description

the parameter /
restart

Section [SpecificTrapCA_Var].

{} Set of parameters. Format: {caVar; specific_trap_offset}

Overload key: "ap_manager.di".

Section [Logs]. Overload key: "ap_agent.di".

TreeTimerPeriod O/R Int. Period of storage of the current state of all

objects in the file-log. In milliseconds.

FilterLevel O/R Rules of emergency filtration for logs.

{caObj, ctObj, caVar, nLevel} – format {object
address (can be a regular expression);object type
(can be a regular expression);variable
address;level}.
For example:
{Ph.Card.1; Ph.Card; OSTATE; 4}; – set level = 4
for OSTATE variable in object Ph.Card.1 of Ph.Card
type.
{.*; .*; OSTATE; 5}; – set level = 5 for OSTATE
variable in all objects.

3.13 Rules of assigning the traps of SpecificTrap

(ap_distionary.cfg)
In the ap_dictionary dictionary the values of SpecificTrap are specified for the OSTATE,
ASTATE and HSTATE reserved variables.
Example:
# Dictionary

OSTATE = {
{1; ACTIVATE}; SP_Trap = 1;
{0; FAIL}; SP_Trap = 2;
};
ASTATE =
{
{1; UNBLOCKED}; SP_Trap=3;
{2; BLOCKED}; SP_Trap=4;
};
HSTATE =
{
{1; ON}; SP_Trap=5;
{0; OFF}; SP_Trap=6;
};

Page 52 of 100
 User Guide HLR/HSS

4 Logs
4.1 CDR records of Diameter-interaction
4.1.1 CDR records of transactions from MME/SGSN to HSS
1. AuthenticationInfo
1) DateTime (see description in subsection 4.1.8);
2) AI (see description in subsection 4.1.8);
3) OpCode (see description in subsection 4.1.8);
4) IMSI (see description in subsection 4.1.8);
5) OrigHost (see description in subsection 4.1.8);
6) DestHost (see description in subsection 4.1.8);
7) SessionId (see description in subsection 4.1.8);
8) DB_Status (see description in subsection 4.1.8);
9) ErrorCode (see description in subsection 4.1.8).
2. UpdateLocation
1) DateTime (see description in subsection 4.1.8);
2) UL (see description in subsection 4.1.8);
3) OpCode (see description in subsection 4.1.8);
4) IMSI (see description in subsection 4.1.8);
5) DestHost (see description in subsection 4.1.8);
6) MSISDN (see description in subsection 4.1.8);
7) OrigHost (see description in subsection 4.1.8);
8) OrigRealm (see description in subsection 4.1.8);
9) SGSN_Number (see description in subsection 4.1.8);
10) SessionId (see description in subsection 4.1.8);
11) DB_Status (see description in subsection 4.1.8);
12) ErrorCode (see description in subsection 4.1.8).
3. Notify
1) DateTime (see description in subsection 4.1.8);
2) NO (see description in subsection 4.1.8);
3) OpCode (see description in subsection 4.1.8);
4) IMSI (see description in subsection 4.1.8);
5) OrigHost (see description in subsection 4.1.8);
6) DestHost (see description in subsection 4.1.8);
7) SessionId (see description in subsection 4.1.8);
8) DB_Status (see description in subsection 4.1.8);
9) ErrorCode (see description in subsection 4.1.8).

Page 53 of 100
 User Guide HLR/HSS

4. MEIdentityCheck
1) DateTime (see description in subsection 4.1.8);
2) MEIC (see description in subsection 4.1.8);
3) OpCode (see description in subsection 4.1.8);
4) IMSI (see description in subsection 4.1.8);
5) OrigHost (see description in subsection 4.1.8);
6) DestHost (see description in subsection 4.1.8);
7) SessionId (see description in subsection 4.1.8);
8) DB_Status (see description in subsection 4.1.8);
9) ErrorCode (see description in subsection 4.1.8).

4.1.2 CDR records of transactions from HSS to MME/SGSN

1. InsertSubscriberData
1) DateTime (see description in subsection 4.1.8);
2) ISD (see description in subsection 4.1.8);
3) OpCode (see description in subsection 4.1.8);
4) IMSI (see description in subsection 4.1.8);
5) OrigHost (see description in subsection 4.1.8);
6) DestHost (see description in subsection 4.1.8);
7) SessionId (see description in subsection 4.1.8);
8) DB_Status (see description in subsection 4.1.8);
9) ErrorCode (see description in subsection 4.1.8);
10) MSISDN (see description in subsection 4.1.8).
2. DeleteSubscriberData
1) DateTime (see description in subsection 4.1.8);
2) DSD (see description in subsection 4.1.8);
3) OpCode (see description in subsection 4.1.8);
4) IMSI (see description in subsection 4.1.8);
5) OrigHost (see description in subsection 4.1.8);
6) DestHost (see description in subsection 4.1.8);
7) SessionId (see description in subsection 4.1.8);
8) DB_Status (see description in subsection 4.1.8);
9) ErrorCode (see description in subsection 4.1.8).
3. CancelLocation
1) DateTime (see description in subsection 4.1.8);
2) CL (see description in subsection 4.1.8);
3) OpCode (see description in subsection 4.1.8);
4) IMSI (see description in subsection 4.1.8);
5) OrigHost (see description in subsection 4.1.8);
6) DestHost (see description in subsection 4.1.8);

Page 54 of 100
 User Guide HLR/HSS

7) SessionId (see description in subsection 4.1.8);

8) DB_Status (see description in subsection 4.1.8);
9) ErrorCode (see description in subsection 4.1.8).

4.1.3 CDR records of transactions from I-CSCF to HSS

1. UserAuthorization
1) DateTime (see description in subsection 4.1.8);
2) UA (see description in subsection 4.1.8);
3) OpCode (see description in subsection 4.1.8);
4) PivateId (see description in subsection 4.1.8);
5) PublicId (see description in subsection 4.1.8);
6) OrigHost (see description in subsection 4.1.8);
7) DestHost (see description in subsection 4.1.8);
8) SessionId (see description in subsection 4.1.8);
9) DB_Status (see description in subsection 4.1.8);
10) ErrorCode (see description in subsection 4.1.8).
2. LocationInfo
1) DateTime (see description in subsection 4.1.8);
2) LI (see description in subsection 4.1.8);
3) OpCode (see description in subsection 4.1.8);
4) strPublicId (see description in subsection 4.1.8);
5) strOrigHost (see description in subsection 4.1.8);
6) strDestHost (see description in subsection 4.1.8);
7) strSessionId (see description in subsection 4.1.8);
8) nDB_Status (see description in subsection 4.1.8);
9) nErrorCode (see description in subsection 4.1.8).

4.1.4 CDR records of transactions from S-CSCF to HSS

1. ServerAssignment
1) DateTime (see description in subsection 4.1.8);
2) SA (see description in subsection 4.1.8);
3) OpCode (see description in subsection 4.1.8);
4) PivateId (see description in subsection 4.1.8);
5) PublicId (see description in subsection 4.1.8);
6) OrigHost (see description in subsection 4.1.8);
7) DestHost (see description in subsection 4.1.8);
8) SessionId (see description in subsection 4.1.8);
9) DB_Status (see description in subsection 4.1.8);
10) ErrorCode (see description in subsection 4.1.8).

Page 55 of 100
 User Guide HLR/HSS

2. MultimediaAuth
1) DateTime (see description in subsection 4.1.8);
2) MA (see description in subsection 4.1.8);
3) OpCode (see description in subsection 4.1.8);
4) PivateId (see description in subsection 4.1.8);
5) PublicId (see description in subsection 4.1.8);
6) OrigHost (see description in subsection 4.1.8);
7) DestHost (see description in subsection 4.1.8);
8) SessionId (see description in subsection 4.1.8);
9) DB_Status (see description in subsection 4.1.8);
10) ErrorCode (see description in subsection 4.1.8).

4.1.5 CDR records of transactions from HSS to S-CSCF

1. RegistrationTermination
1) DateTime (see description in subsection 4.1.8);
2) RT (see description in subsection 4.1.8);
3) OpCode (see description in subsection 4.1.8);
4) PivateId (see description in subsection 4.1.8);
5) PublicId (see description in subsection 4.1.8);
6) OrigHost (see description in subsection 4.1.8);
7) DestHost (see description in subsection 4.1.8);
8) SessionId (see description in subsection 4.1.8);
9) DB_Status (see description in subsection 4.1.8);
10) ErrorCode (see description in subsection 4.1.8).
2. PushProfile
1) DateTime (see description in subsection 4.1.8);
2) PP (see description in subsection 4.1.8);
3) OpCode (see description in subsection 4.1.8);
4) PivateId (see description in subsection 4.1.8);
5) PublicId (see description in subsection 4.1.8);
6) OrigHost (see description in subsection 4.1.8);
7) DestHost (see description in subsection 4.1.8);
8) SessionId (see description in subsection 4.1.8);
9) DB_Status (see description in subsection 4.1.8);
10) ErrorCode (see description in subsection 4.1.8).

Page 56 of 100
 User Guide HLR/HSS

4.1.6 CDR records of transactions from AS to HSS

1. UserData
1) DateTime (see description in subsection 4.1.8);
2) UD (see description in subsection 4.1.8);
3) OpCode (see description in subsection 4.1.8);
4) PublicId (see description in subsection 4.1.8);
5) OrigHost (see description in subsection 4.1.8);
6) DestHost (see description in subsection 4.1.8);
7) SessionId (see description in subsection 4.1.8);
8) DB_Status (see description in subsection 4.1.8);
9) ErrorCode (see description in subsection 4.1.8).
2. SubscriberNotify
1) DateTime (see description in subsection 4.1.8);
2) SN (see description in subsection 4.1.8);
3) OpCode (see description in subsection 4.1.8);
4) PublicId (see description in subsection 4.1.8);
5) OrigHost (see description in subsection 4.1.8);
6) DestHost (see description in subsection 4.1.8);
7) SessionId (see description in subsection 4.1.8);
8) DB_Status (see description in subsection 4.1.8);
9) ErrorCode (see description in subsection 4.1.8).
3. ProfileUpdate
1) DateTime (see description in subsection 4.1.8);
2) PU (see description in subsection 4.1.8);
3) OpCode (see description in subsection 4.1.8);
4) PublicId (see description in subsection 4.1.8);
5) OrigHost (see description in subsection 4.1.8);
6) DestHost (see description in subsection 4.1.8);
7) SessionId (see description in subsection 4.1.8);
8) DB_Status (see description in subsection 4.1.8);
9) ErrorCode (see description in subsection 4.1.8).

4.1.7 CDR records of transactions from HSS to AS

1. PushNotification
1) DateTime (see description in subsection 4.1.8);
2) PN (see description in subsection 4.1.8);
3) OpCode (see description in subsection 4.1.8);
4) PublicId (see description in subsection 4.1.8);
5) OrigHost (see description in subsection 4.1.8);

Page 57 of 100
 User Guide HLR/HSS

6) DestHost (see description in subsection 4.1.8);

7) SessionId (see description in subsection 4.1.8);
8) DB_Status (see description in subsection 4.1.8);
9) ErrorCode (see description in subsection 4.1.8).

4.1.8 Description of fields

• DateTime — date and time of event;
• AI/UL/NO/MEIC/ISD/DSD/CL/UA/LI/SA/MA/RT/PP/UD/SN/PU/PN- type of
CDR;
• IMSI – IMSI;
• OrigHost – origin host;
• DestHost - destination host;
• MSISDN – MSISDN;
• SGSN_Number – SGSN number;
• OpCode – diameter message code;
• SessionID - diameter session id;
• DB_Status - result of processing the request in database;
• ErrorCode – error code from ResultCode (0 – no error);
• PrivateId – identifier in IMS, that is similar to IMSI;
• PublicId - identifier in IMS, that is similar to MSISDN.

4.1.8.1 nDB_Status- result of request processing in DB

• DB_STATUS_PDA_ERROR = -1 - no access to the database;
• DB_STATUS_SUCCESS = 0 – success;
• DB_STATUS_SYSTEM_FAILURE = 1 - logical error;
• DB_STATUS_NO_IMSI = 11 – IMSI not found;
• DB_STATUS_NO_IMSI = 11 – number not found;
• DB_STATUS_NOT_IN_WHITE_LIST = -5, not in WL.

4.1.8.2 nErrorCode – result of Diameter operation

• DIAMETER_AUTHENTICATION_DATA_UNAVAILABLE = 4181 - Unexpectedly
transient failure occurs
• DIAMETER_ERROR_EQUIPMENT_UNKNOWN = 5422 - Mobile equipment is
not known in the EIR
• DIAMETER_ERROR_RAT_NOT_ALLOWED = 5421 - No suitable cells in
tracking area, or Roaming not allowed in this tracking area, or Tracking area
not allowed
• DIAMETER_ERROR_ROAMING_NOT_ALLOWED = 5004 - PLMN not allowed or
Network failure
• DIAMETER_ERROR_UNABLE_TO_COMPLY = 5012 - Network failure
• DIAMETER_ERROR_UNKNOWN_EPS_SUBSCRIPTION = 5420 - No suitable
cells in tracking area (without Error Diagnostic, or with Error Diagnostic of
GPRS_DATA_SUBSCRIBED) or EPS services not allowed (with Error
Diagnostic of NO_GPRS_DATA_SUBSCRIBED)

Page 58 of 100
 User Guide HLR/HSS

• DIAMETER_ERROR_UNKOWN_SERVING_NODE = 5423 - Notify command

has been received from a serving node which is not registered in HSS as the
node currently serving the user
• DIAMETER_ERROR_USER_UNKNOWN = 5001 - EPS services and non-EPS
services not allowed
• UNKNOWN_USER = 5030 - Subscriber unknown in HSS.

4.1.8.3 nOpCode – code of DIAMETER-message

LTE
• Update_Location = 316
• Cancel_Location = 317
• Authentication_Information = 318
• Insert_Subscriber_Data = 319
• Delete_Subscriber_Data = 320
• Purge_UE = 321
• Reset = 322
• Notify = 323
• ME_Identity_Check = 324
IMS
• User_Authorization = 300
• Server_Assignment = 301
• Location_Info= 302
• Multimedia_Auth = 303
• Registration_Termination = 304
• Push_Profile = 305
• User_Data = 306
• Profile_Update = 307
• Subscriber_Notify = 308
• Push_Notification = 309

4.2 CDR Records about Subscriber Loading

Operations
Example of information output in CDR:

DateTime;LS;IMSI;MSISDN;Algoritm;SCA;O_CSI_1,…O_CSI_N;T_CSI_1,…T_CSI_N;SMS_CSI
_1,…SMS_CSI_N;GPRS_CSI_1,…GPRS_CSI_N; PDP_ContextID_1,…PDP_ContextID_N;
TeleService_1,…TeleService_N; SS_1, SS_N; DefaultForwardingNumber;
DefaultForwardingStatus; Result;

Page 59 of 100
 User Guide HLR/HSS

4.2.1 Parameters of the direction from VLR/MSC to HLR/HSS

1. SendAuthenticationInfo

«DateTime; SAI; OpCode; strIMSI; strCgPN; strCdPN; nTID; nDB_Status; nTrStatus;

nErrorCode; nVersion;»

Note: SAIr - a particular case of SAI request. It shows that has been performed
SQN correction for this SAI. (see “Ошибка! Источник ссылки не найден.”).
2. UpdateLocation

«DateTime; UL; OpCode; strIMSI; strCgPN; strCdPN; nTID; nDB_Status; nTrStatus;

nErrorCode; nVersion; strMSISDN, strVLR; strMSC;»

3. UpdateGprsLocation

«DateTime; GPRS_UL; OpCode; strIMSI; strCgPN; strCdPN; nTID; nDB_Status; nTrStatus;

nErrorCode; nVersion; strSGSN_Number; strSGSN_Address;»

4. RestoreData -

«DateTime; RD; OpCode; strIMSI; strCgPN; strCdPN; nTID; nDB_Status; nTrStatus;

nErrorCode; nVersion; strMSISDN, strVLR; strMSC;»

5. PurgeMS

«DateTime; PurgeMS; OpCode; strIMSI; strCgPN; strCdPN; nTID; nDB_Status; nTrStatus;

nErrorCode; nVersion; strVLR_SGSN;»

6. ReadyForSM

«DateTime; RFSM; OpCode; strIMSI; strCgPN; strCdPN; nTID; nDB_Status; nTrStatus;

nErrorCode; nVersion; nAlertReason;»

7. RegisterSS/EraseSS/ActivateSS/DeactivateSS/InterrogateSS/ProcessUnstructuredSS
_Request/ProcessUnstructuredSS_Data

«DateTime; SS; OpCode; strIMSI; strCgPN; strCdPN; nTID; nDB_Status; nTrStatus;

nErrorCode; nVersion; strMSISDN;»

8. SendRoutingInfoForSM

«DateTime; SRI; OpCode; strIMSI; strCgPN; strCdPN; nTID; nDB_Status; nTrStatus;

nErrorCode; nVersion; strMSISDN; strSCA; strMSC;»

9. SendRoutingInfo

«DateTime; SRI; OpCode; strIMSI; strCgPN; strCdPN; nTID; nDB_Status; nTrStatus;

nErrorCode; nVersion; strMSISDN; strGMSC; IT; Camel; Suppress_T_CSI; strMSC; strMSRN;»

10. AnyTimeInterrogation

«DateTime; ATI; OpCode; strIMSI; strCgPN; strCdPN; nTID; nDB_Status; nTrStatus;

nErrorCode; nVersion; strMSISDN; strGsmSCF_Address;»

11. RegisterPassword

«DateTime; RP; OpCode; strIMSI; strCgPN; strCdPN; nTID; nDB_Status; nTrStatus;

nErrorCode; nVersion; strVLR_SGSN; nSS_Code;»

Page 60 of 100
 User Guide HLR/HSS

12. SendIMSI

«DateTime; SendIMSI; OpCode; strIMSI; strCgPN; strCdPN; nTID; nDB_Status; nTrStatus;

nErrorCode; nVersion; strMSISDN;»

13. AuthenticationFailureReport

«DateTime; AFR; OpCode; strIMSI; strCgPN; strCdPN; nTID; nDB_Status; nTrStatus;

nErrorCode; nVersion;»

14. MAP_ProcessUnstructuredSS_Request/MAP_BeginSubscriberActivity/MAP_BeginSubs
criberActivityErricsson

«DateTime; MO_SS; OpCode; strIMSI; strCgPN; strCdPN; nTID; nDB_Status; nTrStatus;

nErrorCode; nVersion; strMSISDN;»

15. AnyTimeModification

«ATM; OpCode; strIMSI; strCgPN; strCdPN; nTID; nDB_Status; nTrStatus; nErrorCode;

nVersion; strMSISDN; strGsmSCF_Address;»

4.2.2 Parameters of the direction from HLR/HSS to VLR/MSC

1. AlertSC

«DateTime; ASC; OpCode; strIMSI; strCgPN; strCdPN; nTID; nDB_Status; nTrStatus;

nErrorCode; nVersion; strMSISDN;»

2. InsertSubscriberData

«DateTime; ISD; OpCode; strIMSI; strCgPN; strCdPN; nTID; nDB_Status; nTrStatus;

nErrorCode; nVersion; strMSISDN; strVLR; nISD_Count;»

3. DeleteSubscriberData

«DateTime; DEL_SD; OpCode; strIMSI; strCgPN; strCdPN; nTID; nDB_Status; nTrStatus;

nErrorCode; nVersion; strVLR;»

4. CancelLocation

«DateTime; CL; OpCode; strIMSI; strCgPN; strCdPN; nTID; nDB_Status; nTrStatus;

nErrorCode; nVersion;»

5. ProvideRoamingNumber

«DateTime; PRN; OpCode; strIMSI; strCgPN; strCdPN; nTID; nDB_Status; nTrStatus;

nErrorCode; nVersion;»

6. ProvideSubscriberInfo

«DateTime; PSI; OpCode; strIMSI; strCgPN; strCdPN; nTID; nDB_Status; nTrStatus;

nErrorCode; nVersion;»

7. UnstructuredSS_Request/UnstructuredSS_Notify

«DateTime; MT_SS; OpCode; strIMSI; strCgPN; strCdPN; nTID; nDB_Status; nTrStatus;

nErrorCode; nVersion; strMSISDN;»

8. Reset

«DateTime; Reset; OpCode; strCgPN; strCdPN; nTID; nDB_Status; nTrStatus; nErrorCode;

nVersion;»

Page 61 of 100
 User Guide HLR/HSS

9. ReportSM_DeliveryStatus

«DateTime; RSMD; OpCode; strIMSI; strCgPN; strCdPN; nTID; nDB_Status; nTrStatus;

nVersion;»

4.2.3 Description of parameters

• DateTime — date and time of event;
• UL/RD/ISD/… — type of CDR;
• strIMSI — IMSI;
• strCgPN — GTA (SCCP) of the incoming transaction;
• strCdPN — GTB (SCCP) of the incoming transaction;
• strMSISDN — MSISDN;
• strVLR — number of the VLR;
• strMSC — number of the MSC;
• strHLR/HSS — number of the HLR/HSS;
• nOpCode — code of the MAP-message;
• nTID — tcap_id of incoming transaction (otid);
• nDB_Status — result of request processing in the DB;
• nTrStatus — status of transaction completion;
• nErrorCode — error code from TCAP_RETURN_ERROR_IND (0 means “no error”);
• nVersion — version of the MAP.
• nISD_Count – count of parts of ICD message (if the subscriber profile is very big, it
transmitted by parts).

4.2.3.1 nErrorCode (from En_MAP_ErrorCodes)

generic error codes:
• MAP_SystemFailure = 34,
• MAP_DataMissing = 35,
• MAP_UnexpectedDataValue = 36,
• MAP_FacilityNotSupported = 21,
• MAP_IncompatibleTerminal = 28,
• MAP_ResourceLimitation = 51,
Identification and numbering error codes:
• MAP_UnknownSubscriber = 1,
• MAP_NumberChanged = 44,
• MAP_UnknownMSC = 3,
• MAP_UnidentifiedSubscriber = 5,
• MAP_UnknownEquipment = 7,
subscription error codes:
• MAP_RoamingNotAllowed = 8,
• MAP_IllegalSubscriber = 9,
• MAP_IllegalEquipment = 12,

Page 62 of 100
 User Guide HLR/HSS

• MAP_BearerServiceNotProvisioned = 10,
• MAP_TeleserviceNotProvisioned = 11,
call handling error codes:
• <>MAP_NoRoamingNumberAvailable = 39,
• <>MAP_AbsentSubscriber = 27,
• <>MAP_BusySubscriber = 45,
• <>//MAP_NoSubscriberReply = 46,
• <>MAP_CallBarred = 13,
• <>MAP_ForwardingFailed = 47,
• <>MAP_OR_NotAllowed = 48,
• <>MAP_ForwardingViolation = 14,
• <>MAP_CUG_Reject = 15,
supplementary service error codes:
• MAP_IllegalSS_Operation = 16,
• MAP_SS_ErrorStatus = 17,
• MAP_SS_NotAvailable = 18,
• MAP_SS_SubscriptionViolation = 19,
• MAP_SS_Incompatibility = 20,
• MAP_UnknownAlphabet = 71,
• MAP_USSD_Busy = 72,
• MAP_PW_RegistrationFailure = 37,
• MAP_NegativePW_Check = 38,
• MAP_NumberOfPW_AttemptsViolation = 43,
• MAP_ShortTermDenial = 29,
• MAP_LongTermDenial = 30,
short message service error codes:
• MAP_SubscriberBusyForMT_SMS = 31,
• MAP_SM_DeliveryFailure = 32,
• MAP_MessageWaitingListFull = 33,
• MAP_AbsentsubscriberSM = 6,
any time interrogation error codes:
• MAP_ATI_NotAllowed = 49
Note: If there is no error code of En_MAP_ErrorCodes, this field can get the code from
nDB_Status. For example, this situation is possible if there is no response from the database.

4.2.3.2 nDB_Status
• DB_STATUS_PDA_ERROR = -1 - do not have access to the database;
• DB_STATUS_SUCCESS = 0 – success;
• DB_STATUS_SYSTEM_FAILURE = 1 - logical error;
• DB_STATUS_NO_IMSI = 11 – IMSI not found.

Page 63 of 100
 User Guide HLR/HSS

• DB_STATUS_IS_FORBIDDEN = -6,
• DB_STATUS_NOT_IN_WHITE_LIST = -5, not in WL
• DB_STATUS_TIMEOUT_ABORT = -2, DB_TIMEOUT → TACP_ABORT
• DB_STATUS_INVALID_DATA = -3,
• DB_STATUS_UNKNOWN_VLR = 36, for PurgeMS, success, Send TCAP_END;
• DB_STATUS_NOT_USE = 100.

4.2.3.3 nOpCode (En_MAP_OperationCodes)

location registration operation codes
• MAP_UpdateLocation = 2,
• MAP_CancelLocation = 3,
purgeMS must not be used in version 1
• MAP_PurgeMS = 67,
sendIdentification must not be used in version 1
• MAP_SendIdentification = 55,
handover operation codes
• performHandover must not be used in version greater 1
• MAP_PerformHandover = 28,
• prepareHandover must not be used in version 1
• MAP_PrepareHandover = 68,
• MAP_SendEndSignal = 29,
• MAP_ProcessAccessSignalling = 33,
• MAP_ForwardAccessSignalling = 34,
☺performSubsequentHandover must not be used in version greater 1
• MAP_PerformSubsequentHandover = 30,
• prepareSubsequentHandover must not be used in version 1
• MAP_PrepareSubsequentHandover = 69,
authentication operation codes
• MAP_SendAuthenticationInfo = 56,
• MAP_AuthenticationFailureReport = 15,
IMEI MANAGEMENT operation codes
• MAP_CheckIMEI = 43,
subscriber management operation codes
sendParameters must not be used in version greater 1
• MAP_SendParameters = 9,
• MAP_InsertSubscriberData = 7,
• MAP_DeleteSubscriberData = 8,

Page 64 of 100
 User Guide HLR/HSS

fault recovery operation codes

• MAP_Reset = 37,
• MAP_ForwardCheckSS_Indication = 38,
• MAP_RestoreData = 57,
operation and maintenance operation codes:
• MAP_ActivateTraceMode = 50,
• MAP_DeactivateTraceMode = 51,
traceSubscriberActivity must not be used in version greater 1
• MAP_TraceSubscriberActivity = 52,
noteInternalHandover must not be used in version greater 1
• MAP_NoteInternalHandover = 35,
• MAP_SendIMSI = 58,
call handling operation codes
• MAP_SendRoutingInfo = 22,
• MAP_ProvideRoamingNumber = 4,
• MAP_ResumeCallHandling = 6,
• MAP_ProvideSIWFSNumber = 31,
• MAP_SIWFSSignallingModify = 32,
• MAP_SetReportingState = 73,
• MAP_StatusReport = 74,
• MAP_RemoteUserFree = 75,
• MAP_IST_Alert = 87,
• MAP_IST_Command = 88,
supplementary service handling operation codes
• MAP_RegisterSS = 10,
• MAP_EraseSS = 11,
• MAP_ActivateSS = 12,
• MAP_DeactivateSS = 13,
• MAP_InterrogateSS = 14,
processUnstructuredSS-Data must not be used in version greater 1
• MAP_ProcessUnstructuredSS_Data = 19,
beginSubscriberActivity must not be used in version greater 1
• MAP_BeginSubscriberActivity = 54,
• MAP_BeginSubscriberActivityErricsson = -2,
other must not be used in version 1
• MAP_ProcessUnstructuredSS_Request = 59,
• MAP_UnstructuredSS_Request = 60,
• MAP_UnstructuredSS_Notify = 61,
• MAP_RegisterPassword = 17,

Page 65 of 100
 User Guide HLR/HSS

• MAP_GetPassword = 18,
• MAP_RegisterCC_Entry = 76,
• MAP_EraseCC_Entry = 77,
short message service operation codes
• MAP_SendRoutingInfoForSM = 45,
• MAP_ForwardSM = 46,
• MAP_MO_ForwardSM = 46,
• MAP_MT_ForwardSM = 44,
• MAP_ReportSM_DeliveryStatus = 47<>,
noteSubscriberPresent must not be used in version greater 1
• MAP_NoteSubscriberPresent= 48,
alertServiceCentreWithoutResult must not be used in version greater 1
• MAP_AlertServiceCentreWithoutResult = 49,
• MAP_InformServiceCentre = 63,
• MAP_AlertServiceCentre = 64,
• MAP_ReadyForSM = 66,
provide subscriber info operation codes
• MAP_ProvideSubscriberInfo = 70,
• MAP_AnyTimeInterrogation = 71,
any time information handling operation codes
• MAP_AnyTimeSubscriptionInterrogation = 62,
• MAP_AnyTimeModification = 65,
subscriber data modification notification operation codes
• MAP_NoteSubscriberDataModified = 5,
supplementary service invocation notification operation codes
• MAP_SS_InvocationNotification = 72,
group call operation codes
• MAP_PrepareGroupCall = 39,
• MAP_SendGroupCallEndSignal = 40,
• MAP_ProcessGroupCallSignalling = 41,
• MAP_ForwardGroupCallSignalling = 42,
gprs location updating operation codes
• MAP_UpdateGprsLocation = 23,
gprs location information retrieval operation codes
• MAP_SendRoutingInfoForGprs = 24,
failure reporting operation codes
• MAP_FailureReport = 25,
GPRS notification operation codes
• MAP_NoteMsPresentForGprs = 26,

Page 66 of 100
 User Guide HLR/HSS

Location service operation codes

• MAP_ProvideSubscriberLocation = 83,
• MAP_SendRoutingInfoForLCS = 85,
• MAP_SubscriberLocationReport = 86,
Mobility Management operation codes
• MAP_NoteMM_Event = 89.

4.2.3.4 nTrStatus — status of transaction completion

1. SL_TIMEOUT = -1 — transaction finished due to timeout expiration;
2. TCAP_RETURN_RESULT = 0 — transaction finished due to TCAP_RETURN_RESULT;
3. TCAP_RETURN_ERROR = 1 — transaction finished due to TCAP_RETURN_ERROR;
4. TCAP_ABORT = 2 — transaction finished due to TCAP_ABORT;
5. TCAP_REJECT = 3 — transaction finished due to TCAP_REJECT;
6. TCAP_ERROR = 4 — transaction finished due to TCAP_ERROR (no response to ISD
for Non-First ULs);
7. TCAP_END = 5 — transaction finished due to TCAP_END.

4.3 Traffic Statistics

Example of configuration of statistics logging in file trace.cfg:

trafic_stat = {
file=«logs/stat_trafic.log»;
mask= date & time;
level=1;
separator=»;»;

Example of statistics configuration in file statistic.cfg:

[TraficStatistics]
LogName = «trafic_stat»;
Intervals = {
Check = 60000;
Out = 60;
Online = 15;
}

Where:
• Check (ms) — time interval for counting the maximum number of transactions per
second. Default value is 60000.
• Out (sec) — time period for statistics output in trafic_stat. Default value is 3600.
• Online (sec) — time period for statistics output in Alarm. Default value is 15.

4.3.1 CDR records of traffic statistics

Each statistical record is written in one row in the CDR file, parameters are separated
by ';' symbol.
Example:

DateTime; OpCode; MsgName; SuccessTrCount; FailTrCount;

MaxSpeed;%SuccessTrCount; %FailTrCount;

Page 67 of 100
 User Guide HLR/HSS

Description of fields:
1. DateTime — date and time of statistics reset (period is defined in statistic.xfg, Out
(default = 3600sec));
2. OpCode — operation code (0 — All — statistics for all transaction types);
3. MsgName — short name of transaction (All — all transactions);
4. SuccessTrCount — the number of successful transactions;
5. FailTrCount — the number of failed transactions;
6. ErrorTrCount — the number of failed transactions broken down by error (ErrorCode,
TCAP_Abort(-2)); format:
{{ErrorCode1;Count2;};{ErrorCode2;Count2};…{ErrorCodeN;CountN}};
7. MaxSpeed — maximum number of transactions per second counted within the specified
period of time (Statistics.cfg, Check (default = 60000 ms));
8. %SuccessTrCount — the percentage of successful transactions;
9. %FailTrCount — the percentage of failed transactions.
Example:

2014-11-26 20:00:00;2;UL;3598;0;{};1.05;100.00;0.00;
2014-11-26 20:00:00;10;R_SS;0;358;{{11;358;};};0.10;0.00;100.00;
2014-11-26 20:00:00;15;AFR;180;0;{};0.05;100.00;0.00;
2014-11-26 20:00:00;22;SRI;713;0;{};0.20;100.00;0.00;
2014-11-26 20:00:00;58;SendIMSI;357;0;{};0.10;100.00;0.00;
2014-11-26 20:00:00;59;SAI;354;0;{};0.10;100.00;0.00;
2014-11-26 20:00:00;67;PurgeMS;0;358;{{1;358;};};0.10;0.00;100.00;
2014-11-26 20:00:00;0;All;5202;716;{{1;358;};{11;358;};};295.90;87.90;12.10;

2014-11-26 21:00:00;2;UL;3599;0;{};1.05;100.00;0.00;
2014-11-26 21:00:00;10;R_SS;0;358;{{11;358;};};0.10;0.00;100.00;
2014-11-26 21:00:00;15;AFR;180;0;{};0.05;100.00;0.00;
2014-11-26 21:00:00;22;SRI;712;0;{};0.20;100.00;0.00;
2014-11-26 21:00:00;58;SendIMSI;358;0;0.10;100.00;0.00;
2014-11-26 21:00:00;59;SAI;354;0;{};0.10;100.00;0.00;
2014-11-26 21:00:00;67;PurgeMS;0;358;{{1;358;};};0.10;0.00;100.00;
2014-11-26 21:00:00;0;All;5203;716;{{1;358;};{11;358;};};295.95;87.90;12.10;

4.4 Statistics on Subscribers

Example of configuration of statistics logging in file trace.cfg:
abonent_stat = {
file=«logs/stat_abonent.log»;
mask= date & time;
level=1;
separator=»;»;

Example of statistics configuration in file statistic.cfg:

[AbonentStatistics]
LogName = «abonent_stat»;
Intervals = {
Check = 300;
Out = 120;
Online = 30;
}

Page 68 of 100
 User Guide HLR/HSS

where:
• Check (sec) — time interval for checking data relevancy. Default value is 300ms.
• Out (sec) — period for statistics output in abonent_stat. Default value is 120.
• Online (sec) — time interval for statistics output in Alarm. Default value is 3600.

4.4.1 CDR records of subscriber statistics

Each statistical record is written in one row in the CDR file, parameters are separated
by ';' symbol.
Example:

DateTime; OpCode; RegCount; ActiveCount;

Description of fields:
• DateTime — date and time of statistics reset (period is defined in statistic.xfg, Out
(default value is 3600sec));
• RegCount — the number of subscribers that registered within the specified time
interval (Out);
• ActiveCount — the number of subscribers that were active within the specified time
interval (Out);
• CurrentRegCount — current number of registered subscribers.
• UnblockCount – current number of unblock subscribers (request to the database -
select count(*) from TM_SUBSCRIBER_PROFILE where
NADMINISTRATIVE_STATE=2)
Example:

2014-12-08 12:02:00;2;3;2;31
2014-12-08 12:04:00;2;3;2;31

Page 69 of 100
 User Guide HLR/HSS

5 Alarm indication
Table 1. Alarm of HLR/HSS

Component type Component Variable Range of Sending Description

address Name / permissible snmp-trap /
Variable type values severity
level of the
traps

Operational status of the system

HLR.General HLR.General. OSTATE/ «ACTIVATE» +/ Protei_HLR

<HLR_ID> AP_TYPE_STR «FAIL» ACTIVATE- ACTIVATE – start, FAIL –
ING «STOP» normal failure stop, STOP –
«STATUS FAIL-critical manual stop, STATUS OK
OK» STOP- – system activity
critical
STATUS OK-
normal

Reloading configuration files

HLR.Reload ACD.Reload. Name/ File name +/ info Name overloaded

AP_TYPE_STR configuration file
<HLR_ID>
ING

Result/ «SUCCESS» +/ info SUCCESS

AP_TYPE_STR «FAIL»
FAIL
ING

Traffic statistics

HLR.Traffic.Stat HLR.Traffic. PARAM/ statistic +/info {Name=«stat»; Start=«<

Stat AP_TYPE_STR start time counting
ING statistics >»;
All={<Count>;<Rejected
>;<MaxSpeed>;[<Time
of MaxSpeed>];};
RD={<Count>;<Rejected
>;<MaxSpeed>;[<Time
of MaxSpeed>];};
UL={<Count>;<Rejected
>;<MaxSpeed>;[<Time
of MaxSpeed>];}}

Subscriber statistics

HLR.Abonent. HLR.Abonent. PARAM/ statistic +/info statistic

Stat Stat AP_TYPE_STR
ING

Overloading occupied SL-logics

HLR.OVRLOAD.
Handler.SL

Page 70 of 100
 User Guide HLR/HSS

Component type Component Variable Range of Sending Description

address Name / permissible snmp-trap /
Variable type values severity
level of the
traps

HLR.OVRLOA OSTATE/ «ACTIVATE» +/ normal/ Activation/

D.Handler.SL AP_TYPE_STR ,«FAIL» warning
deactivation overload
ING

PARAM/ Handlers= +/ normal/

AP_TYPE_STR <count>; warning
ING CoreID=<id
>;

Exceeding of queue internal primitives

HLR.OVRLOAD.Qu HLR.OVRLOA OSTATE/ «ACTIVATE» +/ normal/ Activation/

eue.Logic D.Queue. AP_TYPE_STR ,«FAIL» warning
deactivation
Logic ING

PARAM/ Size=<queu +/ normal/ The size of the queue and

AP_TYPE_STR e_size>;Cor warning the core ID
ING eID=<id>;

Exceeding license

HLR.OVRLOAD.LI HLR.OVRLOA OSTATE/ {«ACTIVATE +/ normal Traffic Nominal Exceeded

CENSE.MINOVR D.LICENSE.MI AP_TYPE_STR »}
NOVR ING

PARAM/ CallsCount= +/ normal The size of the

AP_TYPE_STR <count>;Co TrafficNominal and the
ING reID=<id>; core ID

Exceeding license stopped

HLR.OVRLOAD.LI HLR.OVRLOA OSTATE/ {«FAIL»} +/ warning During the Check Interval

CENSE.MINOVR D.LICENSE.MI AP_TYPE_STR has not been exceeded
NOVR ING Licenses

PARAM/ CoreID=<id +/ warning core ID

AP_TYPE_STR >;
ING

Exceeding license for a long time

HLR.OVRLOAD.LI HLR.OVRLOA OSTATE/ {«ACTIVATE +/ normal During

CENSE.MAJOVR D.LICENSE.M AP_TYPE_STR »} TrafficTresholdInterval
AJOVR ING constant excess license

PARAM/ Interval=<i +/ normal The value of

AP_TYPE_STR nt>;CoreID TrafficTresholdInterval and
ING =<id>; the core ID

Exceeding license stopped

HLR.OVRLOAD.LI HLR.OVRLOA OSTATE/ {«FAIL»} +/ warning During the CheckInterval

CENSE.MAJOVR D.LICENSE.M AP_TYPE_STR has not been exceeded
AJOVR ING Licenses

Page 71 of 100
 User Guide HLR/HSS

Component type Component Variable Range of Sending Description

address Name / permissible snmp-trap /
Variable type values severity
level of the
traps

PARAM/ CoreID= +/ warning core ID

AP_TYPE_STR <id>;
ING

5.1 Generating traps with trap.pl script

Explanation the data transmitted in the trap
• 192.168.108.111 = SNMP-manager address, which catches trap.
• 1.3.6.1.4.1.20873.146.1.1.2.1=«HLR.General»,
1.3.6.1.4.1.20873.146.1.1.3.1=«STOP» - variables set SNMP-addresses with their
values are passed to the trap.
• enterprise = SNMP-address of applicast (1.3.6.1.4.1.20873.146 = HLR).
• specifictrap = trap ID specified in the MIB (1002 - HLR active, 1001 - HLR inactive).
Trap stop HLR (prescribed in the stop application script):
$SCRIPTS_DIR/trap.pl 192.168.108.111 public
1.3.6.1.4.1.20873.146.1.1.2.1="HLR.General",1.3.6.1.4.1.20873.146.1.1.3.1="ST
OP" enterprise=1.3.6.1.4.1.20873.146 specifictrap=1002

Trap downs HLR (prescribed in the check script the application is running or not (in the
path when the application is not in the process))):
$SCRIPTS_DIR/trap.pl 192.168.108.111 public
1.3.6.1.4.1.20873.146.1.1.2.1="HLR.General",1.3.6.1.4.1.20873.146.1.1.3.1="FA
IL" enterprise=1.3.6.1.4.1.20873.146 specifictrap=1002

Trap checking activity (prescribed in the check script the application is running or not
(in the path when the application is in the process)):
$SCRIPTS_DIR/trap.pl 192.168.108.111 public
1.3.6.1.4.1.20873.146.1.1.2.1="HLR.General",1.3.6.1.4.1.20873.146.1.1.3.1="ST
ATUS OK" enterprise=1.3.6.1.4.1.20873.146 specifictrap=1001

Traps are specified in the following script:

• Trap stop – stop after the string ./bin/utils/move_log.sh
• Trap downs - bin/utils/check_threads.sh at the beginning of function start ()

start()
{
./bin/utils/trap.pl...
...
}

Page 72 of 100
 User Guide HLR/HSS

• Trap checking activity - bin/utils/check_threads.sh in the path from if to fi (check

MAX_THREAD_COUNT)

if ...
then
...
else
./bin/utils/trap.pl...
fi

5.2 Reload of parameters

The configuration parameters are divided into three groups:
1. Parameters of AP_Agent. Format:
./reload ap_agent.di
./reload ap_agent.di “config/alarm/ap.cfg”
If the parameters are not specified, the default path to ap.cfg = config / ap.cfg
2. Parameters of AP_Manager:
./reload ap_manager.di
./reload ap_manager.di “config/alarm/ap.cfg”
3. Parameters of AP_Interface(API_CLIENT)
./reload ap_api_client.di
./reload ap_api_client.di “config/alarm/ap.cfg”
Reload only the following list of settings / sections:
• AP_Agent

[General]
ApplicationAddress=APP.1
MaxConnectionCount=10
[Logs]

• AP_Manager

[General]
CyclicWalkTree=0
[StandardMib]
[SNMPTrap]
[SpecificTrapCA_Object]
[SpecificTrapCT_Object]
[SpecificTrapCA_Var]

• AP_Interface (API_CLIENT)

[General]
MaxOpenedTransactionCount

Page 73 of 100
 User Guide HLR/HSS

Appendix
Protei HLR/HSS API
Purpose
The present document describes JSON API between PROTEI HLR/HSS and 3 rd party
systems. It is used to provide, change or delete HLR/HSS subscriber profiles.

Definitions, Acronyms and Abbreviations

Definition/Ac Description
ronym/Abbreviat
ion
API Application Programming Interface
Json JavaScript Object Notation
HTTP HyperText Transfer Protocol
SS Supplementary Service
EPS Evolved Packet System
DIAMETER Authentication, authorization and accounting protocol
IMSI International Mobile Subscriber Identity
MSISDN Mobile Subscriber Integrated Services Digital Number
PDP Packet Data Protocol
ODB Operator Determined Barring
CAMEL Customized Applications for Mobile network Enhanced Logic
O-CSI Originating CAMEL Subscription Information
T-CSI Terminating CAMEL Subscription Information
M-CSI Mobility Management CAMEL Subscription Information
SMS Short Message Service
GPRS General Packet Radio Service
CSI CAMEL Subscription Information
ISD Insert Subscriber Data
DSD Delete Subscriber Data
ISR Insert Subscriber Data Request
DSR Delete Subscriber Data Request
CLR Cancel Location Request
LCS Location Services

Overview
Section 2 contains specification of JSON over HTTP/HTTPS interface. You may find the
examples of JSON requests as well as responses in A Attachment.

Page 74 of 100
 User Guide HLR/HSS

JSON over HTTP interface

General
Requests are handled in synchronous mode. Each request from the client party is
processed by the server party and the answer is returned on a synchronous basis.
Requests are sent using HTTP protocol.
The requests and responses are constructed in JSON
The JSON requests and responses are based on provided JSON schemes. Each request
supports one operation.
Each JSON request and response must be encoded in UTF-8 in order to support
multiple languages in one system.
APPLICATION should use one endpoint URL for sending all requests to Protei HLR:
http(s)://<ProteiAPIServer>:<Port>/hlr/
where:
• ProteiAPIServer – Protei HLR server IP number or DNS name
• Port – IP port number
The system is using Digest access authentication.

Requests to Protei

Add subscriber (/SubscriberService/AddSubscriber)

This command is used to provide a new subscriber into HLR/HSS.
Request
/SubscriberService/AddSubscriber
The POST request json data format is following:
[
“imsi” : “<imsi>”,
“msisdn” : “<msisdn>”,
“ki” : “<ki>”,
“algorithm” : “<algorithm>”,
“status” : “<status>”,
“ssData” : [ ],
“ssForw” : [ ],
“ssBarring” : [ ],
“aucData” : {},
“epsData” : {},
“hlr_profile_id” : “<id>”
]

The request contains the following parameters:

Element/Attribute Mandatory Description

<imsi> Mandatory IMSI of the subscriber. . \d(15)

<msisdn> Optional MSISDN of the subscriber \d

<ki> Mandatory KI. Secret key stored in the SIM and AuC

Page 75 of 100
 User Guide HLR/HSS

Element/Attribute Mandatory Description

<algorithm> Mandatory Algorithm 1 – 4

1 – COMP128 v1 / 2 – COMP128 v2 / 3 – COMP128 v1
/ 4-Milenage

<status> Mandatory The subscriber status \d. Possible values:

0 - not provisioned
1 - provisioned/locked
2 - provisioned/unlocked
3 - provisioned/suspended
4- terminated

<hlr_profile_id> Optional Identifier of hlr/hss profile \d

<ssData> Optional List of Supplementary Services and their parameters.

The format is described in section 0.

<ssForw> Optional List of Forwarding supplementary services and their

parameters. The format is described in section 0.

<ssBarring> Optional List of Barring supplementary Services and their

parameters. The format is described in section 0.

<ForbidReg_Without Optional Flag to prohibit registration on VLR/SGSN without

Camel> necessary camel phases support 0/1

<epsData> Optional Evolved Packet System Parameters. Format is

described in section 0

<aucData> Optional List of Authentication parameters. Format is described

in section 0

Reply
Below is a "AddSubscriber" reply format.
{
“status” : “<status>”,
}

The response contains the following parameters:

Element/Attribute Mandatory Description

<status> Mandatory The statuses of the request:

• OK
• NOT_FOUND
• NOT_AVAILABLE
• PERMISSION_DENIED
• INVALID_AUTH
• INTERNAL_ERROR
• ALREADY_EXIST
• INTEGRITY_VIOLATION
• OBJECT_BUSY

Page 76 of 100
 User Guide HLR/HSS

Element/Attribute Mandatory Description

• INCORRECT_PARAMS
• TEMPORARY_FAILURE
• HLR_SERVER_ERROR
• PARTIAL_OK
• SAME_IMSI

Delete subscriber (DeleteSubscriber)

This command is used to delete a subscriber from HLR/HSS and AUC. If the subscriber
has active registration on VLR, SGSN or MME, it is withdrawn by MAP or S6 Cancel location.
Request
/SubscriberService/DeleteSubscriber
POST request json data format:
[
“imsi” : “<imsi>”
]

[
“msisdn” : “<msisdn>”
]

The request contains the following parameters: (Conditional means that the request
can contain either IMSI or MSISDN parameter)

Element/Attribute Mandatory Description

<imsi> Conditional IMSI of the subscriber. . \d(15)

<msisdn> Соnditional MSISDN \d

Reply
A "DeleteSubscriber" reply format is given below:
{
“status” : “<status>”,
}

The response contains the following parameters:

Element/Attribute Mandatory Description

<status> Mandatory The statuses of the request are described in section 0

Page 77 of 100
 User Guide HLR/HSS

Change status (ChangeStatus)

This command is used to change state of a subscription in HLR/HSS. If a subscriber
whose state has been changed from provisioned/unlocked state has active registration on VLR,
SGSN or MME, it is withdrawn by MAP or S6 Cancel location. The same functionality may be
achieved by ProfileControl command.
Request
/SubscriberService/ChangeStatus
POST request json data format:
[
“imsi” : “<imsi>”,
“status” : “<status>”
]

The request contains the following parameters:

Element/Attribute Mandatory Description

<imsi> Conditional IMSI of the subscriber. . \d(15)

<msisdn> Conditional MSISDN \d

<status> Mandatory The subscriber state

0 - not provisioned
1 - provisioned/locked
2 - provisioned/unlocked
3 - provisioned/suspended
4 - terminated

Reply
A "ChangeStatus" reply format is given below.
{
“status” : “<status>”,
}

The response contains the following parameters:

Element/Attribute Mandatory Description

<status> Mandatory The statuses of the request is described in section 0

Page 78 of 100
 User Guide HLR/HSS

Change MSISDN (SetMSISDN)

This command is used to change the state of a subscription in HLR/HSS and/or
MSISDN of a subscriber. If the subscriber whose state has been changed from
provisioned/unlocked state has active registration on VLR, SGSN or MME, it is withdrawn by
MAP or S6 Cancel location. If the subscriber who’s MSISDN has been changed has active
registration on VLR, SGSN or MME, new MSISDN is sent in MAP ISD or S6 ISR. Same
functionality may be achieved by ProfileControl command.
Request
/ProfileService/SetMSISDN
POST request json data format:
[
“imsi” : “<imsi>”,
“msisdn” : “<msisdn>”,
“status” : “<status>”
]

The request contains the following parameters:

Element/Attribute Mandatory Description

<imsi> Mandatory IMSI \d(15)

<msisdn> Mandatory MSISDN \d

<status> Optional The subscriber state

0 - not provisioned
1 - provisioned/locked
2 - provisioned/unlocked
3 - provisioned/suspended
4 - terminated

Reply
A "SetMSISDN" reply format is given below.
{
“status” : “<status>”,
}

The response contains the following parameters:

Element/Attribute Mandatory Description

<status> Mandatory The statuses of the request are described in point 0

Page 79 of 100
 User Guide HLR/HSS

Change Profile (ProfileControl)

This command is used to change various parameters of a subscription in HLR/HSS. When a
subscriber has active registration on VLR or SGSN, MAP ISD/DSD or Cancel Location may be
initiated depending on the changed data. If EPS parameters are changed for the subscriber
with active registration on MME/SGSN S6 ISR, DSR or CLR may be initiated depending on the
changed data.
Request
/ProfileService/ProfileControl
POST request json data format:
{
“imsi” : “<imsi>”,
“msisdn” : “<msisdn>”,
“newMsisdn” : “<newMsisdn>”,
“status” : “<status>”,
“forbid_reg” : “<forbid_reg_flag>”,
“<odb-param>” : […],
“pdp-data” : “<PDP context list>”,
“eps-data” : {<eps_data>},
“link-eps-data” : {<eps context id to add/remove>},
“csi-list” : [ ],
“ssData” : [ ],
“ssForw” : [ ],
“ssBarring” : [ ],
“teleserviceList” : [..],
“bearerserviceList” : [..],
“defaultForwNumber” : <defaultForwNumber>,
“defaultForwStatus” : <defaultForwStatus>
}

The request contains the following parameters:

Element/Attribute Mandatory Description

<imsi> Mandatory IMSI of the subscriber

<msisdn> Optional MSISDN of the subscriber

<newMsisdn> Optional New MSISDN that will be attached to the IMSI

<status> Optional The subscriber state values are in section 0

Flag to prohibit registration on VLR/SGSN without

<forbid_reg> Optional necessary camel phases support. Possible values:
0/1

<odb-param> Optional Operator determined barring data parameters. The

format is described in section 0

<pdp-data> Optional PDP context list. The format is described in section 0

<link-eps-data> Optional EPS context-id for addition or removal.

<eps-data> Optional EPS data. Format is described in section 0

<whiteListId> Conditional White list ids that will replace current list of ids

<whiteListsIdsToAdd> Conditional List of ids for addition to the current list

<whiteListsIdsToDelete Conditional List of ids for deletion from the current list
>

<blackListId> Conditional Black list ids that will replace current list of ids

Page 80 of 100
 User Guide HLR/HSS

Element/Attribute Mandatory Description

<blackListsIdsToAdd> Conditional List of ids for addition to the current list

<blackListsIdsToDelete Conditional List of ids for deletion from the current list
>

<csi-list> Optional List of CSI. Format is described in section 0

<ssData> Optional List of Supplementary Services and their parameters.

Format is described in section 0

List of Forwarding supplementary services and their

<ssForw> Optional
parameters. Format is described in section 0

List of Barring supplementary services and their

<ssBarring> Optional
parameters. Format is described in section 0

<teleserviceList> Optional List of Teleservices, that will replace subscriber’s

teleservices list

<teleservicesToAdd> Optional List of Teleservices, that will be added to subscriber’s

teleservices list

<teleservicesToDelete> Optional List of Teleservices, that will be deleted from

subscriber’s teleservices list

<bearerserviceList> Optional List of Bearerservices, that will replace subscriber’s

bearer service list

<bearerservicesToAdd> Optional List of Bearerrvices, that will be added to

subscriber’s bearer services list

<bearerservicesToDelet Optional List of Bearerrvices, that will be deleted from

e> subscriber’s bearer services list

<defaultForwNumber> Optional Default forwarding number

Default forwarding status value

<defaultForwStatus> Optional
(Activate(1)/deactivate(0))

<roamingNotAllowed> Optional (Activate(1)/deactivate(0))

<groupId> Optional GroupId to be assigned to a subscriber

<lcsId> Optional LCS profile id to be assigned to a subscriber

Reply
A "ProfileControl" reply format is given below.
{
“status” : “<status>”,
}

The response contains the following parameters:

Element/Attribute Mandatory Description

<status> Mandatory The statuses of the request is described in section 0

Page 81 of 100
 User Guide HLR/HSS

Get Profile (ProfileControl)

This command is used to fetch subscriber’s profile data from HLR/HSS.
Request
/ProfileService/GetProfile
POST request json data format (true (1) - data is requested, false(0) - data is not
requested):
{
“imsi” : “<imsi>”,
“msisdn” : “<msisdn>”,
“status” : “true/false”,
“forbid_reg” : “true/false”,
“pdp-data” : “true/false”,
“odb-param” : “true/false”,
“csi-list” “true/false”:
“ssData” : “true/false”,
“ssForw” : “true/false”,
“ssBarring” : “true/false”,
“teleserviceList” : “true/false”,
“bearerserviceList” : “true/false”,
“roaming-info” : “true/false”,
“roaming-sgsn-info” : “true/false”,
“defaultForw” : “true/false”
}

The request contains the following parameters:

Element/Attribute Mandatory Description

<imsi> Mandatory IMSI of the subscriber

<msisdn> Optional Subscriber’s MSISDN

<status> Optional 0/1

<tk> Optional 0/1

<group> Optional 0/1

<forbid_reg> Optional 0/1

<pdp-data> Optional 0/1

<eps-context-data> Optional 0/1

<eps-data> Optional 0/1

<odb-param> Optional 0/1

<csi-list> Optional 0/1

<ssData> Optional 0/1

<ssForw> Optional 0/1

<ssBarring> Optional 0/1

<lcs> Optional 0/1

<teleserviceList> Optional 0/1

<bearerserviceList> Optional 0/1

Page 82 of 100
 User Guide HLR/HSS

Element/Attribute Mandatory Description

<roaming-info> Optional 0/1

<roaming-sgsn- 0/1
Optional
info>

<defaultForw> Optional 0/1

<whiteLists> Optional 0/1

<blackLists> Optional 0/1

Reply
A "ProfileControl" reply format is given below.
{
“status” : “<status>”,
“imsi” : “<imsi>”,
“msisdn” : “<msisdn>”,
“administrative_state” : “<administrative_state>”,
“forbid_reg”: 0/1,
“ssData” : [ ],
“csi-list>” : [ ],
“ssBarring>” : [ ],
“ssForw>” : [ ],
“odb-param” : […],
“teleserviceList” : [..],
“bearerserviceList” : [..],
“roaming-info” : [..],
“roaming-sgsn-info” : [..],
“defaultForwNumber” : “<defaultForwNumber>”,
“defaultForwStatus” : “<defaultForwStatus>”
}

The response contains the following parameters:

Element/Attribute Mandatory Description

<status> Mandatory The status of the request

<imsi> Mandatory IMSI of the subscriber

<msisdn> Optional Subscriber’s MSISDN

<administrative_state> Optional Subscriber’s state

<forbid_reg> Optional Registration forbidden without camel flag

<odb-param> Optional The format is described in section 0

<csi-list> Optional The format is described in section 0

<ssData> Optional List of supplementary services. The format is

described in section 0

<ssForw> Optional List of forwarding supplementary services. The

format is described in section 0

<ssBarring> Optional List of barring supplementary services. The format

is described in section 0

<teleserviceList> Optional List of teleservices

<bearerserviceList> Optional List of bearerservices

Page 83 of 100
 User Guide HLR/HSS

Element/Attribute Mandatory Description

<lcsId> Optional Id of subscriber’s LCS profile

<tkId> Optional Id of transport key used to encrypt Ki in AUC

<groupId> Optional Id of group to which a subscriber belongs to

<pdp-data> List of subscriber’s GPRS PDP-Context and their

Optional
data

<eps-data> Optional Subscriber’s EPS parameters. See section 0

<eps-context-data> Optional Subscriber’s list of EPS context and their parameters

<roaming-info> Optional MSC/VLR Roaming information (see format below)

<roaming-sgsn-info> Optional SGSN/MME Roaming information (see format below)

<defaultForwNumber> Optional Default forwarding number

<defaultForwStatus> Optional Default forwarding status value (0/1)

<whiteLists> Optional Whitelists, that allow registration in selected PLMNs

<blackLists> Optional Whitelists, that forbid registration in selected PLMNs

<roaming-info>

Element/Attribute Mandatory Description

<vlr> Mandatory VLR GT

<dtregistred> Optional Registration date in java timestamp format

<ispurged> Optional Subscriber purged state flag

<dtpurged> Optional Purge date in java timestamp format

<roaming-sgsn-info>

Element/Attribute Mandatory Description

<sgsn> Mandatory SGSN GT

<dtregistred> Optional Registration date in java timestamp format

<ispurged> Optional Subscriber purged state flag

<dtpurged> Optional Purge date in java timestamp format

<dmMmeHost> Optional Diameter hostname of MME

<dmMmeRealm> Optional Diameter realm of MME

<is-purged-eps-mme> Optional Purged on MME flag

<dt-purged-eps-mme> Optional Date of purge on MME in java timestamp format

<is-purged-eps-sgsn> Optional Purge on EPS SGSN flag

<dt-purged-eps-sgsn> Optional Date of purge on EPS SGSN in java timestamp format

Page 84 of 100
 User Guide HLR/HSS

Change IMSI (Change IMSI)

This command is used for SIM swap operation, both new (imsi) and old (oldimsi) IMSI
should be provided into HLR/HSS before command is executed. All profile data including
MSISDN is transferred from “oldimsi” to to “imsi”. If a subscriber ( “oldimsi”) whose state has
been change from provided/unlocked state has active registration on VLR, SGSN or MME, it is
withdrawn by MAP or S6 Cancel location.
Request
/ProfileService/ChangeIMSI
POST request json data format:
{
“imsi” : “<imsi>”,
“oldimsi” : “<oldimsi>”,
“msisdn” : “<msisdn>”,
“status” : “<status>”
}

The request contains the following parameters:

Element/Attribute Mandatory Description

<imsi> Mandatory New IMSI

<oldimsi> Optional Old IMSI

<msisdn> Optional MSISDN

<status> Optional The subscriber state

0 - not provisioned
1 - provisioned/locked
2 - provisioned/unlocked
3 - provisioned/suspended
4 - terminated

Reply
A "ProfileControl" reply format is given below.
{
“status” : “<status>”,
}

The response contains following parameters:

Element/Attribute Mandatory Description

<status> Mandatory The status of the request

Page 85 of 100
 User Guide HLR/HSS

AddAndActivateEmptySubscribers
(/SubscriberService/AddAndActivateEmptySubscribers)
This command is used to upload a list of technical subscriptions into HSS for
organozation of SMS hub. MT SMS sent to a MSISDN from the list would be redirected to
SMSC GT (smsc parameter).
Request
/SubscriberService/AddAndActivateEmptySubscribers
POST request json data format:
{
"subscribers":[
{
"imsi": "$imsi",
"msisdn": "$msisdn",
"teleServices": "33",
"smsc": "$smsc"
},
…
{
"imsi": "$imsi",
"msisdn": "$msisdn",
"teleServices": "33",
"smsc": "$smsc"
}
]
}

The response contains the following parameters:

Element/Attribute Manda Description

tory

<subscriber Mandatory List of technical SMS HUB subscriptions. Multiple

s> subscriptions may be provided on time.

Element/Attribute Mandatory Description

<imsi> Mandatory IMSI

<msisdn> Optional MSISDN

<teleservices> Optional List of teleservices that will be provided to a

subscriber. It makes sense to provide MT SMS
teleservice (33) only for SMS Hub technical
subscriptions.

<smsc> Optional Global Title of SMSC which will receive MT SMS sent
to SMS Hub technical MSISDN.

Reply
Reply format
{
“status” : “<status>”,
}

The response contains the following parameters:

Element/Attribute Mandatory Description

<status> Mandatory The status of the request

Page 86 of 100
 User Guide HLR/HSS

Subscriber profile entries

ODB Parameters
A format for “Change Profile” is given below.
“odb-param” :
{
“general-list” : [<odbGeneral_0>,...<odbGeneral_28>],
“hplmn-list” : [<odbhplmn_0>,...<odbhplmn_3>],
“action” : “<action>”,
“SubscriberStatus” : “<SubscriberStatus>”
}

Element/Attribute Mandatory Description

<general-list> Optional List of ODB-General-Data (0-28)
<hplmn-list> Optional List of ODB-HPLMN-Data (0-3)
<action> Optional Activate(1)/deactivate(0)
<SubscriberStatus> Mandatory Service Granted(0) / ODB (1)

Reply

A "ProfileControl" reply format is given below.

“odb-param” :
{
“subscriber-status” : “<subscriber-status>”,
“general” : “<general>”,
“hplmn” : “<hplmn>”
}

Element/Attribute Mandatory Description

<subscriber-status> Mandatory Subscriber status (Service Granted(0) /
ODB (1) )
<general> Optional Binary-string in dec-format
<hplmn> Optional Binary-string in dec-format

Page 87 of 100
 User Guide HLR/HSS

CAMEL Parameters
A reply format for <csi-list> parameter is given below.
“csi-list” :
{
“type-id” : “<type-id>”,
“profile-id” : “<profile-id>”
}

Element/Attribute Mandatory Description

<type-id> Optional O-CSI - 0

T-CSI - 1
SMS-CSI - 2
GPRS-CSI -3
M-CSI -4

<profile-id>* Optional id of CSI-profile

* To delete CSI-PROFILE don't add <profile-id> to csi-list

SS Parameters
A reply format for the SS parameter is given below.
“ssData” :
{
“ss_Code” : “<ss_Code>”,
“ss_Status” : “<ss_Status>”,
“tele_service” : “<tele_service>”,
“bearer_service” : “<bearer_service>”,
“sub_option_type” : “<sub_option_type>”,
“sub_option” : “<sub_option>”

Element/Attribute Mandatory Description

<ss_Code> Optional Code of supplementary service (TS 29.002 17.7.5)

<ss_Status> Optional Status of supplementary service (GSM 03.11)

<tele_service> Optional Teleservice code (TS 29.002 17.7.9)

<bearer_service> Optional Bearerservice code (TS 29.002 17.7.10)

<sub_option_type> Optional 0=cliRestrictionOption/1=overrideCategory

Page 88 of 100
 User Guide HLR/HSS

Element/Attribute Mandatory Description

<sub_option> Optional For cliRestrictionOption:

0 - permanent
1 - temporaryDefaultRestricted
2- temporaryDefaultAllowed
for overrideCategory:
0 - overrideEnabled
1 - overrideDisabled

A reply format for ssForw parameter is given below.

“ssForw” :
{
“ss_Code” : “<ss_Code>”,
“ss_Status” : “<ss_Status>”,
“tele_service” : “<tele_service>”,
“bearer_service” : “<bearer_service>”,
“forwardedToNumber” : “<forwardedToNumber>”,
“forwardSubAddress” : “<forwardSubAddress>”,
“longforwardedToNumber” : “longforwardedToNumber”,
“forwardingOptions” : “forwardingOptions”,
“noReplyConditionTime” : “noReplyConditionTime”
}

Element/Attribute Mandatory Description

<ss_Code> Optional Code of supplementary service (TS 29.002

17.7.5)

<ss_Status> Optional Status of supplementary service (GSM 03.11)

<tele_service> Optional Teleservice code (TS 29.002 17.7.9)

<bearer_service> Optional Bearerservice code (TS 29.002 17.7.10)

<forwardedToNumber> Optional ForwardedToNumber

<forwardSubAddress> Optional forwardSubAddress

<longforwardedToNumber> Optional longforwardedToNumber

<forwardingOptions> Optional ForwardingOptions (TS 29.002 7.6.3.18, 17.5

Ext-ForwOptions)

<noReplyConditionTime> Optional NoReplyConditionTime value in seconds

A reply format for ssBarring parameter is given below.

“ssBarring” :
{
“ss_Code” : “<ss_Code>”,
“ss_Status” : “<ss_Status>”,
“tele_service” : “<tele_service>”,
“bearer_service” : “<bearer_service>”
}

Page 89 of 100
 User Guide HLR/HSS

Element/Attribute Mandatory Description

<ss_Code> Optional Code of supplementary service (TS 29.002

17.7.5)

<ss_Status> Optional Status of supplementary service (GSM 03.11)

<tele_service> Optional Teleservice code (TS 29.002 17.7.9)

<bearer_service> Optional Bearerservice code (TS 29.002 17.7.10)

PDP Parameters
The format of pdp-data parameter of /ProfileService/ProfileControl request is given
below.
"pdp-data": {
"context-id": <integer>,
"delete": <true/false>
}

Element/Attribute Mandatory Description

<context-id> Mandatory PDP context identifier. Context should exit in HLR

<delete> Optional true/false. False is default value. If this flag is set to

true, then context is deleted form subscriber's
profile.

The format of pdp-data parameter of /ProfileService/GetProfilel response is given

below.
"pdp-data": [
{
"pdpContextId": <integer>,
"pdpType": <hex>,
"pdpAddress": <hex>,
"qosSubscribed": <hex>,
"vplmnAddressAllowed": <0/1>,
"apn": <string>,
"extQosSubscribed": <hex>,
"pdpChargingCharacteristics": <hex>,
"extPdpAddress": <hex>,
"extPdpType": <hex>,
"ext2QosSubscribed": <hex>,
"ext3QosSubscribed": <hex>,
"ext4QosSubscribed": <hex>
}
]

Element/Attribute Mandatory Description

<pdpcontextId> Mandatory PDP context identifier.

<pdpType> Mandatory PDP type. Can be IPV4 – F121 , IPV6 – F157.

3GPP TS 23.060

Page 90 of 100
 User Guide HLR/HSS

Element/Attribute Mandatory Description

<pdpAddress> Optional Address of the data protocol. For dynamic

allocation it should be set to null.3GPP TS
23.060

<qosSubscribed> Mandatory Octets are coded according to TS 3GPP TS

24.008 Quality of Service Octets 3-5

<vplmnAddressAllowed Optional This parameter specifies whether the MS is

> allowed to use a dynamic address allocated in
the VPLMN. It is defined in 3GPP TS 23.060.
1 – Allowed
0 – Not allowed

<apn> Mandatory Access Point Name

<extQosSubscribed> Optional OCTET 1:

Allocation/Retention Priority (This octet encodes
each priority level defined in 23.107 as the
binary value of the priority level, declaration in
29.060)
Octets 2-9 are coded according to 3GPP TS
24.008 Quality of Service Octets 6-13

<pdpChargingCharacte Optional Octets are coded according to 3GPP TS 32.215

ristics>

<extPdpAddress> Optional This parameter indicates an additional address

of the data protocol, and it is included when the
PDP supports dual-stack (IPv4v6).
It is an extension to PDP-Address and it is
encoded in the same way. IPv4 or IPv6 address
types can be used in this parameter but, when
both parameters are present, each of them shall
contain different address types

<extPdpType> Optional Octets are coded, similarly to PDP-Type,

according to TS 3GPP TS 29.060.
Only the value IPv4v6 is allowed for this
parameter.

<ext2QosSubscribed> Optional Octets 1-3 are coded according to 3GPP TS

24.008 Quality of Service Octets 14-16.
If Quality of Service information is structured
with 14 octet length, then Octet 1 is coded
according to 3GPP TS 24.008 Quality of Service
Octet 14.

<ext3QosSubscribed> Optional Octets 1-2 are coded according to 3GPP TS

24.008 Quality of Service Octets 17-18.

<ext4QosSubscribed> Optional Octet 1:

Evolved Allocation/Retention Priority. This octet
encodes the Priority Level (PL), the Preemption
Capability (PCI) and Preemption Vulnerability
(PVI) values, as described in 3GPP TS 29.060.

Page 91 of 100
 User Guide HLR/HSS

EPS Parameters
A format for the epsData parameter of /SubscriberService/AddSubscriber request is
given nelow.
"epsData": {
"ueApnOiRep":"<string>",
"ueMaxDl":<integer>,
"ueMaxUl":<integer>,
"ratType":<integer>,
"ratFreqPriorId":<integer>,
"defContextId":<integer>
}

Element/Attribute Mandatory Description

<ueApnOiRep> Optional APN OI (APN Operator Identifier)

Replacement

<ueMaxDl> Optional Max Requested Bandwidth UL

<ueMaxUl> Optional Max Requested Bandwidth DL

<ratType> Optional Radio Access Technology Type:

1000 - UTRAN
1001 - GERAN
1004 - EUTRAN

<ratFreqPriorId> Optional RAT Frequency Selection Priority Id

<defContextId> Optional Default EPS context identifier (default APN

configuration). Default context should be
one of the subscriber's linked EPS contexts.
EPS context with wild card APN cannot de
default EPS context.

Page 92 of 100
 User Guide HLR/HSS

A format for the eps-context-data parameter of /SubscriberService/GetProfile

response is given below.
"eps-context-data": [
{
"id": <integer>,
"serviceSelection": "string",
"isAllowedDynamicAddress": <0/1>,
"staticIp4": <IPV4 address>,
"staticIp6": < IPV6 address>,
"qosClassId": <integer>,
"allocRetPriority": <integer>
"pdnGwType": <0/1r>,
"mip6ip4": null,
"mip6ip6": null,
"mip6AgentHost": null,
"mip6AgentRealm": null,
"visitedNetworkId": null,
"chargingCharacteristics": "<hex>",
"apnOiRep": <string>,
"maxDl": <integer>,
"maxUl": <integer>,
"pdnType": <integer>
}
]

Element/Attribute Mandatory Description

<id> Mandatory EPS context identifier. Value should be

greater then zero.

<serviceSelection> Mandatory The Service-Selection shall contain either the

APN Network Identifier (i.e. an APN without
the Operator Identifier) per 3GPP TS 23.003,
clauses 9.1 & 9.1.1, or it shall contain the
wild
card value per 3GPP TS 23.003, clause 9.2.1,
and 3GPP TS 23.008, clause 2.13.6).
The contents of the Service-Selection shall be
formatted as a character string composed of
one or more labels separated by dots ("."), or
as the wild card APN, i.e., consisting of only
one ASCII label, "*".

<isAllowedDynamicAddress> Optional Flag that shall indicate whether for this APN,
the UE is allowed to use the PDN GW in the
domain of the HPLMN only, or additionally,
the PDN GW in the domain of the VPLMN. If
value is not set, this means that the UE is not
allowed to use PDN GWs in the domain of the
VPLMN. The following values are defined:
NOTALLOWED (0)
ALLOWED (1)

<staticIp4> Optional Static IPv4 address allocated to the UE

Page 93 of 100
 User Guide HLR/HSS

<staticIp6> Optional Static IPv6 address allocated to the UE

<qosClassId> Optional QoS Class Identifier - a scalar that is used as

a reference to a specific packet forwarding
behaviour (e.g. packet loss rate, packet delay
budget) to be provided to a SDF.
Applicable values: 5 -9.
3GPP TS 23.203 Table 6.1.7
The values allowed for EPS are only those
associated to non-GBR bearers, as indicated
in 3GPP TS 23.008; e.g., values QCI_1,
QCI_2, QCI_3 and QCI_4, which are
associated to GBR bearers, cannot be used.

<allocRetPriority> Optional Defined in 3GPP TS 29.212

<pdnGwType> Optional Indicate whether the PDN GW address

included in MIP6-Agent-Info has been
statically allocated (i.e. provisioned in the
HSS by the operator), or dynamically selected
by
other nodes. The following values are
defined:
STATIC (0)
DYNAMIC (1)

<mip6ip4> Optional IPv4 address of the PDN-GW

<mip6ip6> Optional IPv6 address of the PDN-GW

<mip6AgentHost> Optional The hostname of the PDN-GW, formatted as

described in 3GPP TS 29.303, clause 4.3.2.

<mip6AgentRealm> Optional Destination-Realm of the PDN-GW formatted

as:
epc.mnc<MNC>.mcc<MCC>.3gppnetwork.or
g
where MNC and MCC values indicate the
PLMN where the PDN-GW is located.

<visitedNetworkId> Optional dentifies the PLMN in which the PDN GW is

located. It shall be
present when the PDN GW Identity is present
and does not contain an
FQDN.

<chargingCharacteristics> Optional EPS PDN Connection Charging Characteristics

data

<apnOiRep> Optional Domain name to replace the APN OI for the

non-roaming case and the home routed
roaming case when constructing the APN, and
the APN-FQDN upon which to perform a DNS
resolution. See 3GPP TS 23.003 and 3GPP TS
29.303.

Page 94 of 100
 User Guide HLR/HSS

The contents of the APN-OI-Replacement

shall be formatted as a character string
composed of one or more labels separated by
dots (".").

<maxDl> Optional Max Requested Bandwidth Dl

<maxUl> Optional Max Requested Bandwidth Ul

<pdnType> Optional Indicates the address type of the PDN, when

it is IP based. Possible values:
IPv4 (0)
IPv6 (1)
IPv4v6 (2)
IPv4_OR_IPv6 (3)

AUC Data
A format for the aucData parameter of /SubscriberService/AddSubscriber request is
given below.

"aucData": {
"opId":"<integer>",
"cId":<integer>,
"rId":<integer>,
"tkId":<integer>,
}

Element/Attribute Mandatory Description

<opId> Optional ID of the OP, \d

<cId> Optional C1..C5 ID, \d

<rId> Optional R1..R5 ID, \d

<tkId> Optional Transport Key ID, \d

Page 95 of 100
 User Guide HLR/HSS

Bearer Service Code

MAP-BS-Code {
itu-t identified-organization (4) etsi (0) mobileDomain (0)
gsm-Network (1) modules (3) map-BS-Code (20) version15 (15)}

DEFINITIONS

::=

BEGIN
BearerServiceCode ::= OCTET STRING (SIZE (1))
-- This type is used to represent the code identifying a single
-- bearer service, a group of bearer services, or all bearer
-- services. The services are defined in TS 3GPP TS 22.002 [3].
-- The internal structure is defined as follows:
--
-- plmn-specific bearer services:
-- bits 87654321: defined by the HPLMN operator

-- rest of bearer services:

-- bit 8: 0 (unused)
-- bits 7654321: group (bits 7654), and rate, if applicable
-- (bits 321)

Ext-BearerServiceCode ::= OCTET STRING (SIZE (1..5))

-- This type is used to represent the code identifying a single
-- bearer service, a group of bearer services, or all bearer
-- services. The services are defined in TS 3GPP TS 22.002 [3].
-- The internal structure is defined as follows:
--
-- OCTET 1:
-- plmn-specific bearer services:
-- bits 87654321: defined by the HPLMN operator
--
-- rest of bearer services:
-- bit 8: 0 (unused)
-- bits 7654321: group (bits 7654), and rate, if applicable
-- (bits 321)

-- OCTETS 2-5: reserved for future use. If received the

-- Ext-TeleserviceCode shall be
-- treated according to the exception handling defined for the
-- operation that uses this type.

-- Ext-BearerServiceCode includes all values defined for BearerServiceCode.

allBearerServices BearerServiceCode ::= '00000000'B

allDataCDA-Services BearerServiceCode ::= '00010000'B

dataCDA-300bps BearerServiceCode ::= '00010001'B
dataCDA-1200bps BearerServiceCode ::= '00010010'B
dataCDA-1200-75bps BearerServiceCode ::= '00010011'B
dataCDA-2400bps BearerServiceCode ::= '00010100'B
dataCDA-4800bps BearerServiceCode ::= '00010101'B
dataCDA-9600bps BearerServiceCode ::= '00010110'B
general-dataCDA BearerServiceCode ::= '00010111'B

allDataCDS-Services BearerServiceCode ::= '00011000'B

dataCDS-1200bps BearerServiceCode ::= '00011010'B
dataCDS-2400bps BearerServiceCode ::= '00011100'B
dataCDS-4800bps BearerServiceCode ::= '00011101'B
dataCDS-9600bps BearerServiceCode ::= '00011110'B
general-dataCDS BearerServiceCode ::= '00011111'B

allPadAccessCA-Services BearerServiceCode ::= '00100000'B

padAccessCA-300bps BearerServiceCode ::= '00100001'B
padAccessCA-1200bps BearerServiceCode ::= '00100010'B
padAccessCA-1200-75bps BearerServiceCode ::= '00100011'B
padAccessCA-2400bps BearerServiceCode ::= '00100100'B
padAccessCA-4800bps BearerServiceCode ::= '00100101'B
padAccessCA-9600bps BearerServiceCode ::= '00100110'B
general-padAccessCA BearerServiceCode ::= '00100111'B

Page 96 of 100
 User Guide HLR/HSS

allDataPDS-Services BearerServiceCode ::= '00101000'B

dataPDS-2400bps BearerServiceCode ::= '00101100'B
dataPDS-4800bps BearerServiceCode ::= '00101101'B
dataPDS-9600bps BearerServiceCode ::= '00101110'B
general-dataPDS BearerServiceCode ::= '00101111'B

allAlternateSpeech-DataCDA BearerServiceCode ::= '00110000'B

allAlternateSpeech-DataCDS BearerServiceCode ::= '00111000'B

allSpeechFollowedByDataCDA BearerServiceCode ::= '01000000'B

allSpeechFollowedByDataCDS BearerServiceCode ::= '01001000'B

-- The following non-hierarchical Compound Bearer Service

-- Groups are defined in TS 3GPP TS 22.030:
allDataCircuitAsynchronous BearerServiceCode ::= '01010000'B
-- covers "allDataCDA-Services", "allAlternateSpeech-DataCDA" and
-- "allSpeechFollowedByDataCDA"
allAsynchronousServices BearerServiceCode ::= '01100000'B
-- covers "allDataCDA-Services", "allAlternateSpeech-DataCDA",
-- "allSpeechFollowedByDataCDA" and "allPadAccessCDA-Services"
allDataCircuitSynchronous BearerServiceCode ::= '01011000'B
-- covers "allDataCDS-Services", "allAlternateSpeech-DataCDS" and
-- "allSpeechFollowedByDataCDS"
allSynchronousServices BearerServiceCode ::= '01101000'B
-- covers "allDataCDS-Services", "allAlternateSpeech-DataCDS",
-- "allSpeechFollowedByDataCDS" and "allDataPDS-Services"
--
-- Compound Bearer Service Group Codes are only used in call
-- independent supplementary service operations, i.e. they
-- are not used in InsertSubscriberData or in
-- DeleteSubscriberData messages.

allPLMN-specificBS BearerServiceCode ::= '11010000'B

plmn-specificBS-1 BearerServiceCode ::= '11010001'B
plmn-specificBS-2 BearerServiceCode ::= '11010010'B
plmn-specificBS-3 BearerServiceCode ::= '11010011'B
plmn-specificBS-4 BearerServiceCode ::= '11010100'B
plmn-specificBS-5 BearerServiceCode ::= '11010101'B
plmn-specificBS-6 BearerServiceCode ::= '11010110'B
plmn-specificBS-7 BearerServiceCode ::= '11010111'B
plmn-specificBS-8 BearerServiceCode ::= '11011000'B
plmn-specificBS-9 BearerServiceCode ::= '11011001'B
plmn-specificBS-A BearerServiceCode ::= '11011010'B
plmn-specificBS-B BearerServiceCode ::= '11011011'B
plmn-specificBS-C BearerServiceCode ::= '11011100'B
plmn-specificBS-D BearerServiceCode ::= '11011101'B
plmn-specificBS-E BearerServiceCode ::= '11011110'B
plmn-specificBS-F BearerServiceCode ::= '11011111'B

END

Page 97 of 100
 User Guide HLR/HSS

Teleservice
MAP-TS-Code {
itu-t identified-organization (4) etsi (0) mobileDomain (0)
gsm-Network (1) modules (3) map-TS-Code (19) version15 (15)}

DEFINITIONS

::=

BEGIN

TeleserviceCode ::= OCTET STRING (SIZE (1))

-- This type is used to represent the code identifying a single
-- teleservice, a group of teleservices, or all teleservices. The
-- services are defined in TS GSM 22.003 [4].
-- The internal structure is defined as follows:

-- bits 87654321: group (bits 8765) and specific service

-- (bits 4321)

Ext-TeleserviceCode ::= OCTET STRING (SIZE (1..5))

-- This type is used to represent the code identifying a single
-- teleservice, a group of teleservices, or all teleservices. The
-- services are defined in TS GSM 22.003 [4].
-- The internal structure is defined as follows:

-- OCTET 1:
-- bits 87654321: group (bits 8765) and specific service
-- (bits 4321)

-- OCTETS 2-5: reserved for future use. If received the

-- Ext-TeleserviceCode shall be
-- treated according to the exception handling defined for the
-- operation that uses this type.

-- Ext-TeleserviceCode includes all values defined for TeleserviceCode.

allTeleservices TeleserviceCode ::= '00000000'B

allSpeechTransmissionServices TeleserviceCode ::= '00010000'B

telephony TeleserviceCode ::= '00010001'B
emergencyCalls TeleserviceCode ::= '00010010'B

allShortMessageServices TeleserviceCode ::= '00100000'B

shortMessageMT-PP TeleserviceCode ::= '00100001'B
shortMessageMO-PP TeleserviceCode ::= '00100010'B

allFacsimileTransmissionServices TeleserviceCode ::= '01100000'B

facsimileGroup3AndAlterSpeech TeleserviceCode ::= '01100001'B
automaticFacsimileGroup3 TeleserviceCode ::= '01100010'B
facsimileGroup4 TeleserviceCode ::= '01100011'B

-- The following non-hierarchical Compound Teleservice Groups

-- are defined in TS 3GPP TS 22.030:
allDataTeleservices TeleserviceCode ::= '01110000'B
-- covers Teleservice Groups 'allFacsimileTransmissionServices'
-- and 'allShortMessageServices'
allTeleservices-ExeptSMS TeleserviceCode ::= '10000000'B
-- covers Teleservice Groups 'allSpeechTransmissionServices' and
-- 'allFacsimileTransmissionServices'
--
-- Compound Teleservice Group Codes are only used in call
-- independent supplementary service operations, i.e. they
-- are not used in InsertSubscriberData or in
-- DeleteSubscriberData messages.

allVoiceGroupCallServices TeleserviceCode ::= '10010000'B

voiceGroupCall TeleserviceCode ::= '10010001'B
voiceBroadcastCall TeleserviceCode ::= '10010010'B

Page 98 of 100
 User Guide HLR/HSS

allPLMN-specificTS TeleserviceCode ::= '11010000'B

plmn-specificTS-1 TeleserviceCode ::= '11010001'B
plmn-specificTS-2 TeleserviceCode ::= '11010010'B
plmn-specificTS-3 TeleserviceCode ::= '11010011'B
plmn-specificTS-4 TeleserviceCode ::= '11010100'B
plmn-specificTS-5 TeleserviceCode ::= '11010101'B
plmn-specificTS-6 TeleserviceCode ::= '11010110'B
plmn-specificTS-7 TeleserviceCode ::= '11010111'B
plmn-specificTS-8 TeleserviceCode ::= '11011000'B
plmn-specificTS-9 TeleserviceCode ::= '11011001'B
plmn-specificTS-A TeleserviceCode ::= '11011010'B
plmn-specificTS-B TeleserviceCode ::= '11011011'B
plmn-specificTS-C TeleserviceCode ::= '11011100'B
plmn-specificTS-D TeleserviceCode ::= '11011101'B
plmn-specificTS-E TeleserviceCode ::= '11011110'B
plmn-specificTS-F TeleserviceCode ::= '11011111'B

END

Page 99 of 100
 User Guide HLR/HSS

Supplementary service codes

SS-Code ::= OCTET STRING (SIZE (1))
-- This type is used to represent the code identifying a single
-- supplementary service, a group of supplementary services, or
-- all supplementary services. The services and abbreviations
-- used are defined in TS GSM 02.04. The internal structure is
-- defined as follows:
--
-- bits 87654321: group (bits 8765), and specific service
-- (bits 4321)

allSS SS-Code ::= '00000000'B

-- reserved for possible future use
-- all SS

allLineIdentificationSS SS-Code ::= '00010000'B

-- reserved for possible future use
-- all line identification SS
clip SS-Code ::= '00010001'B
-- calling line identification presentation
clir SS-Code ::= '00010010'B
-- calling line identification restriction
colp SS-Code ::= '00010011'B
-- connected line identification presentation
colr SS-Code ::= '00010100'B
-- connected line identification restriction
mci SS-Code ::= '00010101'B
-- reserved for possible future use
-- malicious call identification

allNameIdentificationSS SS-Code ::= '00011000'B

-- all name identification SS
cnap SS-Code ::= '00011001'B
-- calling name presentation

-- SS-Codes '00011010'B to '00011111'B are reserved for future

-- NameIdentification Supplementary Service use.

allForwardingSS SS-Code ::= '00100000'B

-- all forwarding SS
cfu SS-Code ::= '00100001'B
-- call forwarding unconditional
allCondForwardingSS SS-Code ::= '00101000'B
-- all conditional forwarding SS
cfb SS-Code ::= '00101001'B
-- call forwarding on mobile subscriber busy
cfnry SS-Code ::= '00101010'B
-- call forwarding on no reply
cfnrc SS-Code ::= '00101011'B
-- call forwarding on mobile subscriber not reachable
cd SS-Code ::= '00100100'B
-- call deflection

allCallOfferingSS SS-Code ::= '00110000'B

-- reserved for possible future use
-- all call offering SS includes also all forwarding SS
ect SS-Code ::= '00110001'B
-- explicit call transfer
mah SS-Code ::= '00110010'B
-- reserved for possible future use
-- mobile access hunting

Page 100 of 100