411-2831-331.01.05 gsm / umts hlr mobile subscriber...

411-2831-331

GSM / UMTS

HLRMobile Subscriber Provisioning Guide

GSM NSS18 / UMTS VCN04 Standard 01.05 April 2006

Whats inside...This document provides V14.0 of the Mobile Subscriber Provisioning (MSP)

specification.

You will find a description of the Operation and Support System (OSS) interface between the mobile Subscription Administration Centre (AdC) and an HLR.

This interface is used for subscriber administration via an SDM-based HLR Provisioning Server (HLR-PS) or the HLR Provisioning Manager (HLR-PM) on an HLR200 Data Server.

You will also find syntax definitions and Mobile Subscriber Provisioning (MSP) protocol syntax for subscripton administration.

GSM / UMTS

HLRMobile Subscriber Provisioning Guide

Document number: 411-2831-331Product release: GSM NSS18 / UMTS VCN04Document version: Standard 01.05 Date: April 2006

Copyright Country of printing Confidentiality Legal statements Trademarks

Copyright 19962006 Nortel, All Rights Reserved

Printed in the United States of America/Canada

NORTEL CONFIDENTIAL

The information contained herein is the property of Nortel and is strictly confidential. Except as expressly authorized in writing by Nortel, the holder shall keep all information contained herein confidential, shall disclose it only to its employees with a need to know, and shall protect it, in whole or in part, from disclosure and dissemination to third parties with the same degree of care it uses to protect its own confidential information, but with no less than reasonable care. Except as expressly authorized in writing by Nortel, the holder is granted no rights to use the information contained herein.

Information is subject to change without notice. Nortel reserves the right to make changes in design or components as progress in engineering and manufacturing may warrant.

* Nortel, the Nortel logo, the Globemark, and Unified Networks are trademarks of Nortel. 3rd Party Trademark A-N Additional 3rd party trademark A-N 3rd Party Trademark O-Z Additional 3rd party trademark O-Z Trademarks are acknowledged with an asterisk (*) at their first appearance in the document.

ivNortel Confidential Copyright 19962006 Nortel

The following apply to components or elements used in the GEM load and are used by permission of the respective owners.

Copyright notice/license for Perl

Preamble

The intent of this document is to state the conditions under which a Package may be copied, such that the Copyright Holder maintains some semblance of artistic control over the development of the package, while giving the users of the package the right to use and distribute the Package in a more-or-less customary fashion, plus the right to make reasonable modifications.

Definitions:

Package refers to the collection of files distributed by the Copyright Holder, and derivatives of that collection of files created through textual modification.

Standard Version refers to such a Package if it has not been modified, or has been modified in accordance with the wishes of the Copyright Holder as specified below.

Copyright Holder is whoever is named in the copyright or copyrights for the package.

You is you, if you're thinking about copying or distributing this Package.

Reasonable copying fee is whatever you can justify on the basis of media cost, duplication charges, time of people involved, and so on. (You will not be required to justify it to the Copyright Holder, but only to the computing community at large as a market that must bear the fee.)

Freely Available means that no fee is charged for the item itself, though there may be fees involved in handling the item. It also means that recipients of the item may redistribute it under the same conditions they received it.1. You may make and give away verbatim copies of the source form of the

Standard Version of this Package without restriction, provided that you duplicate all of the original copyright notices and associated disclaimers.

2. You may apply bug fixes, portability fixes and other modifications derived from the Public Domain or from the Copyright Holder. A Package modified in such a way shall still be considered the Standard Version.

3. You may otherwise modify your copy of this Package in any way, provided that you insert a prominent notice in each changed file stating how and when you changed that file, and provided that you do at least ONE of the following:

411-2831-331 Standard 01.05 April 2006

vNortel Confidential Copyright 19962006 Nortel

a. place your modifications in the Public Domain or otherwise make them Freely Available, such as by posting said modifications to Usenet or an equivalent medium, or placing the modifications on a major archive site such as uunet.uu.net, or by allowing the Copyright Holder to include your modifications in the Standard Version of the Package.

b. use the modified Package only within your corporation or organization.

c. rename any non-standard executables so the names do not conflict with standard executables, which must also be provided, and provide a separate manual page for each non-standard executable that clearly documents how it differs from the Standard Version.

d. make other distribution arrangements with the Copyright Holder.4. You may distribute the programs of this Package in object code or

executable form, provided that you do at least ONE of the following:a. distribute a Standard Version of the executables and library files,

together with instructions (in the manual page or equivalent) on where to get the Standard Version.

b. accompany the distribution with the machine-readable source of the Package with your modifications.

c. give non-standard executables non-standard names, and clearly document the differences in manual pages (or equivalent), together with instructions on where to get the Standard Version.

d. make other distribution arrangements with the Copyright Holder.5. You may charge a reasonable copying fee for any distribution of this

Package. You may charge any fee you choose for support of this Package. You may not charge a fee for this Package itself. However, you may distribute this Package in aggregate with other (possibly commercial) programs as part of a larger (possibly commercial) software distribution provided that you do not advertise this Package as a product of your own. You may embed this Package's interpreter within an executable of yours (by linking); this shall be construed as a mere form of aggregation, provided that the complete Standard Version of the interpreter is so embedded.

6. The scripts and library files supplied as input to or produced as output from the programs of this Package do not automatically fall under the copyright of this Package, but belong to whoever generated them, and may be sold commercially, and may be aggregated with this Package. If such scripts or library files are aggregated with this Package via the so-called "undump" or "unexec" methods of producing a binary executable image, then distribution of such an image shall neither be construed as a distribution of this Package nor shall it fall under the restrictions of

GSM / UMTS HLR Mobile Subscriber Provisioning Guide GSM NSS18 / UMTS VCN04

viNortel Confidential Copyright 19962006 Nortel

Paragraphs 3 and 4, provided that you do not represent such an executable image as a Standard Version of this Package.

7. C subroutines (or comparably compiled subroutines in other languages) supplied by you and linked into this Package in order to emulate subroutines and variables of the language defined by this Package shall not be considered part of this Package, but are the equivalent of input as in Paragraph 6, provided these subroutines do not change the language in any way that would cause it to fail the regression tests for the language.

8. Aggregation of this Package with a commercial distribution is always permitted provided that the use of this Package is embedded; that is, when no overt attempt is made to make this Package's interfaces visible to the end user of the commercial distribution. Such use shall not be construed as a distribution of this Package.

9. The name of the Copyright Holder may not be used to endorse or promote products derived from this software without specific prior written permission.

10. This package is provided as is and without any express or implied warranties, including, without limitation, the implied warranties of merchantability and fitness for a particular purpose.

The standard version of the Perl interpreter is obtained from the following link:

http://www.perl.com/pub/a/language/info/software.html

Copyright notice/license for Zlib library for data compression

(C) 1995-1998 Jean-loup Gailly and Mark Adler

This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.

Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:1. The origin of this software must not be misrepresented; you must not

claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.

2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.

3. This notice may not be removed or altered from any source distribution.

411-2831-331 Standard 01.05 April 2006

viiNortel Confidential Copyright 19962006 Nortel

Jean-loup Gailly: [email protected]

Mark Adler: [email protected]


viii Publication historyNortel Confidential Copyright 19962006 Nortel

411-2831-331 Standard 01.05 April 2006

Publication historyApril 2006

GSM18.0/UMTS04, 01.05, Standard release.

October 2005GSM18.0/UMTS04, 01.04, Standard release.

September 2005GSM18.0/UMTS04, 01.03. This version of the document is issued for the second preliminary release of the Nortel HLR200 solution (NSS18).

March 2005GSM18.0/UMTS04, 01.02. This is the first version of this document for the preliminary release of the Nortel HLR200 solution (NSS18).

November 2004GSM18.0/UMTS04, 01.01. This is the first draft of this document for the preliminary release of the Nortel HLR200 solution (NSS18).

Contents ixNortel Confidential Copyright 19962006 Nortel

\Contents 1

About this document xvChanges from MSP v13.0 xvOrganization of this document xvAudience xviSoftware release applicability xvi

GSM18/UMTS04 Product Computing Module Loads xviiIndication of hypertext links xviiRelated documents xvii

Chapter 1: Introduction to MSP and command syntax 19Syntax conventions 20MSP command formats 21

MSP request formats 22MSP response formats 23

Common Definitions 24Provisioning Identifier 24SIMR Provisioning 26DES Encryption of Ki 26

Chapter 2: Provisioning Commands 29Define a Subscriber (DFSB) 30Modify Subscriber Data (MDSB) 32Display Subscriber Data (DPSB) 34Delete Subscriber (DESB) 36Modify or Add Subscription Data (MDSN) 38

MDSN Data Replacement and Data Merging Examples 39Delete a Subscription (DESN) 41Display Subscription (DPSN) 42Modify SIMR information (MDSR) 46Display SIMR information (DPSR) 48Delete SIMR information (DESR) 50Translate (TRAN) 51

Chapter 3: Provisioning Subscriber Data 53Provisioning and deprovisioning status 53Registering and deregistering services against Basic Service Groups 55

Registering 55Deregistering 56Mixed registration and deregisteration 57

Special cases and shorthands 57Basic Service provisioning shorthand 57Basic Service Group-based Supplementary Service Shorthand 57

Common sections 58


x ContentsNortel Confidential Copyright 19962006 Nortel

Subscription data syntax 59Basic Service Groups 66

Account Code (ACC) 68Advice of charge (AOCC) 70Advice of charge information (AOCI) 71Alternate Speech and Data (CDA) (BS61A) 72Alternate Speech and Data (CDS) (BS61S) 74Alternate Speech and Fax group 3 (TS61) 76Anonymous Call Rejection (ACRJ) 78Automatic Facsimile group 3 (TS62) 79Auxiliary Telephony (TSD1) 81Barring of All Incoming Calls (BAIC) 83Barring of All Outgoing Calls (BAOC) 86Barring of Incoming Calls while Roaming outside of Home Country (BICROAM) 89Barring of Outgoing International Calls (BOIC) 91Barring of Outgoing International Calls EXcept to the Home Country (BOICEXHC) 93Call Forwarding Busy (CFB) 95Call Forwarding Not Reachable (CFNRC) 98Call Forwarding on No Reply (CFNRY) 101Call Forwarding Unconditional (CFU) 105Call Hold (HOLD) 108Calling Line Identification Number (CLIN) 109Calling Line Identification Presentation (CLIP) 110Calling Line Identification Restriction (CLIR) 112Calling Name Delivery (CNAM) 114Call Session Related External Client List (CSRECL) 115Call Session Related eXtended External Client List (CSRXECL) 117Call Session Unrelated eXtended External Client List (CSUXECL) 119Call Waiting (CW) 121Category (CAT) 123Circuit Data Asynchronous (BS20) 126Circuit Data Asynchronous 300, CDA 300 (BS21) 128Circuit Data Asynchronous 1200, CDA 1200 (BS22) 130Circuit Data Asynchronous 1200/75, CDA 1200-75 (BS23) 132Circuit Data Asynchronous 2400, CDA 2400 (BS24) 134Circuit Data Asynchronous 4800, CDA 4800 (BS25) 136Circuit Data Asynchronous 9600, CDA 9600 (BS26) 138Circuit Data Asynchronous General Bearer Service, CDAGBS (BS20G) 140Circuit Duplex Synchronous, CDS (BS30) 142Circuit Duplex Synchronous General Bearer Service, CDSGBS (BS30G) 144Circuit Duplex Synchronous General Bearer Service 1200, CDS 1200(BS31) 146Circuit Duplex Synchronous General Bearer Service 2400, CDS 2400 (BS32) 148Circuit Duplex Synchronous General Bearer Service 4800, CDS 4800 (BS33) 150Circuit Duplex Synchronous General Bearer Service 9600, CDS 9600 (BS34) 152Class Of Service (COS) 154Closed User Group (CUGSUB) 156Closed User Group (feature data) (CUG) 160Connected Line Identification Presentation (COLP) 163Connected Line Identification Restriction (COLR) 165Control of Incoming Barring (BICCTRL) 166

411-2831-331 Standard 01.05 April 2006

Contents xiNortel Confidential Copyright 19962006 Nortel

Control of Outgoing Barring (BOCCTRL) 167Current VLR Number (CVLR) 168Current SGSN Number (SGSN) 169Customized Applications for Mobile network Enhanced Logic (CAML) 170Dialled CAMEL Subscriber Information (DCSI) 176Enhanced Multi-Level Precedence and Pre-Emption (eMLPP) 179Explicit Call Transfer (ECT) 181Extension (EXT) 182Follow Me (FM) 185General Packet Radio Service (GPRSCNTX) 187GPRS CAMEL Subscriber Information (GCSI) 190Hot Billing (HOTBILL) 193Local Calls Only (LCO) 195Location Measurement Unit (LMU) 196Location Services (LCS) 197Mobility Management CAMEL Subscription Information (MCSI) 203Malicious Call Trace (MCT) 205Multiparty (MPTY) 206Network Access Mode (NAM) 208ODB of all Explicit Call Transfer (ODBAECT) 210ODB of Call Independent Supplementary Services Management (ODBCISSMGT) 211Operator Determined Barring of Conditional Call Forwarding Management (ODBCCFMGT) 212Operator Determined Barring Of Explicit Call Transfer (ODBCHDECT) 213Operator Determined Barring of Incoming Calls (ODBI) 214Operator Determined Barring of International Explicit Call Transfer (ODBINTECT) 216Operator Determined Barring of Outgoing calls (ODBO) 218ODB of Outgoing Premium rate calls (Entertainment) (ODBOPRENT) 219ODB of Outgoing Premium rate calls (Information) (ODBOPRINFO) 221Operator Determined Barring for operator specific barring type 1 (ODBHPLMN1) 222Operator Determined Barring for operator specific barring type 2 (ODBHPLMN2) 223Operator Determined Barring for operator specific barring type 3 (ODBHPLMN3) 224Operator Determined Barring for operator specific type 4 (ODBHPLMN4) 225Operator Determined Barring of Explicit Call Transfer (when both calls are charged to the served subscriber) (ODBDBCECT) 226Originating IN index (INORIG) 227Originating Trigger Detection Point Criteria for DP2 CAMEL Phase 2 (OTDP22) 228Originating Trigger Detection Point Criteria for DP2 CAMEL Phase 3 (OTDP23) 232Originating Trigger Detection Point Criteria for DP4 CAMEL Phase 3 (OTDP43) 236PassWorD (PWD) 238Primary Interexchange Carrier (PIC) 239Roaming Entitlement (ROAMENT) 240Short Message MT/PP (TS21) 241Short Message MO/PP (TS22) 243Short Message Service CAMEL Subscriber Information (SMSCSI) 245Speech followed by Data (CDA) (BS81A) 248


xii ContentsNortel Confidential Copyright 19962006 Nortel

Speech followed by Data (CDS) (BS81S) 250Subscriber Service Status (ISTATUS) 252Supplementary Service CAMEL Subscription Information (SCSI) 254Supplementary Service Option for CFNRC (SOCFNRC) 256Supplementary Service Option for CFB (SOCFB) 258Supplementary Service Option for CFNRY (SOCFNRY) 261Supplementary Option for CFU (SOCFU) 264Suppression of Announcements to Called Party (SOAPROV) 266Telephony (TS11) 267Terminating IN index (INTERM) 269Terminating Trigger Detection Point Criteria (TTDP) 270Unstructured Supplementary Service Data Camel Subscription Information (UCSI) 272User to User Signalling Service, Type 1 (UUS1) 274Voice Broadcast Service (VBS) 275Voice Broadcast Service Group (VBSGRP) 276Voice Group Call Service (VGCS) 278Voice Group Call Service Group (VGCSGRP) 279Wireless Priority Service (WPS) 281

Chapter 4: MSP Data Link Protocol 283Transmission of data 283

Physical connectivity 283Loss of connection 283Transmission order 284

Message formats 284Ordering within messages 286Tag, usage and rules 286Message length, usage and rules 286Device ID, usage and rules 287CRC-Algorithm 287Reception of a message 288

Request and Response Sequencing 290Data Link Sessions 291

Logon and Logoff 291NULL Communication Messages 291ENID - Log-On Command 292CAID - Log-Off Command 295NULL - Null Message 296CNCL - Cancel Provisioning Request 297Session timers - auto-logoff timer 297Session timers - keep alive timer 298

Data Link Queuing 299Data-link acknowledgment scheme 299Procedure at the AdC 300Procedure at the HLR-PS 302Examples 304Holding provisioning requests 314Cancelling a Provisioning Request 315

Reliable Transmission on the Data Link 317

411-2831-331 Standard 01.05 April 2006

Contents xiiiNortel Confidential Copyright 19962006 Nortel

Session and Queueing messages 317Provisioning request messages 321Examples 323Interaction between session, queueing and provisioning Messages 329

Chapter 5: MSP Bulk File Format 331File format 333

Cyclic redundancy check 335Example bulk files 336

File naming convention 338File name examples 338

File rejection 340

Chapter 6: MSP Audit File Format 341Audit File format version 1 341Audit File format version 2 343Generation of audit records 345Audit records when using a Provisioning Gateway 345Audit records on a Data Server 348

Audit records for MSP messages received from a Data Server 349

Appendix A: Changes from MSP v13.0 351Provisioning Layer 351Data Link Layer 352Bulk file format 352

Appendix B: MSP Developers Guide 353Bulk Subscriber Provisioning (BSP) 353

BSP Record Separator 353BSP File Checksum 353Syntax errors versus provisioning layer errors 354

MSP audit 354MSP data link over TCP/IP 354

MSP Provisioning 354HLR database 354Subscriber versus Subscription 355Basic Services and Basic Service Groups 355Supplementary Services 355Creating a Subscriber 356Deleting a Subscriber 357Modifying a Subscription 357Displaying a Subscription 360Deleting a Subscription 361Error Handling 361Provisioning Scenarios 361Pre-allocation using BSP 361

Appendix C: Message Response Codes 363


xiv ContentsNortel Confidential Copyright 19962006 Nortel

List of terms and abbreviations 377

411-2831-331 Standard 01.05 April 2006

xvNortel Confidential Copyright 19962006 Nortel

About this document 2This document describes the subscription administration interface between the Mobile Subscription Administration Centre (AdC) towards an HLR. The interface can operate via an SDM-based HLR Provisioning Server (HLR-PS) or via the HLR Provisioning Manager (HLR-PM) on a Data Server.

This publication is the specification for the Operation and Support System (OSS) interface for subscription administration, as defined by the Mobile Subscriber Provisioning (MSP) protocol.

MSP defines a syntax for subscription administration. This information can be carried in three ways:

On a transaction basis over a data connection (see Chapter 4: MSP Data Link Protocol),

As part of a file transfer submitted for batch processing (see Chapter 5: MSP Bulk File Format),

As part of audit file which records processed transactions (see Chapter 6: MSP Audit File Format)

Changes from MSP v13.0 2Refer to Appendix A in this document.

Organization of this document 2

To find: See chapter:

Overview of this document, the audience and related documents

About this document

MSP provisioning command formats, syntax conventions and common definions

Chapter 1

Syntax and examples of MSP commands

Chapter 2


xvi About this documentNortel Confidential Copyright 19962006 Nortel

Audience 2This specification is intended for HLR100/200 customers and system end-users involved in administering subscription data.

It is assumed that the reader has a general knowledge of the GSM standard.

Software release applicability 2Nortel software releases for the Wireless product are developed and identified by the product lines. The GSM product line software is identified by the letters GSM and a 2-digit number, such as GSM18, signifying the current release in the GSM software stream.

This publication is applicable to the DMS-MSC Family offices that have the GSM NSS18/UMTS VCN04 software release. Unless this publication is revised, it also applies to offices that have software releases greater than GSM NSS18/UMTS VCN04

Customers must be running on NSS16 or NSS17 before they can upgrade to NSS18. Since there is no GSM-R support on the MSC in NSS18, customers on GSM-R NSS17 will not upgrade to NSS18. Customers on NSS16/UMTS03 for the MSC, must upgrade to NSS18/UMTS04. In the GSM market, 3GPP R99 and R4 are supported in NSS18. In the UMTS market, only 3GPP R99 is supported in NSS18.

For more information about the new features contained in the GSM NSS18/UMTS VCN04 software release, refer to GSM NSS/UMTS VCN Call Server Software Delta, 411-2231-199, and GSM NSS/UMTS VCN DMS-HLR Software Delta, 411-2831-199.

Subscriber data format for provisioning services

Chapter 3

How MSP provisioning layer information is passed between the Administration Centre and HLR-PS using data link protocol

Chapter 4

How to use MSP within Bulk Service Provisioning (BSP) files

Chapter 5

Audit files available on the HLR core Chapter 6

Changes from earlier releases Appendix A

Further information on developing provisioning using MSP

Appendix B

Message response codes Appendix C

To find: See chapter:

411-2831-331 Standard 01.05 April 2006

About this document xviiNortel Confidential Copyright 19962006 Nortel

GSM18/UMTS04 Product Computing Module LoadsThe NSS software load consists of GSM18 (MSC & HLR), GEM18 (SDM & CEM), and MG18 (Media Gateway) software.

Before GSM05, software loads were package-based loads. GSM05 was the first DMS-MSC Product Computing Module Load (PCL). PCLs are composed of layers of software, or Delivery Receivable Units (DRUs).

The following PCLs comprise the NSS18 software load:

DMS CSP20 (BASE21, TL20, SHR20) XPM20 CBM18 USP10.0 SN07 Passport v3.7 SP20 (North America market) SP17.2 (International market) Media Gateway (MG) PCR6.1 GSM18/UMTS04 DRUs

Indication of hypertext links 2Hypertext links in this document are indicated in blue. If viewing a PDF version of this document, click on the blue text to jump to the associated section or page.

Related documents 2

Although a basic introduction to GSM services is included here, detailed information, such as service interactions, is beyond the scope of this document.

HLR-PS File Transfer Specification Version 1.3 Release: OMC07GSM /UMTS Voice Core Network HLR-PS OA&M Manual

NTP 411-4831-550 Release: NSS18

SDM Installation Method for GEM18 IM 24-9029 Release: GEM18GSM /UMTS Voice Core Network HLR-PS OA&M Manual


GSM /UMTS Voice Core Network HLR-PS OA&M Manual



xviii About this documentNortel Confidential Copyright 19962006 Nortel

For more information, see DMS-HLR Nortel Telecom Practice (NTP) documents, particularly the HLR data schema which provides descriptions of the following tables:

GHLRAUTH (AUC entries) GHLRDATA (General subscriber data) GHLRBSVC (Basic services) GHLRSSOP (Supplementary services) GHLRCUG (CUG data) GHLREA (Equal access) GHLRSIMR (SIM replacement) GHLRCAML (CAMEL) GHLRGPRS (GPRS PDP contexts) GHLRVGS (VBS and VGCS group provisioning for GSM Railways) GHLRUCSI (USSD CSI) GHLRSCSI (Supplementary Service CSI) GHLROTDP (Camel Originating TDP criteria) GHLRTTDP (Camel Terminating TDP criteria) GHLRGCSI (GPRS CSI) GHSMSCSI (SMS CSI) GHLRLCS (Location Services) GHLRCLIN (CLI MSISDN) GHLRDCSI (Dialled CSI) GHLRMCSI (Mobility Management CSI) GHLCSECL (Location Services External Client List)

411-2831-331 Standard 01.05 April 2006

1-19Nortel Confidential Copyright 19962006 Nortel

Chapter 1: Introduction to MSP and command syntax 1

The Mobile Subscriber Provisioning (MSP) protocol provides the ability to manipulate (i.e. add, change, delete and display) subscriber data on the HLR database.

The HLR Provisioning Manager (HLR-PM) and HLR Provisioning Server (HLR-PS) enable a subscribers profile to be modified in one MSP message, containing data which can affect many tuples in the HLR databases subscriber data tables. The subscription arguments provided in each message request have no distinct ordering. The HLR-PM / HLR-PS orders the tuple operation to maximize the chance of the whole transaction completing successfully. If an error occurs during a transaction, the completed operations are rolled-back, and the subscriber is restored to the original state before any of the tuple operations were attempted.

MSP defines a syntax for subscription administration. This information can be transmitted in two ways (over datalink and as part of an BSP file).

MSP Data LinkThe MSP data link protocol is used when an AdC passes provisioning information (on a transaction basis) to an HLR-PM / HLR-PS . In this configuration, the AdC and HLR-PM / HLR-PS are connected by a physical link.To ensure requests and responses are passed accurately, the MSP data link protocol is used. For further information see Chapter 4: MSP Data Link Protocol on page 4-283.

The MSP protocol is transmitted to the HLR-PM / HLR-PS via Ethernet, using raw sockets over TCP/IP.

MSP is half-duplex, only after a response is received from the HLR-PM / HLR-PS should the next message (with the exception of the Cancel message) be sent by the AdC. All communication is initiated by the AdC.


1-20 Chapter 1: Introduction to MSP and command syntaxNortel Confidential Copyright 19962006 Nortel

MSP has logon and logoff messages to start and end a session, if there is no activity on a link for greater than a configurable number of seconds, the HLR-PM / HLR-PS logs the user off. To prevent this happening during a lengthy provisioning sequence an AdC can send NULL messages. The HLR-PM / HLR-PS resets the logoff timer when it receives a NULL message.

BSPBSP allows the AdC to provision information for multiple subscribers within a single BSP file. These files can be prepared during peak hours and processed during off-peak hours. Files are transferred using the mechanisms described in [1] HLR-PS File Transfer Specification, Version 1.3, Release: OMC07.

The MSP encoding scheme is used within the BSP files to specify provisioning information. This provides consistency for both the AdC MSP encoding engine and HLR-PM / HLR-PS MSP decoding engine. BSP inherits the enhancements to MSP capabilities each release.

The bulk file format supports all of the provisioning commands and data provided by MSP. For further information see Chapter 5: MSP Bulk File Format on page 5-331.

The MSP audit file is used to record MSP provisioning layer requests and responses. MSP Audit file records MSP provisioning layer requests and responses together with other information which describe how and where the transaction is processed. For further information see Chapter 6: MSP Audit File Format on page 6-341..

A third party AdC development agency must be supplied with the correct specification and version and the method of connection must be agreed.

It is strongly recommended that new third party AdC development agencies perform integration testing with the HLR-PM / HLR-PS before deployment.

Syntax conventions 1In order to be able to describe messages in a generic way, the following syntax convention is used within this section:

expr An expression, which is any sequence of literal characters or expressions.

Symbol_name:= expr Symbolic name is defined by expression Symbolic name must be replaced with the value for

which it stands.[expr] Expression optional, or applicable in certain cases.

411-2831-331 Standard 01.05 April 2006

Chapter 1: Introduction to MSP and command syntax 1-21Nortel Confidential Copyright 19962006 Nortel

[expr] * Repetition of expression, 0 or more instances.[expr] + Repetition of expression, 1 or more instances.expr1 expr2 Expression 1 is followed by expression 2.expr1 | expr2 Expression 1 or expression 2 is applicable.| The | symbol is used to separate values accepted

by a particular parameter and takes precedence over all other notation (except :=). For example:example:= A B | C D

Here, example is either:A followed by B or,

C followed by D.

{comment} Textual description

Messages will be shown in the following font:

message:= {an example message, shown with a different font}

Any spaces shown in grammar or examples are not required and are included for legibility only. For example, the spaces around the | are shown for clarity only.

MSP command formats 1The MSP provisioning commands are split into four groups. Three of the command groups have a number of operations types as listed in Table 1-1, Groups and operations types of MSP provisioning commands, on page 1-21. The command name is derived from the letters that represent the operation and command group (in that order).

For example: DFSB is the command for defining a subscriber.

Table 1-1 Groups and operations types of MSP provisioning commands

Groups of provisioning commands

Short form

Purpose of command Operation types available for the command group

Subscriber definition commands

SB SB commands allow a subscriber to be added or removed from the HLR database. Conceptually, these commands access the AUC database.

Define (DF)

Modify (MD)

Display (DP)

Delete (DE)



MSP request formatsProvisioning requests always contain a request type which is the command to be executed. Dependent on the request type a number of arguments can be provided.

:= |

|

|

|

|

|

|

|

|

|

For information on each see Chapter 2: Provisioning Commands on page 2-29.

:= DFSB | MDSB | DPSB | DESB | MDSN | DPSN | DESN |

Subscription definition commands

SN SN commands allow a subscription to be modified on the HLR database. Conceptually, these commands access the HLR database.

Modify (MD)

Display (DP)

Delete (DE)

SIM replacement definition commands

(often referred to as SIMR commands)

SR SR commands allow the provisioning of SIM replacement functionality on the HLR database.

Modify (MD)

Display (DP)

Delete (DE)

Translation command TRAN The TRAN command allows an MSISDN to be translated into an IMSI.

not applicable

Table 1-1 Groups and operations types of MSP provisioning commands

Groups of provisioning commands

Short form

Purpose of command Operation types available for the command group

411-2831-331 Standard 01.05 April 2006


MDSR | DPSR | DESR | TRAN

A provisioning command request:

DFSB = Define a subscriberMDSB = Modify subscriber dataDPSB = Display subscriber dataDESB = Delete subscriberMDSN = Modify/add subscription dataDPSN = Display a subscriptionDESN = Delete a subscriptionMDSR = Modify SIMR informationDPSR = Display SIMR informationDESR = Delete SIMR informationTRAN = Translate

For information on each see Chapter 2: Provisioning Commands on page 2-29.

MSP response formatsProvisioning responses contain a message response code which is a two byte code. A response can contain, dependent on the defined above, a number of arguments.

:= |

|

|

|

|

|

|

|

|

|

For further information on each see Chapter 2: Provisioning Commands on page 2-29.



On some error messages, the particular dataid in the error is indicated by the . For example, sending an MDSN message with a CFU subscriber data that had a bad call forwarding number would result in the following response:

:= 7C CFU

Common Definitions 1The following sections define parameters that are common to multiple commands.

The ASCII character 09 hex or the horizontal TAB character.

The provisioning identifier. The subscribers IMSI or the MSISDN. For further information see Provisioning Identifier on page 1-24.

The term used to represent a service used by the HLR database and the Data Server as defined in Subscription data syntax on page 3-59.

The term used to designate information associated with a subscriber stored in the HLR database and the Data Server as defined in Subscription data syntax on page 3-59.

A two digit response code which is described in Appendix C, Appendix C: Message Response Codes on page C-363.

Provisioning IdentifierThe provisioning identifier, or , corresponds to the International Mobile Subscriber Identity (IMSI) or the Mobile Subscriber ISDN (MSISDN) of the subscriber.

The HLR database uses the IMSI to uniquely identify a subscriber in the Data Server. When a Basic Service is provisioned, an MSISDN is provided. The MSISDN also uniquely identifies the subscriber.

MSP allows both the IMSI and MSISDN to be used as a argument for subscriber provisioning message types supported, with the following exception:

For some MSP message types, using the MSISDN as the provisioning identifier is not appropriate. For example, define subscriber (DFSB) creates a new subscriber with no Basic Services and hence no MSISDN. In these cases, a inappropriate identifier error is produced.

411-2831-331 Standard 01.05 April 2006


Database Server provisioning identifier formatThe Database Server provides two methods of allocating subscribers to HLRs:

Pattern matching - matches IMSI patterns to HLRs Manual allocation - MSP message specifies the HLR where the subscriber

should be created.Using the identifier to specify the HLRThe manual allocation requires additional syntax in the provisioning identifier of a DFSB message to specify the HLR.

Note: This syntax is used by the Provisioning Manager (HLR-PM) on a Data Server to route the MSP message. On an HLR-PS the syntax has no effect and will be ignored.

Once a subscriber has been created subsequent MSP messages will be routed to the correct HLR automatically without the need to specify the HLR

The following MSP commands also allow the specification of an HLR in the provisioning identifier. The HLR specification functionality is only allowed when an IMSI is used as the message identifier.

DPSB DPSN DPSR DESBSpecifying the HLR for these commands is required for the internal audit functionality of the Database Server and is not intended for use by external MSP users.

For more details on specifying the HLR identifier, see the HLR200 Data Server Operations and User Guide, NTP 411-2831-330.

Using the HLRONLY flag to access the HLR coreThe following MSP commands also allow the specification of the HLRONLY flag in the provisioning identifier. If the HLRONLY flag is not set, display messages only query the Data Server. If the HLRONLY flag is set, display messages only query the HLR. The HLRONLY flag specification functionality is allowed when the arg type is an IMSI with the following commands:

DPSB DPSN



DPSRThe HLRONLY flag specification functionality is allowed when the arg type is an MSISDN with the following command:

TRANSIMR Provisioning

The syntax corresponds to the SIM Replacement (SIMR) information provisioned.

The HLR core supports a system which allows for SIM replacement (SIMR). This operation involves transferring services associated with an IMSI to a new IMSI when a certain event occurs. The event can be one of two types:

At a fixed time (scheduled swapover) When the new IMSI is used for the first time (user triggered swapover)Before any swapover takes place, a new subscriber must be added to the HLR core database.

The SR commands (defined in MSP command formats on page 1-21) allow the provisioning of SIMR information in the HLR core database.

DES Encryption of KiThe Ki may be encrypted in a DFSB or MDSB message, to provide security for this sensitive data. The only encryption algorithm supported by the HLR-PS is Data Encryption Standard (DES).

Decryption KeyThe secret key is specified in the configuration of the HLR-PS as 16 hexadecimal digits. The key is associated with an index, and this index is used in the DFSB message to refer to the key that was used to encrypt the Ki in that record. Up to 255 keys are stored on the HLR-PS.

Ki Encryption by MSPThe HLR-PS supports Electronic Code Book mode DES decryption. Figure 1-1 on page 1-27 illustrates the DES encryption of Ki by the MSP.

411-2831-331 Standard 01.05 April 2006


Figure 1-1 Encryption of Ki using Electronic Code Book mode DES

The HLR-PS applies DES decryption on the encrypted Ki within the MSP provisioning request, by splitting the 16 byte Ki. The 8 most significant bytes of the Ki, encrypted, become the 8 most significant bytes of the result Ki, decrypted. The least 8 significant bytes of the Ki, encrypted, become the 8 least significant bytes of the result Ki, decrypted.

16 Bytes

Most significant 8 bytes Least significant 8 bytes

Least significant 8 bytesMost significant 8 bytes

16 Bytes

DecryptedKi

EncryptedKi

Split

Assemble

DES Key DESEncryption

DES KeyDESEncryption



411-2831-331 Standard 01.05 April 2006


Chapter 2: Provisioning Commands 2This chapter provides definitions for the following MSP commands:

Command name Command long name Page reference

DFSB Define a subscriber 2-30

MDSB Modify subscriber data 2-32

DPSB Display subscriber data 2-34

DESB Delete subscriber 2-36

MDSN Modify or add subscription data 2-38

DESN Delete a subscription 2-41

DPSN Display subscription data 2-42

MDSR Modify SIMR information 2-46

DPSR Display SIMR information 2-48

DESR Delete SIMR information 2-50

TRAN Translate 2-51


2-30 Chapter 2: Provisioning CommandsNortel Confidential Copyright 19962006 Nortel

Define a Subscriber (DFSB) 2The DFSB command adds a new subscriber to the HLR core database.

REQUEST SYNTAX

:= DFSB ENC,KI, ALGPARM,ALGSEL,

:= IMSI,[,]

International Mobile Subscriber Identity (IMSI) in international E.212 format. 6-15 digits, including the MCC, MNC and MSIN.

:= HLRID, | HLRNAME,

3-10 hexadecimal characters.

HLR name, symbolic string of 1-32 alphanumeric, - and _ characters (first character must be a letter).

:= NONE |

NONE = No encryption.

1-3 numeric characters to indicate the DES encryption index used to encode the Ki. Numeric values of 1 to 255 are valid. For further information see DES Encryption of Ki on page 1-26.

32 hexadecimal characters that represent the Ki value to be added to the subscriber, most significant byte first. Encrypted as defined by .

:= NIL |

NIL = no algorithm parameter.

32 hexadecimal characters that represent the algorithm parameter value.

1-3 numeric characters indicating the A3/A8 algorithm selector to be set for the subscriber. Numeric values of 0 to 255 are valid.

RESPONSE SYNTAX

:=

See Table C-1, Message responses - meaning and occurrence, on page C-363 for response codes.

411-2831-331 Standard 01.05 April 2006

Chapter 2: Provisioning Commands 2-31Nortel Confidential Copyright 19962006 Nortel

EXAMPLES Example request to add a subscriber with IMSI 2400119120000:

DFSBIMSI,2400119120000ENC,25KI,C74D930B45F66867AFF2A0F4610A408F ALGPARM,NILALGSEL,1

Example request to add a subscriber with IMSI 2400119120001 with no encryption on the Ki:DFSBIMSI,2400119120001ENC,NONEKI,07F420070A510C320BC411B5FC393FE3ALGPARM,07F420070A510C320BC411B5FC393FE3ALGSEL,101

Example request to add a subscriber with IMSI 2400119120001 with an ALGPARM of NILDFSBIMSI,2400119120001ENC,25KI,07F420070A510C320BC411B5FC393FE 3ALGPARM,NILALGSEL,3

Example request to add a subscriber with IMSI 2400119120001 on the HLR having HLRID of AA30:DFSBIMSI,2400119120001,HLRID,AA30ENC,25KI,07F420070A510C320BC411B5FC393FE 3ALGPARM,NILALGSEL,3

Example of an error response where HLR core dump is in progress:EE



Modify Subscriber Data (MDSB) 2The MDSB command modifies information added as part of the DFSB message.

REQUEST SYNTAX

:= MDSB[ENC, KI,][ ALGPARM,][ALGSEL,]

:= IMSI, | MSISDN,


Mobile Subscriber ISDN Number (MSISDN) in international E.164 format. 3-15 digits, including the CC, NDC and SN. For further information see Provisioning Identifier on page 1-24.

:= NONE |

NONE = No encryption.

1-3 numeric characters to indicate the DES encryption index used to encode the Ki. Numeric values of 1 to 255 are valid. For further information see DES Encryption of Ki on page 1-26.

32 hexadecimal characters that represent the Ki value to be added to the subscriber, most significant byte first. Encrypted as defined by .

:= NIL |



1-3 numeric characters indicating the A3/A8 algorithm selector to be set for the subscriber. Numeric values of 0 to 255 are valid.

Note: At least one of the optional fields (ENC/KI, ALGPARM or ALGSEL) must be included in the message.

411-2831-331 Standard 01.05 April 2006


RESPONSE SYNTAX

:=


EXAMPLES The following example message changes the ALGSEL value:

MDSBIMSI,2400119120001ALGSEL,1

The following example message changes the Ki (unencrypted):MDSBIMSI,2400119120001ENC,NONEKI,07F420070A510C320BC411B5FC393FE3

The following example message changes the Ki and the algorithm selector:MDSBIMSI,2400119120001ENC,12KI,07F420070A510C320BC411B5FC393FE3 ALGSEL,2

The following example message changes the OPC value:MDSBIMSI,2400119120001ALGPARM,07F420070A510C320BC411B5FC393FE3

The following example message changes the ALGPARM field to NIL:MDSBIMSI,2400119120001ALGPARM,NIL

Example of a successful response:00

Example of an error response where an MK change is in progress:E4



Display Subscriber Data (DPSB) 2The DPSB command displays information added as part of the DFSB message.

For security reasons, it is not possible to display the Ki.

REQUEST SYNTAX

:= DPSB [] *

:= IMSI,[,] [,] | MSISDN,






:= HLRONLY

Display the subscriber by querying the HLR, not the Data Server.

:= ALGPARM | ALGSEL

RESPONSE SYNTAX :=

[ALGPARM,][ALGSEL,]


:= NIL |



411-2831-331 Standard 01.05 April 2006


1-3 numeric characters indicating the A3/A8 algorithm selector to be added to the subscriber. Numeric values of 1 to 255 are valid.

EXAMPLES The following example message displays the ALGSEL value:

DPSBIMSI,2400119120001ALGSEL

Example response to this message:

00ALGSEL,3

The following example message displays the ALGPARM value:DPSBIMSI,2400119120001ALGPARM


00ALGPARM,07F420070A510C320BC411B5FC393FE3

The following example message displays the ALGPARM and ALGSEL values:DPSBIMSI,2400119120001


00ALGPARM,NILALGSEL,3

The following example message displays the ALGPARM and ALGSEL values for a subscriber provisioned on HLR having HLRID AA30:DPSBIMSI,2400119120005,HLRID,AA30


00ALGPARM,NILALGSEL,3

Example of an error response where the subscriber not defined:9D



Delete Subscriber (DESB) 2The DESB command deletes a specified subscriber from the HLR core. It can also be used to remove the subscription before removing the subscriber.

A subscriber cannot be removed if they have:

Subscription services (unless the ALL option is specified). SIM replacement information provisioned. SIM replacement information can be removed by using the DESR

command.

REQUEST SYNTAX

:= DESB

:= IMSI,[,] | MSISDN,






:= DEL,ALL | DEL,AUC

Indicates which type or group of data is to be deleted.

ALL = Remove subscription and subscriber data.

AUC = Remove subscriber data only.

411-2831-331 Standard 01.05 April 2006


RESPONSE SYNTAX

:=


EXAMPLES The following example deletes a subscriber with no subscription services

and IMSI 2400119120001:DESBIMSI,2400119120001DEL,AUC

The following example deletes subscription and subscriber with MSISDN 5233100001:DESBMSISDN,5233100001DEL,ALL

The following example deletes a subscriber with IMSI 2400119120005 and provisioned on HLR having HLRNAME LONDON:DESBIMSI,2400119120005,HLRNAME,LONDONDEL,ALL

Example of a successful response:00

Example of an error response where an IMSI range violation takes place:51



Modify or Add Subscription Data (MDSN) 2The MDSN command allows the subscribers basic and supplementary services to be added, deleted or modified. Many services can be modified within the same MDSN request.

If the MDSN message is used for the modification of an already existing service, only the parameters explicitly stated in the message protocol will be modified in the HLR core database. Existing data shall remain until explicitly modified.

REQUEST SYNTAX

:= MDSN []+

:= IMSI, | MSISDN,



where corresponds to designated information associated with a subscriber stored in the HLR core as defined in Subscription data syntax on page 3-59.

Note: The order in which these elements are presented is not significant.

RESPONSE SYNTAXResponses contain a message response code which is a two byte code. A response will contain a response code and may have [0..n] arguments.

:= [ ]*


On some error messages, the particular dataid in error is indicated by . For example, sending an MDSN message with a CFU subscriber data that had a bad call forwarding number would result in the following response:

provisioning_response:= 7C CFU

411-2831-331 Standard 01.05 April 2006


EXAMPLES Example message request to modify the following parameters of the

subscription with the IMSI 2400119120000:

CFU Deactivate for Telephony

CFNRY Activate for all Basic Services, Forwarded-to number 6102419300203, Nature-of-address international number, Numbering-plan-indicator ISDN, No-Reply Time 5.

BAOC provision

SOCFNRY notify forwarding party with number, no notification of calling party

BS23 Delete

TS62 Define No. 61491019120002, BC=20, BS = TS62 (Automatic Facsimile Group 3)

MDSNIMSI,2400119120000CFU,1,0,TS10CFNRY,1,1,6102419300203,1,1,5 BAOC,1SOCFNRY,1,0BS23,0TS62,1,61,491,019120002,20

Example of the above profile using MSISDN as a subscriber identifier:MDSNMSISDN,61149101912001CFU,1,0,TS10CFNRY,1,1,6102419300203,1,1,5BAOC,1SOCFNRY,1,0BS23,0TS62,1,61,491,019120002,20

Example of a successful message response:00

Example of an unsuccessful message response, IMSI is not defined:9D

MDSN Data Replacement and Data Merging SamplesThe MDSN command can be used to replace existing subscription data or merge new data with existing subscription information.

Data Replacement SampleThe following example DPSN response shows CFB provisioned and registered with call forward number 61019192222, nature of address international number and numbering plan indicator ISDN against Speech:



00IMSI,2400119120000CFB,1,1,61019192222,1,1,TS10

If the following example MDSN message request is issued, the existing call forward number (61019192222) is overwritten with the new call forward number (61019192345).

CFB,x,1,61019192345,1,1,TS10

The original DPSN response will contain the following information:

00IMSI,2400119120000CFB,1,1,610191922345,1,1,TS10

Data Merging SampleThe following example DPSN response shows BAIC provisioned and registered for Speech and CDA:

00IMSI,2400119120000BAIC,1,1,TS10,1,BS20

In the following example, an MDSN message request is issued to register BAIC for all applicable BSGs should the service be provisioned:

BAIC,x,1

The MDSN message merges any unregistered, applicable, BSGs with the existing subscription data.

The original DPSN response will contain the following information:

00IMSI,2400119120000BAIC,1,1,TS10,1,TS20,1,TS60,1,TSD0,1,BS20,1,BS30

411-2831-331 Standard 01.05 April 2006


Delete a Subscription (DESN) 2The DESN command allows previously defined subscriptions to be deleted together with all associated subscription data. This results in the deprovisioning of all basic and supplementary services and the subscriber being set out of service.

Once the DESN command has successfully completed, the subscriber can be removed from the database using the DESB command.

REQUEST SYNTAX

:= DESN

:= IMSI, | MSISDN,



Display Subscription (DPSN) 2The DPSN command displays the subscription information provisioned for a subscriber.

REQUEST SYNTAX

:= DPSN[]*



Mobile Subscriber ISDN Number (MSISDN) in international E.164 format. 3-15 digits, including the CC, NDC and SN. For further information see Provisioning Identifier on page 1-24




:= HLRONLY

Display messages query the HLR, not the Data Server.

A service in the HLR core as defined in Subscription data syntax on page 3-59.

RESPONSE SYNTAX

:=[IMSI,][ ]*



Designated information associated with a subscriber stored in the HLR core as defined in Subscription data syntax on page 3-59.

411-2831-331 Standard 01.05 April 2006


Note: If the request message does not specify a , or set of data ids, all will be returned in the response. Otherwise, the response will contain the data ids sent in the request, in the order that they were included in the request.

The following information is not returned in a DPSN response:

Not provisioned state Not registered state Read only data ids (SGSN and CVLR) if the data is not set or is unknown

at the HLR coreOn the Data Server, the following information is not returned in the response of a DPSN with no parameters (i.e. DPSN of all the data fields) :

The location data. But the location data can be added to the response of a DPSN with no parameters by changing the user config.

When the HLR core contains subscriber parameters that have no definition in the MSP version being used, a ? character is sent. This is specific behaviour of the DPSN command.

EXAMPLES Example request to display the subscription with IMSI 2400119120000:

DPSNIMSI,2400119120000

Example of a successful message response from HLR-PM / HLR-PS to display all subscriber data: 00IMSI,2400119120000AOCC,1CLIP,1,0MPTY,1,1HOLD,1, BAIC,1BAOC,1BOICEXHC,1,1,TS10CW,1CFB,1CFNRC,1 CFNRY,1,1,61019192000,1,1,20,TS10,1,61019192000,1,1,20,BS30CFU,1,1,61101912000,1,1,TS10,1,61101912000,1,1,BS30ODBO,1CAT,1PWD,0876BICCTRL,1BOCCTRL,1ROAMENT,UNKWISTATUS,ISOAPROV,NSOCFB,0,0SOCFNRC,0SOCFNRY,0,0SOCFU,0TS11,1,61,123,311000,1BS33,1,61,123,31101,NIL

IMSI 2400119120000

AOCC advice of charge (charging) is provided and activated

CLIP is provided and activated with no override provisioned

MPTY is provided and activated for 6 port



HOLD is provided and activated

BAIC is provided (not activated)

BAOC is provided (not activated)

BOICEXHC is provided and active operational for TS10 (Speech)

CW is provided (not activated)

CFB is provided (not activated)

CFNRC is provided (not activated)

CFNRY is provided and active for TS10 (Speech) and BS30 (CDS) with Forward-to number 61019192000, Nature-of-address international number, Numbering-plan-indicator ISDN and No-reply-time of 20 secs

CFU is provided and active for TS10 (Speech) and BS30 (Fax) with Forwarded-to number 61101912000, Nature-of-address international number, Numbering-plan-indicator ISDN

ODBO operator determined BAOC is active

CAT 1 (Subscriber priority)

PWD 0876 (password)

BICCTRL by the operator

BOCCTRL by the operator

ROAMENT is set to UNKW

ISTATUS Subscriber is in-service

SOAPROV set to no

SOCFB no notification to calling party for CFB, no notification to forwarding party for CFB

SOCFNRC calling party notified with number for CFNRC

SOCFNRY no notification to calling party for CFNRY, no notification to forwarding party for CFNRY

411-2831-331 Standard 01.05 April 2006


SOCFU calling party notified with number for CFU

TS11 CC = 61 NDC = 123, SN = 311000, BC = 1

BS33 CC = 61 NDC = 123, SN = 31101, BC = NIL

Example message request to display the call forwarding service data of the subscription with IMSI 2400119120000:DPSNIMSI,2400119120000CFBCFNRYTS10SOCFNRY

Example of the above message using MSISDN as the subscriber identifier:

DPSNMSISDN,116542000CFBCFNRYTS10SOCFNRY

Example of a successful message response from HLR-PM / HLR-PS:00CFB,1CFNRY,1,1,44304823310,1,1,20,TS10,1,44304823310,1,1,20,TS60 SOCFNRY,0,0

In the above example, if CFB was not provisioned and CFNRY was not registered against TS60, the following response would be sent:00CFNRY,1,1,44304823310,1,1,20,TS10SOCFNRY,0,0

The following response shows a scenario where the HLR core contains a value for CAT that is not defined in the MSP version being used.00CAT,?

Example message request to display all service data of the subscription with IMSI 2400119120005 and provisioned on HLR having HLRNAME LONDON:DPSNIMSI,2400119120005,HLRNAME,LONDON

Example of an unsuccessful message response caused because the HLR core is temporarily busy:ED



Modify SIMR information (MDSR) 2The MDSR command adds or modifies SIM replacement information for a subscriber. The refers to the replacement (new) subscriber.

Note: The new subscriber must be added prior to the provisioning of SIM replacement.

REQUEST SYNTAX

:= MDSR

:= IMSI,


:= OLDIMSI, | OLDMSISDN,

The OLDMSISDN is used only when modifying (using MDSR). It is never returned as a result of a display (DPSR).

:= FIXED, | USER,,

10 numeric characters indicating invocation time in YYYYMMDDHH (year/month/day/hour) format, for example 2005122512 represents 12 oclock on the 25th December 2005.

10 numeric characters indicating activation time in YYYYMMDDHH (year/month/day/hour) format, for example 2005072512 represents 12 oclock on the 25th July 2005.

RESPONSE SYNTAX

:=


EXAMPLES Example of a MDSR to set up scheduled SIM replacement at 6 a.m. on

the 15th January 2005:MDSRIMSI,2400119120001OLDIMSI,2400119120002FIXED,2005011506

411-2831-331 Standard 01.05 April 2006


Example of a MDSR to set up user triggered SIM replacement from 6 p.m. (18:00) on the 19th September 2005 to 9 p.m. (21:00) on the 1st January 2006:MDSRIMSI,2400119120001OLDIMSI,2400119120002USER,2005091918, 2006010121

Example of a response indicating that request has been processed:00



Display SIMR information (DPSR) 2The DPSR command displays SIM replacement information provisioned for a subscriber. The provisioning identifier can see either the existing (old) subscriber or the replacement (new) subscriber.

REQUEST SYNTAX

:= DPSR







:= HLRONLY


RESPONSE SYNTAX

:= [IMSI, ]


The IMSI number of the replacement (new) subscriber.

:= OLDIMSI, | OLDMSISDN,

This information is not sent if there is no SIMR information provisioned.The OLDMSISDN is used only when modifying (using MDSR). It is never returned as a result of a display (DPSR).

411-2831-331 Standard 01.05 April 2006


:= FIXED, | USER,,

10 numeric characters indicating invocation time in YYYYMMDDHH (year/month/day/hour) format, for example 2005122512 represents 12 oclock on the 25th December 2005.

10 numeric characters indicating activation time in YYYYMMDDHH (year/month/day/hour) format, for example 2005072512 represents 12 oclock on the 25th July 2005.

EXAMPLES The following example displays SIMR information (using new IMSI):

DPSRIMSI,2400119120001

Example of a response showing scheduled SIM replacement provisioned at midnight on the 22nd May 2005:

where 00IMSI,2400119120001OLDIMSI,2400119120002FIXED,2005052200

The following example displays SIMR information (using old IMSI):DPSRIMSI,2400119120002

Example of a response showing user-triggered SIM replacement from 6pm (18:00) on the 19th September 2005 to 9pm (21:00) on the 1st January 2006:

00IMSI,2400119120001OLDIMSI,2400119120002USER,2005091918, 2006010121

The following example displays SIMR information for a subscriber provisioned on HLR having HLRID AA30:DPSRIMSI,2400119120005,HLRID,AA30

Example of a response where no SIMR information is provisioned:00

Example of an error response indicating that the subscriber is not defined in the HLR core:9D



Delete SIMR information (DESR) 2The DESR command deletes SIM replacement information provisioned for a subscriber. The provisioning identifier can refer to either the existing (old) subscriber or the replacement (new) subscriber.

Once the DESR command has successfully completed, the subscriber can be removed from the database using the DESB command.

REQUEST SYNTAX

:= DESR

:= IMSI, | MSISDN,



RESPONSE SYNTAX

:=


EXAMPLES The following example deletes SIMR information:

DESRIMSI,2400119120001

Example of a successful response:

00


411-2831-331 Standard 01.05 April 2006


Translate (TRAN) 2The TRAN command allows translation of an MSISDN to an IMSI. An MSISDN is assigned to a subscriber when provisioning a Basic Service.

REQUEST SYNTAX

:= TRAN

:= MSISDN, [,]

Only MSISDN is applicable to the TRAN command.


:= HLRONLY


RESPONSE SYNTAX

:= [IMSI,]



EXAMPLES The following example translates an MSISDN to IMSI:

TRANMSISDN,611239120001

Example of a successful response:

00IMSI,2400119120001




411-2831-331 Standard 01.05 April 2006


Chapter 3: Provisioning Subscriber Data 3

Subscriber data (for instance GSM, Nortel proprietary and GSMR Basic or Supplementary Services) can be added, changed or deleted using the MDSN message. It can be queried using the DPSN command.

In the MDSN request and DPSN response, each subscriber data argument is made up of an identifier , as defined in Subscription data syntax on page 3-59, followed by one or more parameters defining the value of the argument (for example, provision status, BSG, activation status, forwarded-to number etc.) Parameters are separated by commas.

Attempts to provision Supplementary Services that are already provisioned, and to withdraw services that are not in the HLR core will not result in an unsuccessful response. Instead these attempts are ignored.

If a service is included twice in the same message it will cause an error.

Provisioning and deprovisioning status 3The provisioning setting expression provides information on how the provisioning states of the service should change. The following actions are provided:

0 - deprovision 1 - provision x - no change to the provisioning state

The behaviour of the three provisioning actions is summarised in Table 3-1, Results of Provisioning Actions, on page 3-55. The columns represent the initial state of the service. Each row represents an MSP message. The result


3-54 Chapter 3: Provisioning Subscriber DataNortel Networks Confidential Copyright 19962006 Nortel Networks

of the operation is given in each box indicating that the HLR core remains unaffected.

0 - deprovisionWhen a service is deprovisioned, all service information is removed, including registration data such as Call Forwarding numbers. For example:

CFNRY,0

deprovisions the Call Forward No Reply service.

If the service is already deprovisioned, no error message is generated.

1 - provisionWhen a service is provisioned, it becomes available for registration. A service can be provisioned without being registered. For example:

CW,1

provisions the Call Waiting service.

If a service is already provisioned, no change is made.

x - no change to the provisioning stateWhen the no change provisioning state is used, no change is made to the provisioning state.

The use of the no change provisioning state affects the processing of BSG-based services depending on whether a registration or deregistration is being made.

411-2831-331 Standard 01.05 April 2006

Chapter 3: Provisioning Subscriber Data 3-55Nortel Networks Confidential Copyright 19962006 Nortel Networks

Table 3-1Results of Provisioning Actions

Registering and deregistering services against Basic Service Groups 3

RegisteringOnce a service is provisioned it can be registered against a specific BSG. For some services, registration data is provided, for example a Call Forwarding number. The MSP syntax allows two basic forms of registration and deregistration - specific and general.

Specific registration allows registration data to be applied to a list of BSGs. Any registration data already in the HLR core that is not specified in the registration data list is unaffected.

The following example provisions call forward unconditional, registers 54321 against speech and 12345 against CDA:

CFU,1,1,54321,1,1,TS10,1,12345,1,1,BS20

General registration allows a single piece of registration data to be applied to all provisioned BSGs:

The following example provisions COS and register a CUSTGRP of 10 and NCOS of NIL against all BSGs provisioned at that time.

Initial State

Not provisioned Provisioned, not registered

Provisioned, registered

Ope

ratio

n

dataid,0 Unaffected Not provisioned Not provisioned

dataid,1 Provisioned, not registered

Unaffected Unaffected

dataid,1,0 Provisioned, not registered

Unaffected Provisioned, not registered

dataid,1,1,reg_data Provisioned, registered



dataid,X Unaffected Unaffected Unaffected

dataid,X,0 Unaffected Unaffected Prov, not reg

dataid,X,1,reg_data Unaffected Provisioned,

registered




COS,1,1,10,NIL

If a later request provisions another BSG, the registration data will not be applied to the new BSG.

Before setting registration data, the service must be provisioned. This can be done by explicitly setting the provisioning state to provision as shown in the examples above. If the provisioning state is set to no change, the registration information is only applied if the service is already provisioned in the HLR core.

In the following example, incoming barring will be registered for speech and CDA only if incoming barring is already provisioned.

BAIC,X,1,TS10,1,BS20

DeregisteringAs for registration, a service can be deregistered in two ways - specific and general. In both cases, once information has been deregistered, it is lost from the DMS HLR.

Specific deregistration and deactivation allows registration data to be removed from a list of BSGs. No error is generated if the service is not registered.

The following example deregisters Call Forward Unconditional against speech and CDA:

CFU,1,0,TS10,0,BS20

General deregistration allows deregistration against all provisioned BSGs.

The following example deregisters COS against all BSGs provisioned at that time. Note that the service will remain provisioned.

COS,1,0

This is different to the later example COS,0 which deregisters all information and deprovisions the service.

When the provisioning state is set to provision a deregister operation always leaves the service provisioned. If the no change provisioning state is used and the service is deprovisioned in the HLR core, the service is left deprovisioned.

In the following example, incoming barring is deregistered. If the service was not provisioned it will remain unprovisioned.

411-2831-331 Standard 01.05 April 2006


BAIC,X,0,TS10,0,BS20

Mixed registration and deregisterationThe MSP syntax allow registration information to be added and removed in one operation.

The following example registers the Extension service against speech and deregisters any information held against auxiliary speech.

EXT,1,1,N,S,12345,54321,15,TS10,0,TSD0

Special cases and shorthands 3

Basic Service provisioning shorthandIf the Basic Service is set to 1 and the ,,, sequence is excluded, the service will be provisioned with the MSISDN held by the Telephony (TS11) Basic Service and a bc of NIL will be assigned.

In the following example, Telephony service is provisioned with the following information:

TS11,1,61,123,7221000,NIL

To provision another Basic Service, for example SMMT, with the MSISDN provisioned against the Telephony Basic Service the ,,, sequence is not needed. See the following example:

TS21,1

The benefit of this is that it is a more convenient means of provisioning many Basic Services that have the same MSISDN number as the Telephony Basic Service

Note: If Telephony is provisioned with a non-NIL bc, the subsequent operation will fail, except in the case for TS21 and TS22.

If Telephony is not provisioned, the error code 9F telephony not provisioned will be returned.

Basic Service Group-based Supplementary Service ShorthandA BSG-based Supplementary Service can either be provisioned against a specific BSG or against all provisioned BSGs for a particular subscriber.



The following example provisions CFU against all currently provisioned BSGs. The subsequent addition of other BSGs will not automatically provision the existing Supplementary Service against the new BSGs. This has to be done explicitly.

MDSNIMSI,45623000005CFU,1,1,123456,1,1

The following example provisions CFU against BSG Speech only.

MDSNIMSI,45623000005CFU,1,1,123456,1,1,TS10

Common sections 3The following section defines parameters that are common to multiple commands.

Provides information on how the provisioning states of the service should change. For information on provisioning states see Provisioning and deprovisioning status on page 3-53.

The country code of the MSISDN.

The national destination code of the MSISDN.

The subscriber number of the MSISDN.

Bearer capability to be associated with the Basic Service (as defined in table GHLRBCA).

:= VERSION,

This parameter indicates which version of the provisioning layer encoding scheme to use.

:= 11 | 12 | 13 | 14

11 = MSP Version 11

12 = MSP Version 12

13 = MSP Version 13

14 = MSP Version 14

To use MSP v14 this must be set to 14. The VERSION,14 argument is mandatory and indicates that MSP v14 provisioning layer messages will be sent.

MSP version 10 and below are no longer supported.

411-2831-331 Standard 01.05 April 2006


Note: The MSP version numbers used in the examples within this document may not be supported by the latest version of the HLR-PS. These version numbers are quoted for example purposes only.

Subscription data syntax 3The following section lists, in alphabetical order of English definition, the subscriber data argument for each, supported, GSM, GSMR and Nortel proprietary services. For reference purposes, Table 3-2, MSP data ids (in alphabetical order), on page 3-61 shows the Basic Service Groups and lists each supported HLR service referenced by its MSP data id.

All services definitions contain examples for MDSN and DPSN.

The following definitions are used in Chapter 2: Provisioning Commands on page 2-29. The terms defined within these definitions are used in the following sections.

:= | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |



| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |

:= | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |

411-2831-331 Standard 01.05 April 2006


| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |

Table 3-2 MSP data ids (in alphabetical order)

MSP data id Service Service Type Page

ACC Account Code Supplementary Service 3-68

AOCC Advice of Charge Supplementary Service 3-70

AOCI Advice of Charge Information Supplementary Service 3-71

ACRJ Anonymous Call Rejection Supplementary Service 3-78

BAIC Barring of all Incoming Calls BSG-based Supplementary Service

3-83

BAOC Barring of All Outgoing Calls BSG-based Supplementary Service

3-86

BICCTRL Control of Incoming Barring Subscriber Attributes 3-166

BICROAM Barring of Incoming Calls while Roaming outside of Home Country

BSG-based Supplementary Service

3-89

BOCCTRL Control of Outgoing Barring Subscriber Attributes 3-167

BOIC Barring of Outgoing International Calls BSG-based Supplementary Service

3-91



BOICEXHC Barring of Outgoing International calls except to the Home Country

BSG-based Supplementary Service

3-93

BS20 CDA (Circuit Duplex Asychronous) Basic Service 3-126

BS20G CDAGBS (CDA General Bearer Service) Basic Service 3-140

BS21 CDA 300 Basic Service 3-128


BS23 CDA 1200-75 Basic Service 3-132




BS30 CDS (Circuit Duplex Synchronous) Basic Service 3-142

BS30G CDSGBS (CDS General Bearer Service) Basic Service 3-144

BS31 CDS 1200 Basic Service 3-146




BS61A Alternate Speech and Data (CDA) Basic Service 3-72

BS61S Alternate Speech and Data (CDS) Basic Service 3-74

BS81A Speech followed by Data (CDA) Basic Service 3-248

BS81S Speech followed by Data (CDS) Basic Service 3-250

CAML CAMEL CAMEL Service 3-170

CAT Category Subscriber Attributes 3-123

CFB Call Forwarding Busy BSG-based Supplementary Service

3-95

CFNRC Call Forwarding Not ReaChable BSG-based Supplementary Service

3-98

CFNRY Call Forwarding on No ReplY BSG-based Supplementary Service

3-101

CFU Call Forwarding Unconditional BSG-based Supplementary Service

3-105

CLIN Calling Line Identification Number Supplementary Service 3-109


411-2831-331 Standard 01.05 April 2006


CLIP Calling Line Identification Presentation Supplementary Service 3-110

CLIR Calling Line Identification Restricted Supplementary Service 3-112

COLP Connected Line Identification Presentation

Supplementary Service 3-163

COLR Connected Line Identification Restricted Supplementary Service 3-165

COS Class Of Service BSG-based Supplementary Service

3-154

CNAM Calling Name Delivery Supplementary Service 3-114

CSRECL Call Session Related External Client List Supplementary Service 3-115

CSRXECL Call Session Related eXtended External Client List


CSUXECL Call Session Unrelated eXtended External Client List


CUG CUG feature CUG Service 3-160

CUGSUB CUG subscription CUG Service 3-156

CVLR Current VLR number Read only data 3-168

CW Call Waiting BSG-based Supplementary Service

3-121

DCSI Dialled-Camel Subscription Information CAMEL Supplementary Service

3-176

EMLPP Priority options for eMLPP and WPS Supplementary Service Options

3-179

ECT Explicit Call Transfer Supplementary Service 3-181

EXT Extension BSG-based Supplementary Service

3-182

FM COR and Supplementary COR options for Follow Me

Supplementary Service Options

3-185

GCSI GPRS-Camel Subscription Information CAMEL Supplementary Service

3-190

GPRSCNTX GPRS PDP context data GPRS Service 3-187

HOLD Call Hold Supplementary Service 3-108

HOTBILL Hot Billing Supplementary Service 3-193

INORIG Originating IN index Subscriber Attributes 3-227




INTERM Terminating IN index Subscriber Attributes 3-269

ISTATUS Subscriber service status Subscriber Attributes 3-252

LCO Local Calls Only Supplementary Service 3-195

LCS Location Services Supplementary Service 3-197

LMU Location Measurement Unit Subscriber Attributes 3-196

MCSI Mobility Management CAMEL Subscription Information

CAMEL Supplementary Service

3-203

MCT Malicious Call Trace Supplementary Service 3-205

MPTY Multiparty Supplementary Service 3-206

NAM Network Access Mode Subscriber Attributes 3-208

ODBAECT ODB of all Explicit Call Transfer Subscriber Attributes 3-210

ODBCCFMGT ODB of conditional call forwarding subscriber management

Subscriber Attributes 3-212

ODBCHDECT ODB of Explicit Call Transfer when at least one of the calls is charged to the served subscriber


ODBCISSMGT ODB of supplementary services management


ODBDBCECT ODB of Explicit Call Transfer when both of the calls are charged to the served subscriber


ODBHPLMN1 ODB for operator specific barring type 1 Subscriber Attributes 3-222




ODBI ODB of incoming calls Subscriber Attributes 3-214

ODBINTECT ODB of Explicit Call Transfer when at least one of the calls is charged to the served subscriber at international rates


ODBO ODB of outgoing calls Subscriber Attributes 3-218

ODBOPRENT ODB of outgoing premium rate calls (entertainment)


ODBOPRINFO ODB of outgoing premium rate calls (information)



411-2831-331 Standard 01.05 April 2006


OTDP22 Originating Trigger Detection Point criteria for DP2 CAMEL Phase 2


3-228



3-232



3-236

PIC Primary Interexchange Carrier Subscriber Attributes 3-239

411-2831-331.01.05 gsm / umts hlr mobile subscriber...

Documents