ema _wireless_commands

CAI SPECIFICATION FOR WIRELESSEricsson Multi Activation 5.0

Copyright

© Ericsson AB 2007 - All Rights Reserved

Disclaimer

No part of this document may be reproduced in any form without the writtenpermission of the copyright owner.

The contents of this document are subject to revision without notice due tocontinued progress in methodology, design and manufacturing.

Ericsson shall have no liability for any error or damage of any kind resultingfrom the use of this document.

This document is a general guide, instruction and description of the EricssonMulti Activation product or applicable parts thereof. However, an Ericsson MultiActivation system installation may be configured partially or in a number of otheralternative ways. Consequently, configurations of Ericsson Multi Activationsystems may vary between different installations, hence such differencesmay also result in variations in the Ericsson Multi Activation system behavior,capacity as well as other limitations.

If in any doubt, please contact your local Ericsson support for further advise.

Trademark List

Ericsson is the trademark or registered trademark of Ericsson AB. All otherproducts or service names mentioned in this document are trademarks of theirrespective companies.

155 10-CSH 150 82 Uen C 2007-01-24

CAI SPECIFICATION FOR WIRELESS

Contents

1 Introduction 1

1.1 Prerequisites 1

1.2 Scope 2

1.3 Objectives 3

2 CAI Overview 5

2.1 General 5

2.2 Distributed Configuration 6

3 Communication Protocol 9

3.1 General 9

3.2 Transport and Network Layer 10

3.3 Session and Presentation Layer 13

4 Message Formats 17

4.1 Character Representation 17

4.2 Message Request Format 17

4.3 Message Response Format 19

5 Control Commands 21

5.1 Login 21

5.2 Logout 21

5.3 Message Response 22

6 HLR Subscription 25

6.1 Composite Parameter Definitions 25

6.2 Customers Service Orders (CSO) 70

6.3 Request and Response Parameters 84

6.4 HLR Subscriber Data Abbreviations 98

6.5 HLRSUB Message Response 106

7 FNR Subscription 121

7.1 Customers Service Orders 121


7.3 FNR Subscriber Data Abbreviations 140

7.4 FNRSUB Message Response 140

155 10-CSH 150 82 Uen C 2007-01-24


8 IMSI Change Over 149



8.3 IMSICH Message Response 157

9 AUC Subscription 161




9.4 AUCSUB Message Response 170

10 EIR Subscription 173



10.3 Message Response 186

11 CMS11HLR Subscription 193




11.4 CMS11HLR Subscriber Data Abbreviations 205

11.5 CMS11HLR Message Response 217

12 CMS11AC Subscription 221



12.3 CMS11AC Message Response 235

13 MPC Subscription 239




13.4 MPCSUB Message Response 259

14 AAA Subscription 263




14.4 AAASUB Message Response 291

155 10-CSH 150 82 Uen C 2007-01-24


15 Appendix A (Graphical Structure) 295

15.1 Example 1 295

15.2 Example 2 295

15.3 Example 3 296

16 Appendix B (Typical X.25 Configuration) 297

16.1 The Interface Section: 298

16.2 The Link Section: 298

16.3 The X.25 (packet level) Section: 299

17 Appendix C (Error Recovery) 303

18 Appendix D (New or Changed NEs and MOs in EricssonMulti Activation 4.0) 305

Glossary 307

Reference List 313

155 10-CSH 150 82 Uen C 2007-01-24


155 10-CSH 150 82 Uen C 2007-01-24


1 Introduction

The Customer Administration Interface (CAI) is the interface between a CASsystem and Ericsson Multi Activation. The interface simplifies the access todifferent kinds of Network Elements (NE) by introducing one homogenousinterface for all Network Elements.

The document Customer Administration Interface (CAI) (EPK/NK-96:073) isgeneric and describes the CAI syntax and protocol in general terms, whereasthis Ericsson Multi Activation document is the specific description of theinterface between a CAS and Ericsson Multi Activation for management ofHLR, EIR, AUC and etc. of the respective relevant versions.

CAI controls all protocol conversions for the specific Network Element.

Figure 1 The CAI concept

1.1 Prerequisites

In this document, it is assumed that the user:

• have basic knowledge of Ericsson Multi Activation.

• have proper authority to use Ericsson Multi Activation.

• have common knowledge about third-party documentation.

• have common knowledge of Ericsson systems.

• have sound knowledge of the Network Elements.

1155 10-CSH 150 82 Uen C 2007-01-24


1.2 Scope

This document specifies the CAI protocol for subscription/equipmentadministration towards Ericsson GSM 900/1800/1900 networks, hereinspecified as GSM network. The supported releases of the GSM network are:

a GSM 900/1800 R6.1

b GSM 1900 R3

c GSM R8/R9/R9.1/R9.2/R10/R11

d WCDMA R1.5/R2/R3/R4/R5

The document defines in detail the actions that may be performed and theresponses to be expected.

The following core network databases are supported:

a Home Location Register (HLR)

The HLR application based on a modular concept provides flexibility invarious network. It offers not only common maintenance and developmentmethodology and well-proven process for introducing new and enhancedfunctionality, but also trouble-free and seamless inter-working betweendifferent nodes.

b Equipment Identity Register (EIR)

The EIR helps to detect and trace phone handset counterfeiting andhandset subsidy fraud.

c Authentication Centre (AUC)

The AUC generates authentication and ciphering data according tothe European Telecommunications Standards Institute (ETSI) GSMspecifications.

d Flexible Number Register (FNR)

The FNR node is a high capacity entity designed to cope with the handlingof large number series and minimal call setup delays.

The NE redundancy concept in Ericsson Multi Activation support redundantHLRs as well as paired network elements such as FNR/NP and AUC.

For further information about the Ericsson Multi Activation redundancy concept,see Function Specification Ericsson Multi Activation 5.0.

2 155 10-CSH 150 82 Uen C 2007-01-24


1.3 Objectives

The aim of this document is to make it possible to integrate a CAS with EricssonMulti Activation. For specific low level parameters, additional documents (seeReference) must be used.

3155 10-CSH 150 82 Uen C 2007-01-24


4 155 10-CSH 150 82 Uen C 2007-01-24


2 CAI Overview

2.1 General

The CAI is capable of handling independent multiple sessions towards CAS.From each session all authorized Network Elements are accessible.

Figure 2 The Ericsson Multi Activation Message Flow

A provisioning operation initiated from the CAS to Ericsson Multi Activation isreferred as a Customer Service Order (CSO).

A CSO contains a Managed Object (MO) and one of the following actions:

• GET (to display an MO)

• CREATE (to create an MO)

5155 10-CSH 150 82 Uen C 2007-01-24


• DELETE (to delete an MO)

• SET (to modify an MO)

The MO contains the information to be transferred to or fetched from theNetwork Element. Each MO type corresponds to a specific network elementfunction.

Actions that influence network data are called provisioning operations andare logged by CAI. It is possible to see Network Service Orders (NSOs) thathave been sent, Network Element responses and the result of the completeprovisioning operation.

CAI has a security system which can be used to prevent non-authorizedoperators from accessing data in the networks. This is implemented by meansof access control. Any hostile attempt will result in an error response to CAS.

All provisioning operations are synchronized, which means that there are noprovisioning operation queues in CAI.

The NE redundancy concept sends data to the primary NE and then to thesecondary NE. Only commands that change data for the subscribers areduplicated (create/set/delete). This concept is available for HLR, FNR and AUC.

In general, CAI supports the full set of MOs. However, a site may be configurednot to have support for certain NEs. In such a case, an error explaining thatthe configuration did not allow the action is responded when CAI is trying toaccess non-supported MOs.

2.2 Distributed Configuration

Ericsson Multi Activation also has a routing concept that supports thedistribution of CSOs to other CAI compliant nodes without processing. Theconcept is called Distributed Configuration (DC). This concept allows a numberof CAI applications to be interconnected to form one logical application.

6 155 10-CSH 150 82 Uen C 2007-01-24


Figure 3 Distribution of Managed Objects

Ericsson Multi Activation forward CSOs to another CAI complaint nodeaccording to the routing definition. The destination may have the same setof MOs (another Ericsson Multi Activation for load sharing purpose) or atotally separate set of MOs (e.g., WGPSUB - Wireless Application ProtocolGateway/Proxy subscription). The routing definition is achieved by definingrouting paths upon number range like MO name, MO instance ranges (e.g.,MSISDN/IMSI ranges) or regular expression.

The DC concept gives the possibility to have CAI MOs distributed withinthe network. It is also possible to distribute the same MO on several CAIapplications, which are separated by MO instance ranges (for example,MSISDN/IMSI ranges).

Note: It is not necessary for all CAI applications to implement the distributedconfiguration functionality, if they are considered as the end destinationof the CAI requests.

Note: DC only supports command in standard CAI syntax, otherwise, code1002 (external error) is responded.

There are two provisioning operations that can only be used through DC:

• GETNEXT (to receive the next object after a successful GET operation)

• CANCELGET (to cancel the fetching of multiple response after retrieving aGET response)

For more information about the distribution of the MOs, see SystemAdministration Graphical User Interface Ericsson Multi Activation 5.0.

7155 10-CSH 150 82 Uen C 2007-01-24


8 155 10-CSH 150 82 Uen C 2007-01-24


3 Communication Protocol

3.1 General

The CAI is based on proprietary Ericsson presentation and session layers.

Figure 4 The Communication stack Layers

Basic features of the CAI are:

• semi-permanent connection

• synchronous, one message always followed by its response

• ASCII-character based presentation and session layer

• multiple concurrent sessions

The following standards can be used as transport and network layers:

• X.25, 1988, 1984

• TCP/IP

• TELNET

A connection is always initiated from CAS. First the transport layer is set up,either X.25, TCP/IP or TELNET. If it is possible to open a connection, a sessionis created using a login sequence. After a successful login, data can betransferred.

To terminate a session, a logout sequence is used followed by a disconnectionof the transport layer.

Note that when using X.25, the transport layer is transparent and equal tothe network layer.

9155 10-CSH 150 82 Uen C 2007-01-24


For further information on how to connect CAS to CAI, see SystemAdministrators Guide Ericsson Multi Activation 5.0 Database Based.

3.2 Transport and Network Layer

The type of transport and network layers (protocols X.25, TELNET) to be usedare decided upon software installation. If more than one protocols are used theamount of concurrent sessions on each protocol is dependent upon the numberof sessions the other protocol is using.

Depending on the type of protocol (X.25, TELNET), a set of configurationparameters are available. Reconfiguration of these parameters are possiblewithout a new software installation. At time of reconfiguration, ongoing sessionsmust be disconnected.

From CAS point of view each Ericsson Multi Activation is associated witha specific network address. Depending on the type of transport layer, thisaddress can either be an X.25 address (see X.25 standard and alsoSection16.3 on page 299) or an IP address. This address can be used for all parallelsessions initiated from CAS.

For X.25 it is also possible to use sub-addressing in order to distinguish onesession from another. The same scheme can also be used with TELNET.However, in this case it is not the IP address which differs but instead thespecific user identity.

3.2.1 X.25

The X.25 shall conform to the CCITT standard 1988 or 1984.

A typical set of configuration parameters are found in Section 16 on page 297.

CAI supports X.25 point-to-point as well as X.25 over a network.

The connection type used is virtual call (VC) and CAS is always the initiatingside of a call, see below.

Figure 5 Successful Virtual Call

When a virtual call is established, data in both directions can be transferred.

10 155 10-CSH 150 82 Uen C 2007-01-24


The optional ‘Facility’ field and the ‘Call user data’ field are not used in a CALLREQUEST packet.

If Ericsson Multi Activation for some reason cannot answer to a call, a CLEARREQUEST with appropriate clearing cause and diagnostic code is sent back,see below.

Figure 6 Sequence Showing a Rejected Virtual Call

Any side may choose to clear the call by sending a CLEAR REQUEST withappropriate clearing cause and diagnostic code, see below.

Figure 7 Sequence Showing Clearing of a Virtual Call

After a call is cleared, the CAI is immediately ready to accept new calls.

3.2.2 Direct Socket Communication

TCP/IP used in Ericsson Multi Activation means TCP over IP. It is a connectionoriented protocol providing a reliable, full-duplex and byte stream for a userprocess. TCP takes care of communication details such as acknowledgements,timeouts, retransmissions.

11155 10-CSH 150 82 Uen C 2007-01-24


Figure 8 Packet Exchange for TCP Connection

CAS can communicate with Ericsson Multi Activation via TCP/IP using an IPaddress with the following format: <ip_address>:<port_number>. The defaultvalue of port_number is 3300.

If the Ericsson Multi Activation server has been set up correctly, Ericsson MultiActivation will listen to this port.

As for Figure 8 on page 12, once a connection between CAS and Ericsson MultiActivation is established, CAS can form a request and send it to Ericsson MultiActivation. Ericsson Multi Activation processes the request and responds toCAS. Status such as ESTABLISHED, LISTEN, CLOSE_WAIT and TIME_WAIT,can be displayed.

3.2.3 TELNET

Standard TELNET procedures are used to open a connection and it is assumedthat each end acts as network virtual terminals. The CAS is always the initiatingside and option negotiation may take place within the structure of TELNETProtocol see TELNET Protocol Specification. Any side may choose to clear the

12 155 10-CSH 150 82 Uen C 2007-01-24


connection. Once a connection is established, it is preferred that each messageis sent as one string. There are two ways of using TELNET:

a Each TELNET connection is associated with a user ID and a password inaccordance with Ericsson Multi Activation’s UNIX users. The usage of theCAI application is done through a ordinary UNIX login shell.

b Login is done via TELNET login on directly a TCP/IP port. No additionalUNIX login is required.

The advantages/disadvantages with the different approaches, are that usingthe UNIX shell login is more secure and TELNET connections directly onTCP/IP ports is much faster. For more information, see System AdministratorsGuide Ericsson Multi Activation 5.0 Database Based.

Below is a typical printout when establishing a connection towards a EricssonMulti Activation server (emaserver). As can be seen, firstly, a login to the Unixserver has to be performed before CAI can be accessed (the TELNET shellusage).

cas> telnet emaserver

Trying 136.225.100.204...

Connected to emaserver.

Escape character is ’^]’.

SunOS 5.8

Login: telcai

password:

Last login: Thu Aug 31 16:30:33 from 136.225.40.122

Sun Microsystems Inc. SunOS 5.8 Generic February2000

CONNECTING TO CAI...

PROCESS cai3300 CONNECTED...

Enter command:

3.3 Session and Presentation Layer

The session and presentation layers are proprietary Ericsson and support twotypes of messages:

• control messages

13155 10-CSH 150 82 Uen C 2007-01-24


• data messages (CSO)

A message is coded using standard 8-bit ASCII characters.

Up to 64 concurrent sessions can be used on each port. For further informationon how to use multiple concurrent sessions, see System Administrators GuideEricsson Multi Activation 5.0 Database Based.

Each session is independent of any previous opened sessions. Interferencebetween two sessions must be handled by the CAS. Ericsson Multi Activationdoes not guarantee a mutual exclusion, e.g., if two sessions are concurrentlyoperating on one and the same subscriber identity, one of the sessions may ormay not receive an error code back.

3.3.1 Opening a Session

CAS is the party which initialize a session. First, a channel is allocated viathe transport layer (either X.25 or TELNET). Thereafter CAS continues withsending a LOGIN control message (see Section 5.1 on page 21). EricssonMulti Activation answers with a response message.

Figure 9 A Successful Opening of a Session

<USER_ID> User ID (up to 16 characters)

<PWD> Password (up to 16 characters)

3.3.2 Closing a Session

When CAS needs to logout from Ericsson Multi Activation, it will send aLOGOUT control message (see Section 5.2 on page 21) and in turn EricssonMulti Activation will reply with a response message. Thereafter CAS clears thechannel. If CAS does not clear the channel within a configurable timeout time,Ericsson Multi Activation clears the channel.

14 155 10-CSH 150 82 Uen C 2007-01-24


Figure 10 A Successful Logout Sequence

3.3.3 Aborting a Session

When Ericsson Multi Activation needs to be terminated due to systemmaintenance, reconfiguration and so on, Ericsson Multi Activation may clearany ongoing sessions. If there is an ongoing message request, Ericsson MultiActivation must execute it and reply with a response before Ericsson MultiActivation may disconnect the transport layer.

Figure 11 Abort Ongoing Session

3.3.4 Distribution of Managed Objects

To make it possible to have distributed Managed Objects in the network,it is defined that a CAI application can accept CSO requests consisting ofoperations on objects that the current application does not support.

15155 10-CSH 150 82 Uen C 2007-01-24


Figure 12 Distribution of CSO Requests

This is accomplished by having a DC node configured. Using DC the currentCAI node can do a lookup and see what application in the network shall havethe actual request. The application establishes a connection over the transportlayer (if it does not already have one opened) and performs a login into the CAIapplication that is the target for the CSO. After a successful login the CAI node(CAI #1) forwards the CSO to the other CAI application (CAI #2). The initiator(CAI #1) waits for a response from the other application (CAI #2). When itreceives the response, the initiator forwards the response to the CAS.

Note that the interface between CAI applications is identical to the interfacebetween CAS/CAI.

For more information about how to configure DC see System AdministrationGraphical User Interface Ericsson Multi Activation 5.0.

16 155 10-CSH 150 82 Uen C 2007-01-24


4 Message Formats

The communication between CAS and Ericsson Multi Activation consists ofmessages, CAS sends message requests which are answered by EricssonMulti Activation with message responses.

4.1 Character Representation

All values - strings and numbers - shall be in coded ASCII, i.e., the decimalnumber 1285 should be transferred as 4 ASCII characters (‘1’, ‘2’, ‘8’ and ‘5’).

String values using unprintable characters (for example, ASCII value 0,LineFeed ASCII value 19) should use standard C conventions (‘\<ascii value>’)or the standard names for C (for example ‘\n’) to specify the character. Stringvalues must be quoted if they contain other characters than A-Z, a-z, 0-9, ‘-’ or‘_’, e.g., ‘‘string value’’. This type of string is further on called <full_string>.

If ‘\’ is part of the string, then the ASCII value or ‘\\’ must be used. If ‘"‘ is part ofthe string, then the ASCII value must be used or use ‘\”’.

Operations and attribute names are case sensitive. They must be in UpperCase.

4.1.1 Examples

String String in MessageRequest/ Messageresponse

Comment

AZ_09_az AZ-09-az String without "other"characters

AZ-09-ax<CR> AZ-09-ax\x0D <CR> represented by ahexadecimal ASCII value

\home\user<CR> \\home\\user\r <CR> represented by astandard C character constant

"quotes"<CR> \042quotes\042\15 quotes (’"’) and <CR>represented by octal ASCIIvalues

4.2 Message Request Format

Message requests contain a message operation identifier, i.e., the commandwhich shall be executed (see Section 1 on page 1). It is possible to uniquely

17155 10-CSH 150 82 Uen C 2007-01-24


identify a request, except for login/logout requests, with a transaction identifier.Each transaction identifier can have a string up to 32 characters to identify theprovisioning operations. It is possible to reuse the transaction identifier, if theCAS system wants to group a number of provisioning operations.

All message requests (provisioning operations) that cause data changes inthe network are logged.

In a case where a parameter occurs more than once within a command, thefollowing priorities applies:

1 If possible (by nature of parameter) do ‘append’

2 Otherwise, let the last supplied parameter be valid

Figure 13 A Message Request

<operation> The operation indicates what action that will be takentowards a target. One of the following operations mustbe used:

- CREATE

- SET

- DELETE

- GET

<target> A target can be either a managed object or an operatorID (login name).

Figure 14 <target> command

<op_id> Operator ID (up to 16 characters). A number ofcharacters which should be in the intervals A-Z, a-z,0-9 or an ’_’ (underscore).

<mo> The mo indicates which Managed Object to operate on.A number of characters which should be in the intervalsA-Z, a-z, 0-9, or an ’_’ (underscore).

18 155 10-CSH 150 82 Uen C 2007-01-24


<transaction_id> The transaction id of the provisioning operation, whichis a string value consisting of 1-32 characters in theintervals A-Z, a-z and 0-9.

<ARGn> [1-n] parameters separated by colon (:).

Figure 15 <ARGn> command

<attr_name> The name of the attribute in Upper Case letters.

<subattr_name> The name of the subattribute in Upper Case letters.

<number> An unsigned integer value

<full_string> A number of characters, including white spaces andother unprintable characters enclosed in ‘‘ ’’

<string> A number of characters which should be in the intervalsA-Z, a-z and 0-9 or an ‘_’ (underscore).

<enum> Enumeration type. A <string> but with defined values.

The whole message is terminated with a semicolon (;). Between the separators(‘:’ and’,’) there can be an optional number of white spaces (tabs and spaces).

4.3 Message Response Format

Message responses contain a message response code <resp_code> which isa number, where ‘‘0’’ stands for a successful response, and any other value foran unsuccessful response. The request can also contain a transaction identifier<trans_id> depending on if there was a transaction identifier attached with themessage request. The transaction identifier will only be sent together with theresponse if the message request does not contain any syntactical errors.

Figure 16 A Provisioning Operation Response

<transaction_id> The transaction identifier of the provisioning operation.Same value as in the message request.

19155 10-CSH 150 82 Uen C 2007-01-24


<resp_code> See “Message Response” section of each chapter.

As with the message request format, the whole message is terminated with asemicolon (;) and between the separators (‘:’and ‘,’) there can be an optionalnumber of white spaces (tabs and spaces).

Figure 17 A Get Response

<transaction_id> The transaction identifier of the provisioning operation.Same value as in the message request.

<resp_code> See “Message Response” section of each chapter.

<attr_name> The name of the attribute in Upper Case letters.

<value> The attribute value.

Figure 18 The attribute value response

If a requested attribute name has no values attached, only the <attr_name>will be displayed. Parameters and attached values will only be displayed if theresponse code <resp_code> indicates a successful message response.

20 155 10-CSH 150 82 Uen C 2007-01-24


5 Control Commands

5.1 Login

The LOGIN command will log in the user on Ericsson Multi Activation. Thelogin passwords and User ID are stored in Ericsson Multi Activation parameterdatabase, see System Administrators Guide Ericsson Multi Activation 5.0Database Based.

5.1.1 Request Syntax

Figure 19 Login Command

<user_id> User ID (up to 16 characters).

<pwd> Password (up to 16 characters).

5.1.2 Response Syntax

Figure 20 Response

<resp_code> See Section 5.3 on page 22 for response codes.

5.1.3 Examples

Login request for User ID ‘‘EMA_OPER’’ with the password ‘‘SECRET’’:LOGIN:EMA_OPER:SECRET;

Response to a successful login: RESP:0;

Unsuccessful response to a login attempt with an invalid User ID or password:RESP:3006;

5.2 Logout

This command will log out the user from Ericsson Multi Activation. The requestwill be rejected if no user is logged on.

21155 10-CSH 150 82 Uen C 2007-01-24


5.2.1 Request Syntax

Figure 21 Logout Command

5.2.2 Response Syntax

Figure 22 Response

<resp_code> See Section 5.3 on page 22 for response codesdefinition.

5.2.3 Examples

Logout request: LOGOUT;

Successful logout: RESP:0;

Unsuccessful response to a logout attempt without logging in first: RESP:3007;

5.3 Message Response

Here follows a description of the possible message response codes that can bereceived in a message response. The tables contain a column Type, indicatingthe seriousness/category of each response. Available categories are

• Syntax error (S)

• Temporary error (T)

• Faulty data (D)

• Fatal error (F)

and they can be used as a guide line in error management procedures. Suitableactions are indicated in Section 17 on page 303.

Table 1 Control Commands

Descriptions RespCode

Type Log In LogOut

Successful 0 x x

Ericsson Multi Activation FATALERRORS (2001 -2100)

Ericsson Multi Activation databaseerror

2001 F x x

22 155 10-CSH 150 82 Uen C 2007-01-24



Type Log In LogOut

Internal Ericsson Multi Activationerror

2002 F x x

CAI ERRORS (3001-3100)

Invalid command 3001 S x x

Insufficient parameters 3004 S x

User ID/ password invalid or expired 3006 D x

Rejection, must login first 3007 S x

Invalid command sequence 3008 S x x

23155 10-CSH 150 82 Uen C 2007-01-24


24 155 10-CSH 150 82 Uen C 2007-01-24


6 HLR Subscription

Note: If the user has chosen the Splitted HLR and FNR licence duringinstallation, when doing provisioning towards HLR, Ericsson MultiActivation will cause no data update in FNR and will not query FNRfor any information. So, in this case, if there is any data need tobe updated in FNR for HLRSUB, the Operator should update themthrough FNSUB or NPSUB in addition. Refer to chapter 7 for detailedinformation about FNR provisioning.

If the user hasn’t chosen the Splitted HLR and FNR licence duringinstallation, when doing provisioning towards HLR, Ericsson MultiActivation will update data in FNR also, but the physical implementationof FNR behind HLR will be hidden for the user.

6.1 Composite Parameter Definitions

6.1.1 Subscriber Data

Each Subscriber Data parameter, either including in a message request orin a message response, shall be made up of an identifier followed by one ormore attributes (e.g., provision status, Basic Service Group, activation status,Forwarded-to number), defining the value of the parameter. Attributes areseparated by commas and parameters are separated by colons.

Figure 23 Subscriber Data Parameter

<Data id> Abbreviated name of the Subscriber Data or servicesee Section 6.4 on page 98.

<val/prov> Value of the Subscriber Data argument or provisionstate of a service.

<act> Activation state of a service.

25155 10-CSH 150 82 Uen C 2007-01-24


<fnum> Forwarded-to number applicable for call forwardingservices.

<nrpy_time> No-reply-time, only applicable for the service ‘CallForwarding on No ReplY’ (CFNRY).

OFA-<ofa> Origin Forward to number Analysis.

<subadd> Subaddress, can be added to the Forwarded-to number.

KEEP Keeps the original Forwarded-to number. Only can beused when the value of <act> is 0.

<bsg> Basic Service Group for which the service shall be(de)activated.

The Subscriber Data parameter must follow the rules as defined below. A tableof all possible Subscriber Data parameter together with their applicable valuescan be found in Section 6.3 on page 84 and abbreviations are explained inSection 6.4 on page 98.

6.1.1.1 Setting Subscriber Data / Providing Services

a If a Supplementary Service is only to be provided and not activated, onlythen will its provision status be given. This will deactivate the activatedservice and leaving it provided. e.g., CAW,1- provide call waiting, notactivated.

b If a service’s provision is being withdrawn, it can neither be activated norregistered. e.g., CFNRY,0 - do not provide CFNRY.

6.1.1.2 Activating Supplementary Services

a Supplementary services can be activated independently for each BasicService Group or for all subscribed BSG’s, e.g., BAIC,1,1,TS10- provideand activate BAIC only for the Basic Service Group ‘Speech transmissionservices’.

b If a service is to be activated it must be provided irrespectively of itsprevious provision status. If no BSG is specified the service will beactivated for all applicable BSG’s, e.g., BAIC,1,1 - provide and activateBAIC for all BSG’s subscribed.

c A service may be activated for several BSG’s at the same time byrepeating the required attributes for the different BSG identifiers. e.g.,BAIC,1,1,TS10,1,TS60 - provide and activate BAIC for the BSG’s ‘Speechtransmission services’ and ‘Facsimile transmission services’.

6.1.1.3 Registration of Forwarded-to numbers

a When activating (by registration) call forwarding services and singlepersonal number Supplementary Service, a Forwarded-to number must be

26 155 10-CSH 150 82 Uen C 2007-01-24


provided, e.g., CFNRC,1,1,46455381234,TS10 - provide, activate andregister CFNRC for Basic Service Group ‘Speech transmission services’with Forwarded-to number 491019120000. It is also possible to supply asubaddress with the Forwarded-to number, which is of the format: a-b -where a is 0,1 or 2 and b is 2 - 40 characters (in octet pairs). Each characterrepresenting a hexadecimal value 0-9, A-F, e.g., CFNRC,1,1,46455381234,1-0AFBE01C001A

b When activating (by registration) ‘Call forwarding on no reply’, aNo-reply-time may be specified (5s - 30s in 5s steps). If the No-reply-timeis not given then the HLR default No-reply-time will be taken: e.g.,CFNRY,1,1,46455381234,20 - a 20 sec. No-reply-time is set.

6.1.1.4 Origin for Forwarded-to Number Analysis

a Each time a subscriber registers a forwarding-to-number, a check isperformed in the HLR that this number is not restricted. Restricted numbersare those which are not allowed to be used for call forwarding e.g., thenumber to a police station. e.g., OFA,1 - 1 is origin for forwarding-to numberanalysis. When parameter OFA is required, and has not been specified inthe command, a value assigned as default to the mobile subscriber is used.

6.1.1.5 Deactivation / Keeping registration

a A Supplementary Service can be explicitly deactivated for a certain BasicService Group without the withdrawal of the service. e.g., BAIC, 1,0,TS10- Deactivate BAIC only for Basic Service Group ‘Speech transmissionservices’ and leave it provided.

b If no BSG is specified the service will be deactivated for all applicableBSG’s: e.g., BAIC,1,0 - deactivate BAIC for all applicable BSG’s but leaveit provided.

c If a service is withdrawn it will be automatically deactivated for all BasicService Groups. e.g. BAIC,0 - do not provide BAIC and thereforedeactivate.

d Upon the deactivation of a Supplementary Service the registeredForwarded-to number (and No-reply-time if applicable) is lost if it is notincluded in the deactivation request. When the service shall be reactivatedit must be specified again. e.g., CFNRC,1,0,TS10 - deactivate CFNRC, theForwarded-to number will not be kept. CFNRC,1,1,491019120000,TS10 -reactivate CFNRC, the Forwarded-to number must be specified again.

e The Forwarded-to number (and No-reply-time if applicable) will be keptupon deactivation of a service, if the Forwarded-to number is given inthe deactivation command. e.g., CFNRC,1,0,491019120000,TS10 -deactivate CFNRC but keep the Forwarded-to number as 491019120000.CFNRC,1,1,TS10 - activate CFNRC again, using the ‘‘old’’ Forwarded-tonumber.

27155 10-CSH 150 82 Uen C 2007-01-24


f There is another way to keep the Forwarded-to number upon deactivationof a service, if "KEEP" is given in the deactivation command, e.g.,CFNRC,1,0,KEEP,TS10 - deactivate CFNRC but keep the originalForwarded-to number. CFNRC,1,1,TS10 - activate CFNRC again, usingthe "old" Forwarded-to number.

6.1.1.6 Restrictions and Deviations

There are a number of Supplementary Service interactions possible in thenetwork that should be kept in mind when working with Subscriber Data.Interaction means that the activation/registration of service might be influencedby the provision/activation/registration of other Supplementary Services orthe roaming of the mobile subscriber. These interactions are described inSupplementary Service and Operator Determined Barring Interactions in HLR.

The applicability of some services are limited (see Section 6.3 on page 84).Furthermore, exceptional cases are:

SPN This service cannot be provided and activatedseparately. Therefore it is not possible to keep theregistered Forwarded-to number. Allowed requests are:

SPN, 0

Not provided/activated

SPN,1,1,<fnum>

Provided/Activate/Registered

DCF This service cannot be provided and activatedseparately. Therefore it is not possible to keep theregistered Forwarded-to number. Allowed requests are:

DCF, 0

Not provided/activated

DCF,1,1,<fnum>,<bsg>

Provided/Activate/Registered e.g.,

...DCF,1,1,46455381233,TS10,1,46455381234,TS60:..

.

TSD1 The teleservice ‘‘Auxiliary Telephony’’is automaticallyprovided if a dual MSISDN is defined for a subscription.A dual number is an additional MSISDN with BC 1associated to it. Therefore TSD1 cannot be provided, itis a ‘read-only’ subscriber data.

28 155 10-CSH 150 82 Uen C 2007-01-24


6.1.2 Profiles

All Subscriber Data excluding password, MSISDN and IMSI may be set inan HLR profile. For Supplementary Services (e.g., CFU) only the provisionstatus can be set.

HLR GPRS Subscriber Data or HLR CAMEL Subscriber Data can also be setinto an HLR GPRS profile or an HLR CAMEL profile, this function is supportedin HLR version R11 or later.

A GSM HLR has up to 256 profiles which can be defined through the GSM HLRAdministration application, see System Administration Graphical User InterfaceEricsson Multi Activation 5.0.

A GSM HLR has up to 256 GPRS profiles and up to 256 CAMEL profiles whichcan be defined through the GSM HLR Administration application. User can alsouse GPRS or CAMEL profile to define or modify a subscriber.

Figure 24 Profile Command

<profile_no> Profile number, 0 - 255 for a HLR

<gprsprofile_no> HLR GPRS Profile number, 0 - 255 for an HLR

<camelprofile_no> HLR CAMEL Profile number, 0 - 255 for an HLR

The usage of profiles for creation and modification of subscriptions is highlyrecommended because the requests can then be executed much faster. Theprofile data is copied to the subscription data within the HLR in one step.Without a profile, Ericsson Multi Activation sends at least one MML commandper argument (provided service) to the HLR.

Additional parameter in the message request will only be necessary if they arenot contained in the profile (e.g., activation of a service), or if profile parametervalues shall be replaced. Any additional argument will generate additionalMML commands, thereby increasing the time needed to create or to modify asubscription in the HLR.

29155 10-CSH 150 82 Uen C 2007-01-24


6.1.2.1 Usage of Profiles when Creating a Subscriber

a If a profile is used in the service request to define a subscriber the profiledata is copied. Assume Profile no.1 contains the following data:

OFA 1

CAT 10

SOCB 1

CAW 1

CFB 1

CFU 0

A message request to define a subscriber with profile no.1 might be:...MSISDN,46455381234: IMSI,12345678912345: PROFILE,1... Hence, arequest to display the Subscriber Data will return: ... MSISDN,46455381234: IMSI, 12345678912345: CAT,10: CAW, 1: CFB,1,0,TS10:CFU, 0:OFA,1:SOCB, 1:...

b Profile no.0 is the default profile in the HLR. When a subscriber is definedin the HLR, all the services and Subscriber Data specified in profile 0 will beallocated if no profile is specified in the request.

Note: Note that one should exercise with great care when changing profileno.0, since a CREATE operation always uses profile no.0 if no otherprofile is selected. This might cause operations like copying of oldsubscriptions (e.g., IMSI change-over) to generate unexpected result.

c To minimize the time required for defining a subscriber, only parametersspecifying different data to that in the relevant HLR profile should beincluded when creating a subscriber.

6.1.2.2 Usage of Profiles when Setting a Subscriber

a A profile may also be specified in a subscriber data setting request (usingoperation SET). Thus, the profile data will be copied to the subscription.

b There is no default profile for a setting request: If no profile is stated, nonewill be used.

c If a profile is used in a subscription setting request, then all previouslyassigned services and Subscriber Data are reset, excluding the subscriberpassword.

Note: This means that all services will be deactivated and previously definedForwarded-to numbers will be lost.

d Due to the fact that the profile data is copied when it is used, there is nocoupling between profile and subscription after the operation. This means

30 155 10-CSH 150 82 Uen C 2007-01-24


that already created/modified subscribers will not be affected by a updatedprofile.

6.1.3 Additional MSISDN

The HLR will make use of several MSISDNs called ‘‘Additional MSISDNs’’(AMSISDNs), so that each of them will be uniquely associated with a specificBearer Capability (BC). Up to 16 AMSISDNs can be defined per subscription.Each of them has an associated BC. AMSISDNs can be defined and deletedbut not modified for a certain subscriber.

Figure 25 Define AMSISDN when a Subscription is Created

<amsisdn_number>

Additional MSISDN (5-15 digits)

<bc_number> Bearer Capability number (0, 1, 2, 3, 8-65534) must bedefined in the HLR.

Figure 26 Delete AMSISDN when a Subscription is Modified

<amsisdn_number>


Figure 27 AMSISDN in a Combined Request (modification, deletion anddefinition)

<amsisdn_number>



Figure 28 Get Gubscription AMSISDN Response

<amsisdn_number>


31155 10-CSH 150 82 Uen C 2007-01-24



<bs> Basic Service identifier. The Basic Service isrepresented by an associated Bearer Capabilitynumber. The connection between the Basic Serviceand its associated Bearer Capability number is donein the HLR.

6.1.3.1 Definition of Additional MSISDNs

a AMSISDN data can be defined with the same message request to createa subscriber: e.g., CREATE:HLRSUB:MSISDN,46455381234:IMSI,12345678933333:PROFILE,1:AMSISDN,DEF,46455381222,9,DEF,46455381223,10... - Creates a subscriber and defines the AMSISDN46455381222 associated with Bearer Capability No.9 and the AMSISDN46455381223 associated with Bearer Capability No.10 for the newsubscriber.

b The Bearer Capability which shall be associated with an AMSISDN must bealready defined in the HLR. The value range for GSM Bearer Capabilitiesis 0, 1, 2, 3, 8-65534. The BC No.1 is pre-defined and reserved for theteleservice ‘Auxiliary Speech’ and BC No.8 and No.9 are pre-defined andreserved for the teleservice ‘Automatic Facsimile group 3’. The BC No.2is used to define a dual subscription and BC No.3 is used to change themaster subscription in a dual subscription that is defined previously

6.1.3.2 Deletion of Additional MSISDNs

a AMSISDNs can be deleted with the message request to modify asubscriber. e.g., :SET:HLRSUB:MSISDN,46455381234:AMSISDN,DEL,46455381222,DEL,46455381223,... - Both AMSISDNs for the subscriptionare deleted.

b It is possible to delete and define AMSISDNs with the same messagerequest, e.g., SET:HLRSUB:MSISDN,46455381234:AMSISDN,DEL,46455381222,DEL,46455381223,DEF,46455381225,25,DEF,46455381226,26... - Deletes the AMSISDNs 4645538122 and46455381223. The AMSISDNs 46455381225 and 46455381226 aredefined and associated with the Bearer Capabilities No.25 and No.26.

c The DEL... and DEF... parts can occur in any order. However, it isrecommended to place the DEL... parts before the DEF... parts in order notto surpass the allowed numbers of AMSISDNs.

6.1.4 Customized Applications for Mobile Network Enhanced Logic(CAMEL)

Customized Applications for Mobile Network Enhanced Logic (CAMEL)services are pre-defined in the HLR, each subscriber can have one service fororiginating calls, one for terminating calls and one for GPRS calls.

32 155 10-CSH 150 82 Uen C 2007-01-24


6.1.4.1 Defining CAMEL Subscription Data

Figure 29 Defining CAMEL Subscription Trigger Detection Points

<mmtdp_number> Mobility Management CAMEL subscription data TriggerDetection Point. The possible values are “0-4” and“ALL” (only for DELETE operation). This parameter isvalid only for CAMEL phase 3. Note that <service_key>and <gsa_address> are mandatory when defining thisparameter for the first time.

<vttdp_number> Visitor MSC Terminating CAMEL subscription dataTrigger Detection Point. The possible values are “12”,“13”, “14” and “ALL” (only for DELETE operation). Thisparameter is valid only for CAMEL phase 3.

<osmstdp_number>

Originating SMS CAMEL subscription data TriggerDetection Point. The possible values are “1” and “ALL”(only for DELETE operation). DP SMS Collectedinformation. This parameter is valid only for CAMELphase 3.

<octdp_number> Originating CAMEL subscription data Trigger DetectionPoint. The value can be “2”, “4” and “ALL” (only forDELETE operation).

<tctdp_number> Terminating CAMEL subscription data Trigger DetectionPoint. The possible values are “12”, “13”, “14” and “ALL”(only for DELETE operation).

33155 10-CSH 150 82 Uen C 2007-01-24


<gprstdp_number> GPRS CAMEL subscription data Trigger DetectionPoint. Application system dependent parameter, thevalue can be one of following: “1”, “2”, “11”, “12”, “14”and “ALL” (only for DELETE operation).

If GPRSTDP is set in the command, the CAMELsubscription data will be applicable in the GPRSnetwork. This parameter is valid only for CAMEL phase3.

<i_value> Inhibition indicator. Application System dependentparameter. Default value is “N”.

<tsmstdp_number>

Terminating SMS CAMEL subscription data TriggerDetection Point. The possible values are "2"(SMSDelivery Request) and "ALL"(only for DELETEoperation). This parameter is valid only for CAMELphase 4.

<dstdp_number> Dialled service CAMEL subscription data TriggerDetection Point. The possible values are "1-10" and"ALL"(only for DELETE operation). This parameter isvalid only for CAMEL phase 4.

<dialnum> Dialled number. Expressed as na-dial where:

• na: Nature of address indicator

-0: Unknown

-1, 2: Not used

-3: National number

-4: International number

• dial: Dialled number series.Text string 1-15characters. Only digits 0-9, *, #, a, b and c areallowed as characters.

<gsa_address> GSM SCF Address (3-15 digits)

<service_key> Service Key number (0-2147483647)

<deh_value> Default Error Handling value (0-1)

<cch_value> CAMEL Capability Handling. Application systemdependent parameter (possible values are “1” - “4”).

If OCTDP is set as “4” or TCTDP is set as “13” or “14”in the command, or VTTDP/MMTDP is set, CCH canaccept value “3” only. Default value 1 is assigned whenCCH is not present.

34 155 10-CSH 150 82 Uen C 2007-01-24


If GPRSTDP or OSMSTDP is set in the command, CCHcan accept value 3 only. Default value 3 is assignedwhen CCH is not present.

If DSTDP is set in the command, CCH can accept value3 only. Default value 3 is assigned when CCH is notpresent.

If TSMSTDP is set in the command, CCH can acceptvalue 4 only. Default value 4 is assigned when CCHis not present.

Figure 30 Defining CAMEL Conditional Triggering Criteria Data

<mty> Match Type, possible values are “E”(Enabling) or “I”(Inhibiting). Note: this parameter is mandatory whensetting the parameter <dnum> and <dlgh> for the firsttime, and it shall NOT be used again when setting othervalues of <dnum> and <dlgh>.

<dnum> Destination Number expressed as na-nb format wherena can be 0-4 and nb can be 1-15 digits, “*”, “#” or “ALL”(only for DELETE operation).

<dlgh> Destination number length, the possible values are 1-15or “ALL” (only for DELETE operation).

<ftc> Forwarding Triggering Criteria. The possible values are“N”(Not forwarding) or “F”(Forwarding).

<bs> Basic Service. It is used to define basic servicetriggering criteria, the possible values are “TS11”,“TS61”, “TS62”, “TSD1”, “BS21”, “BS22”, “BS23”,“BS24”, “BS25”, “BS26”, “BS2G”, “BS31”, “BS32”,“BS33”, “BS34”, “BS3G” and “ALL” (only for DELETEoperation).

35155 10-CSH 150 82 Uen C 2007-01-24


<bsg> Basic Service Group identifier. it is used to define basicservice triggering criteria, the possible value are “TS10”,“TS60”, “TSD0”, “TS20”, “TS30” and “ALL” (only forDELETE operation).

<cch> CAMEL Capability Handling. Application systemdependent parameter (possible values are “1” -“4”).

a CAMEL subscriber data can be defined by defining either one or two orall of the followings: Originating CAMEL Subscription Trigger DetectionPoints (OCTDP), Terminating CAMEL Subscription Trigger DetectionPoints (TCTDP), GPRS CAMEL Subscription Trigger Detection Points,Terminating SMS CAMEL subscription data Trigger Detection Point andDialled service CAMEL subscription data Trigger Detection Point:

CREATE:HLRSUB:IMSI,12345678933333:MSISDN,46455381234:

CAMEL,DEF,OCTDP,2,GSA,45000000,SK,1234,DEH,1,DEF,TCTDP,

12,GSA,45000000,SK,3234,DEH,1,DEF,GPRSTDP,1,GSA,98765432,

SK,1234333,DEH,0,CCH,3,DEF,TSMSTDP,2,SK,1234,GSA,8888,DEH,1,CCH,4,DEF,DSTDP,1,DIALNUM,3–1234,SK,1234,GSA,8888.DEH,1,CCH,3:...

The above example shows how to create a subscriber in HLR with aCAMEL service. One for originating calls on detection point 2, one forterminating calls on detection point 12, one for GPRS calls on detectionpoint 1, one for terminating SMS calls on detection point 2 and one fordialled service calls on detection point 1.

b To define CAMEL Conditional Triggering Criteria Data, e.g.,

CREATE:HLRSUB:MSISDN,46455381234:CAMEL,DEF,CCAMEL,

OCTDP2,FTC,F,CCH,2,...

This example creates Conditional Triggering Criteria Data for originatingcalls on detection point 2, and forwarding triggering criteria on CAMELphase 2.

36 155 10-CSH 150 82 Uen C 2007-01-24


6.1.4.2 Changing CAMEL Subscription Data

Figure 31 Changing the data in the CAMEL Subscription Trigger DetectionPoints


<osmstdp_number>




<tsmstdp_number>

Terminating SMS CAMEL subscription data TriggerDetection Point. The possible values are "2"(SMSDelivery Request) and "ALL"(only for DELETE

37155 10-CSH 150 82 Uen C 2007-01-24


operation). This parameter is valid only for CAMELphase 4.













38 155 10-CSH 150 82 Uen C 2007-01-24


Figure 32 Changing the Extended CAMEL Data for a Subscriber

<etick> Extended Terminating IN Category Key (0-999)

<etinci> Extended Terminating IN Capability Indicator (0-255)

<eoick> Extended Originating IN Category Key (0-999)

<eoinci> Extended Originating IN Capability Indicator (0-255)

Figure 33 Changing the Optional CAMEL Subscription Data

<gcso> CAMEL Subscription Option when CAMEL phase 1 isnot supported in the interrogating GMSC (0-1).

39155 10-CSH 150 82 Uen C 2007-01-24


<sslo> CAMEL Subscription Option Subscriber State andLocation Information (0-1).

<mcso> MSC/VLR CAMEL Support subscription Option whenCAMEL phase 1 is not supported in the servicingMSC/VLR (0-2).

<mc2so> MSC/VLR CAMEL Support subscription Option whenCAMEL phase 2 is not supported in the servicingMSC/VLR (0-2).


<mc4so> MSC/VLR CAMEL Support subscription Option whenCAMEL phase 4 is not supported in the servicingMSC/VLR (0–2).

<gc2so> CAMEL subscription Option when CAMEL phase 2 isnot supported in the interrogating GMSC (0-1).


<gc4so> GMSC/gsmSCF CAMEL Support subscription Optionwhen CAMEL phase 4 is supported in the servicingGMSC/gsmSCF (0–1).

<tif> Translation Information Flag (0-1).

<gprsso> GPRS CAMEL phase3 denied Subscription Option(0-1), Application system dependent parameter.

<osmsso> Originating SMS CAMEL denied Subscription Option(0-2), Application system dependent parameter.

<tsmsso> Terminating SMS CAMEL phase 4 denied subscriptionoption(0-2), Application system dependent parameter.

<mmso> Mobility Management CAMEL denied SubscriptionOption (0-1), Application system dependent parameter.

a To change the subscription data for either one or two or all of the followings:Originating Trigger Detection Points, Terminating Trigger Detection Points,GPRS Trigger Detection Points, Terminating SMS CAMEL subscriptiondata Trigger Detection Point and Dialled service CAMEL subscription dataTrigger Detection Point. This is done per detection point. e.g.,

SET:HLRSUB:MSISDN,46455381234:CAMEL,SET,OCTDP,2,

SK,9876:...

40 155 10-CSH 150 82 Uen C 2007-01-24


The example shows how to change the service key for the OriginatingCAMEL Subscription Data Trigger Detection Point 2 to 9876.

b To change the Optional CAMEL Subscription Data. e.g.,

SET:HLRSUB:MSISDN,46455381234:CAMEL,SET,OCAMEL,

GCSO,1,MCSO,0,GC2SO,0:...

This request changes the GSM CAMEL Subscription Options. ApplyODB of all incoming calls when no CAMEL phase is supported in theinterrogating GMSC. Allow mobile subscriber’s registration in the servingMSC/VLR without sending any CAMEL data when no CAMEL data isallowed to be sent to the MSC/VLR. Allow call terminating handling withCAMEL phase 1 invocation when CAMEL phase 2 is not supported in theinterrogating GMSC.

c To change the Extended CAMEL Subscription Data. e.g.,

SET:HLRSUB:MSISDN,46455381234:CAMEL,SET,ECAMEL,

ETINCI,123,EOICK,9:...

The example above changes the Extended Terminating IN CapabilityIndicator to 123 and the Extended Originating IN Capability Key to 9. Animportant note is that it is only possible to change an Extended OriginatingCAMEL service if an Originating CAMEL Subscription Data TriggerDetection Point is already defined for the subscriber, the same behaviorgoes for the Extended Terminating CAMEL data.

d DEF, DEL and SET requests may occur in any order. e.g.,

SET:HLRSUB:MSISDN,46455381234:CAMEL,DEF,OCTDP,2,

GSA,451000000,SK,123,DEH,1,SET,OCAMEL,GCSO,1,

SET,ECAMEL,EOICK,123,DEL,TCTDP,12:...

This example defines an Originating Trigger Detection Point 2, changesthe optional CAMEL data attribute GCSO to 1 and the extended CAMELattribute EOICK to 123. The TCTDP 12 is removed from the subscriptiondata.

Note: It is possible to combine different CAMEL operations in one commandby using the SET, DEL and DEF delimiter. That means it is possible tocombine one ECAMEL, one OCAMEL, one or more OCTDP, TCTDPand GPRSTDP requests in one command.

41155 10-CSH 150 82 Uen C 2007-01-24


6.1.4.3 Deleting CAMEL Subscription Data

Figure 34 Deleting CAMEL Subscription Trigger Detection Points

<octdp_number> Originating CAMEL subscription data Trigger DetectionPoint. The value can be “2”, “4” and “ALL” (“4” onlyavailable in HLR R10, and “ALL” only for DELETEoperation).

<tctdp_number> Terminating CAMEL subscription data Trigger DetectionPoint. The possible values are “12”, “13”, “14” and “ALL”( “13” and “14” are only available in HLR R10, and “ALL”only for DELETE operation).



<osmstdp_number>


<mmtdp_number> Mobility Management CAMEL subscription data TriggerDetection Point. The possible values are “0-4” and“ALL” (only for DELETE operation). This parameter isvalid only for CAMEL phase 3.

42 155 10-CSH 150 82 Uen C 2007-01-24



<tsmstdp_number>








Figure 35 Deleting CAMEL Conditional Triggering Criteria Data

43155 10-CSH 150 82 Uen C 2007-01-24




<ftc> Forwarding Triggering Criteria.


<bsg> Basic Service Group identifier. it is used to define basicservice triggering criteria, the possible value are “TS10”,“TS60”, “TSD0”, “BS20”, “BS30” and “ALL” (only forDELETE operation).

a The deletion of the CAMEL subscription data is done foreach CAMEL Subscription Data Trigger Detection Point. e.g.,SET:HLRSUB:MSISDN,46455381234:CAMEL,DEL,OCTDP,2:...

b If the parameter OCTDP or TCTDP is used followed by specified ALL, allthe originating or termination CAMEL subscription data of the specifiedphase are removed.

If the parameter GPRSTDP is used followed by specified ALL, all the GPRSCAMEL subscription data are removed.

44 155 10-CSH 150 82 Uen C 2007-01-24


6.1.4.4 Displaying CAMEL Subscription Response

45155 10-CSH 150 82 Uen C 2007-01-24


Figure 36 Displaying CAMEL Subscription Response

<mmtdp_number> Mobility Management CAMEL subscription data TriggerDetection Point. The possible values are “0-4” and“ALL” (only for DELETE operation). This parameter isvalid only for CAMEL phase 3. Note that <service_key>and <deh_value> is mandatory when defining thisparameter for the first time.


<osmstdp_number>



<tsmstdp_number>



46 155 10-CSH 150 82 Uen C 2007-01-24






<dialnum> Dialled number. Expressed as na-dial where:

• na: Nature of address indicator

-0: Unknown

-1, 2: Not used

-3: National number

-4: International number

• dial: Dialled number series.Text string 1 - 15characters. Only digits 0-9, *, #, a, b and c areallowed as characters.







47155 10-CSH 150 82 Uen C 2007-01-24




<etick> Extended Terminating IN Category Key (0-999)

<etinci> Extended Terminating IN Capability Indicator (0-255)

<eoick> Extended Originating IN Category Key (0-999)

<eoinci> Extended Originating IN Capability Indicator (0-255)

<gcso> CAMEL Subscription Option when CAMEL phase 1 isnot supported in the interrogating GMSC (0-1).

<sslo> CAMEL Subscription Option Subscriber State andLocation Information (0-1).

<mcso> MSC/VLR CAMEL Support subscription Option whenCAMEL phase 1 is not supported in the servicingMSC/VLR (0-2).



<mc4so> MSC/VLR CAMEL Support subscription Option whenCAMEL phase 4 is not supported in the servicingMSC/VLR (0–2).



<gc4so> GMSC/gsmSCF CAMEL Support subscription Optionwhen CAMEL phase 4 is supported in the servicingGMSC/gsmSCF (0–1).

<tif> Translation Information Flag (0-1).

<gprsso> GPRS CAMEL phase3 denied Subscription Option(0-1), Application system dependent parameter.

48 155 10-CSH 150 82 Uen C 2007-01-24


<osmsso> Originating SMS CAMEL denied Subscription Option(0-2), Application system dependent parameter.

<tsmsso> Terminating SMS CAMEL phase 4 denied subscriptionoption(0-2), Application system dependent parameter.

<mmso> Mobility Management CAMEL denied SubscriptionOption (0-2), Application system dependent parameter.

<mty> Match Type, possible values are “E”(Enabling) or “I”(Inhibiting).



<ftc> Forwarding Triggering Criteria. The possible values are“N”(Not forwarding) or “F”(Forwarding).


<bsg> Basic Service Group identifier. it is used to define basicservice triggering criteria, the possible value are “TS10”,“TS60”, “TSD0”, “BS20”, “BS30” and “ALL” (only forDELETE operation).

Example:

RESP:0:RESP:0:MSISDN,22220000:IMSI,11110000:AUTHD,"NO ACCESSTO AUC":CAMEL,TSMSTDP,2,GSA,8888,SK,1234,DEH,1,CCH,4,OCAMEL,GCSO,0,SSLO,0,MCSO,0,GC2SO,0,MC2SO,0,MC3SO,0,MC4SO,0,GC3SO,0,GC4SO,0 GPRSSO,0,OSMSSO,0,TSMSSO,1,MMSO,0,ECAMEL,ETICK,0,ETINCI,0,EOICK,0,EOINCI,0:NAM,1:CAT,10:DBSG,1:OFA,0:PWD,0000:SCHAR,0-0;

6.1.5 Closed User Groups

Closed User Group (CUG) is an Ericsson specific feature that makes it possibleto group a number of subscribers with equal restrictions/possibilities.

49155 10-CSH 150 82 Uen C 2007-01-24


Figure 37 <CUG data> Command

6.1.5.1 Closed User Group Subscription

A subscriber can be a member of up to 10 CUGs. A subscriber can join or forma Closed Used Group. A Closed User Group can have different restrictions fordifferent groups of members.

Each Closed User Group is defined by an unique Interlock Code (IC). Followingrestrictions are possible to attach to the CUG subscription:

a Incoming Calls Barred within CUG (ICB)

b Outgoing Calls Barred within CUG (OCB)

c No restrictions within CUG (NONE)

To create a CUGSUB attribute the following syntax is applied:

Figure 38 Create CUGSUB

<index> CUG Index (0-32767)

<ic> Interlock Code, the value format falls into two parts thatare connected with a "-". The range starts from “0000-0”to “9999-65535”.

<restriction> CUG restriction, can be one of following: “ICB”, “OCB”or “NONE”.

<bsg> Basic Service Group is attached by CUG member ship.It can be one of the following: “BS20”, “BS30”, “TS10”,“TS60” or “TSD0”.

<add_bsg> Add BSG flag, only the default value set (1) could bespecified indicating that BSG is added to the CUG.

50 155 10-CSH 150 82 Uen C 2007-01-24


Figure 39 Changing CUGSUB




<add_bsg> Add BSG flag, if set (1) the specified BSG is added tothe CUG, else if reset (0) the BSG is removed. Defaultvalue is (1).

Figure 40 Deleting CUGSUB

<index> CUG Index (0-32767, ALL)

Figure 41 Combined modified message requests, definition/changing/deletionof CUGSUBs




51155 10-CSH 150 82 Uen C 2007-01-24



<add_bsg> Add BSG flag, if set (1) the specified BSG will be addedto the CUG, else if reset (0) the BSG will be removed.Default value is (1).

In case of a modifying message request, defining/changing/deleting ofCUGSUBs can be combined in any order.

E.g. SET:HLRSUB:....:CUGSUB,DEF,12,0017–2871,ICB,BS20,DEL,1,DEL38,SET,34,OCB,TS60,0:...

The message response of a request to display a subscriber contains theCUGSUB data in following format:

Figure 42 Displaying a Subscriber Response





E.g. RESP:0:...:CUGSUB, 12, 0007-98, ICB, BS20, TS20, 78, 0089-457,OCB, TS10:...

6.1.5.2 Closed User Group BSG options

It is possible to change an HLR subscriber‘s CUG Basic Service Group optionsvia the attribute CUG. The options that can be attached to a CUG BSG are:

a Access, determines the specific access for a BSG. Can be one of following:- Outgoing Access (OA) - Incoming Access (IA) - Outgoing and IncomingAccess (OIA) - No access (NONE)

b Preferential CUG index, determines the default CUG to be used by thenetwork when no explicit CUG index is received from the mobile subscriber.

The CUG BSG options argument syntax is defined as follows:

52 155 10-CSH 150 82 Uen C 2007-01-24


Figure 43 Closed User Group options

<access> Access attribute, can be: “OA”, “IA”, “OIA” or “NONE”.

<pcug> Preferential CUG index (0-32767, NONE)

<bsg> Basic Service Group, can be one of the following:“TS10”, “TS60”, “TSD0”, “BS20”, “BS30”.

A CUG BSG options set can be used in an ordinary CREATE/SET operation,e.g., SET:HLRSUB:...:CUG, IA, TS10, OA, 76, TS60:...

The message response of a request to display a subscription contains theCUG data in following format:

Figure 44 CUG Response

<prov> The provision state (0-1) of the Closed User GroupBSG options. If set to zero, the other values will notbe displayed.

<access> Access attribute, can be: “OA”, “IA”, “OIA” or “NONE”.

<pcug> Preferential CUG index (0-32767, NONE)

<bsg> Basic Service Group, can be one of the following:“TS10”, “TS60”, “TSD0”, “BS20”, “BS30”.

6.1.6 Mobility Management Related IN Triggering

Figure 45 Defining Mobility Management Related IN Triggering data

<detection_point> The detection point which should be triggered (0-1)

<gsa_address> The GSM SCF address which points out the SCF node(5-15 digits)

53155 10-CSH 150 82 Uen C 2007-01-24


<service_key> The service key value which points out the IN service inthe SCF node. (0-2147483647)

<act_value> Activate/deactivate the Mobility Management RelatedIN Trigger data for a specific Detection Point (0-1).

Figure 46 Changing data for a Mobility Management Related IN TriggerDetection Point

<detection_point> The detection point which should be triggered. (0-1)

<gsa_address> The GSM SCF address which points out the SCF node.(5-15 digits)


<act_value> Activate/deactivate the Mobility Management RelatedIN Trigger data for a specific Detection Point. (0-1)

Figure 47 Deleting Mobility Management Related IN Trigger data


Figure 48 Displaying subscription Mobility Management Related IN Triggerresponse


<gsa_address> The GSM SCF address which points out the SCF node.(5-15 digits)


<act_value> Activate/deactivate the Mobility Management RelatedIN Trigger data for a specific Detection Point. (0-1)

54 155 10-CSH 150 82 Uen C 2007-01-24


6.1.6.1 Defining a Mobility Management Related IN Trigger

a When defining the Mobility Management Related IN Trigger data, theDetection Point, the GSM SCF address and the service key has to beprovided in the request. e.g.,

SET:HLRSUB:MSISDN,46455381234:MOBINT,DEF,DP,1,

GSA,491000000,SK,12345:...

This example defines a Mobility Management Related IN Trigger on theDetection Point 1 for the subscriber with MSISDN 46455381234. The GSMSCF address to the IN service is 491000000 and the Service Key is 12345.

6.1.6.2 Changing Mobility Management Related IN Trigger data

a It is possible to change the Mobility Management Related IN Trigger datawhich should be used for a specific Detection Point, it is also possible toactivate/deactivate a specific Detection Point. e.g.,

SET:HLRSUB:MSISDN,46455381234:MOBINT,

SET,DP,1,SK,565656,ACT,1:...

The Mobility Management Related IN Trigger data which points out the INservice that should be used when Detection Point 1 is triggered will pointon the new Service Key value 565656 and will be activated.

6.1.6.3 Deleting Mobility Management Related IN Trigger data

a The deletion of the Mobility Management Related IN Trigger data is doneby using the Detection Point as an identifier. e.g.,

SET:HLRSUB:MSISDN,46455381234:MOBINT,DEL,DP,1:...

This example removes the Mobility Management Related IN Trigger datafor Detection Point 1.

6.1.7 Removing References Of IMSI Change-over

If the Change-over procedure (see Section 8.1 on page 149) is in the state‘Executed’ or ‘Forced’ the new IMSI is being in operation but the reference tothe old IMSI is still being kept. This reference can be removed to complete thewhole procedure and to free the old IMSI for further usage. If the Change-overprocedure is not in the state ‘Executed’ or ‘Forced’ this request fails.

A delete associated old IMSI argument is defined as follows:

Assoc old IMSI = ASSOCOLDIMSI, DEL

55155 10-CSH 150 82 Uen C 2007-01-24


This argument can only be assigned to a SET operation, e.g.,SET:HLRSUB:.....:ASSOCOLDIMSI, DEL:...;

6.1.8 GPRS

GPRS is a set of GSM phase 2+ bearer services that allows subscribers tosend and receive data in an end-to-end packet transfer mode. It enablesefficient use of network resources for packet mode data applications that exhibitcharacteristics such as non-periodic data transmission, frequent transmissionof small volumes of data or infrequent transmission of larger volumes of data.The permanent subscriber data for a GPRS subscription is stored in the HLR.A Network Access Mode (NAM) decides what type of network access thesubscriber has. It can be:

• Access to non-GPRS network only

• Access to GPRS network only

• Access to both non-GPRS network and GPRS network

The GPRS subscription data is handled in the HLRSUB MO in Ericsson MultiActivation. To differentiate the GPRS data from non-GPRS as well as toprovide a future-proof solution, two tags are defined: GPRS, starting tag ofall GPRS subscription data and PDPCONTEXT, starting tag of the contentsof PDP context. Below the syntax of GPRS subscription data administrationis described. Definition of attributes and their value is described in Table 2on page 85.

56 155 10-CSH 150 82 Uen C 2007-01-24


6.1.8.1 Syntax of Defining GPRS Subscription Data

Figure 49 Defining GPRS Subscription Data

<apnid> Access Point Name Identifier (integer 0-16383 or NS).

<pdpadd > Packet Data Protocol ADDress (IPaddress).

<pdpid> Subscriber PDP Context Identifier.

<vpaa> Visited Public land mobile network Address Allowed(0-1).

<eqosid> Extended Quality Of Service Identifier (integer 0-4095).

<pdpty> PDP Context Type, possible values are: “IPV4”, “IPV6”or “PPP” (IPV6 can only be used in HLR R10 and HLRR11).

<pdpch> PDP Context Charging Characteristics, the format ofthis parameter is “pdppi[-pdpgb]” where pdppi is PDPcontext Profile Index (integer 0-15), and the optionalvalue pdpgb is PDP context GSN Behavior index(integer 0–4095).

57155 10-CSH 150 82 Uen C 2007-01-24


Creating a subscriber with only GPRS Subscription data:

CREATE:HLRSUB:MSISDN,46455381234:IMSI,12345678933333:NAM,2:

TSMO,0:GPRS,DEF,PDPCONTEXT,APNID,1,PDPADD,136.225.1.1,EQOSID,

1,PDPCH,1,PDPTY,IPV4,DEF,PDPCONTEXT,APNID,2,EQOSID,2,

PDPCH,2,PDPTY,PPP,VPAA,0,DEF,PDPCONTEXT,APNID,2047,

PDPADD,136.225.1.2,EQOSID,4095,PDPCH,15,VPAA,1;

Creating a subscriber with both GPRS and non-GPRS Subscription data:

CREATE:HLRSUB:MSISDN,46455381234:IMSI,12345678933333:

AMSISDN,DEF,46455381235,9:CAT,10:CAW,1:NAM,0:TSMO,1:GPRS,

DEF,PDPCONTEXT,APNID,1,PDPADD,136.225.1.1,EQOSID,1,PDPCH,1,

PDPTY,IPV4,DEF,PDPCONTEXT,APNID,2,PDPCH,2,PDPTY,PPP,

VPAA,0,DEF,PDPCONTEXT,APNID,2047,PDPADD,

136.225.1.2,EQOSID,4095,PDPCH,15,VPAA,1;

6.1.8.2 Syntax of Setting GPRS Subscription Data

Note: The Set operation for GPRS Subscription data can only be used inHLR with version R11.

Figure 50 Setting GPRS Subscription Data

<apnid> Access Point Name Identifier (integer 0-16383 or NSor WILDCARD).

<pdpadd > Packet Data Protocol ADDress (IPaddress) or “ERASE”.


58 155 10-CSH 150 82 Uen C 2007-01-24




<pdpty> PDP Context Type, possible values are: “IPV4”, “IPV6”or “PPP” (IPV6 can only be used in HLR R10 and HLRR11).

<pdpch> PDP Context Charging Characteristics, the format ofthis parameter is “pdppi[-pdpgb]” where pdppi is PDPcontext Profile Index (integer 0-15), and the optionalvalue pdpgb is PDP context GSN Behaviour index(integer 0–4095). It can also be “ERASE”.

Examples:

SET:HLRSUB:MSISDN,22220000:GPRS,SET,PDPCONTEXT,PDPID,1,APNID,1,PDPADD,1.1.1.1,EQOSID,1,PDPCH,1-1,PDPTY,IPV4,VPAA,0;

SET:HLRSUB:MSISDN,22220000:GPRS,SET,PDPCONTEXT,PDPID,1,APNID,WILDCARD,PDPCH,ERASE,PDPADD,ERASE;

6.1.8.3 Syntax of Deleting GPRS Subscription Data

Figure 51 Deleting GPRS Subscription Data

Note: In order to identify an unique PDP context, both APNID and PDPADDmust be given. If static PDP addressing is used and PDPADD is notgiven at deletion, all the PDP contexts matching the APNID will beaffected.

<apnid> Access Point Name Identifier, possible values are“0-16383”, “NS” (Not Subscribed) or “ALL” (All APNassigned to the subscriber only used when deletingPDP context(s)).

<pdpadd> Packet Data Protocol ADDress (IPaddress).

<pdpid> Subscriber PDP context identifier.

Deleting GPRS Subscription data matching one APNID and one PDPADD:

SET:HLRSUB:MSISDN,46455381234:GPRS,DEL, PDPCONTEXT,APNID,1,PDPADD,136.225.1.1;

59155 10-CSH 150 82 Uen C 2007-01-24


Deleting GPRS Subscription data for all PDP contexts matching one APNID:

SET:HLRSUB:MSISDN,46455381234 :GPRS,DEL,PDPCONTEXT,APNID,1;

Deleting all GPRS Subscription data for a subscriber:

SET:HLRSUB:MSISDN,46455381234: GPRS,DEL,PDPCONTEXT,APNID,ALL;

6.1.8.4 Syntax of Retrieved GPRS Subscription Data

Figure 52 Responses of Displaying GPRS Subscription Data

PDPCONTEXT Start the definition for sub MO PDPCONTEXT.

<apnid> Access Point Name Identifier (integer 0-16383 or “NS”).

<pdpadd> Packet Data Protocol ADDress (IPaddress).



<pdpty> PDP Context Type, possible values are: “IPV4”, “IPV6”or “PPP” (IPV6 can only be used in HLR R10).

<pdpch> PDP Context Charging Characteristics, the format ofthis parameter is “pdppi[-pdpgb]” where pdppi is PDPcontext Profile Index (integer 0-15), and the optionalvalue pdpgb is PDP context GSN Behaviour index(integer 0–4095).


60 155 10-CSH 150 82 Uen C 2007-01-24


6.1.9 Gateway Mobile Location Center (GMLC) Address

Gateway Mobile Location Center is the PLMN node that interfaces to locationapplications which request GSM Location Services (LCS) for a specificsubscriber. The GMLC can perform location application authorizations tocheck the validity of the requesting application. There is wide range of locationapplications for the geographical positioning services, such as positioning ofvehicles for transport and taxi companies, positioning of emergency calls,positioning of stolen vehicles, detection of hot spots for micro-cells and so on.

6.1.9.1 Define Subscriber GMLC Address

Figure 53 DEFINE Subscriber GMLC Address

<gmlcid> GMLC Address identifier (0~255)

<hgmlcid> Home GMLC address identifier (0~255)

<pprid> Privacy Profile register address identifier (0~255)

a A mobile subscriber in the HLR can be assigned GMLC address.


GMLCA,DEF,GMLCID,33:...

GMLC address with identifier 33 is assigned to the mobile subscriber withMSISDN 3417429013.

Note: Up to 5 GMLC addresses can be assigned to a mobile subscriber.

61155 10-CSH 150 82 Uen C 2007-01-24


6.1.9.2 Delete Subscriber GMLC Address

Figure 54 DELETE Subscriber GMLC Address

<gmlcid> GMLC Address identifier (0~255 or “ALL”)

a A mobile subscriber’s GMLC address data previously defined can beremoved in the HLR.

SET:HLRSUB:MSISDN,49513789000:GMLCA,DEL,PPRID;

SET:HLRSUB:MSISDN,49513789000:GMLCA,DEL,HGMLCID;

GMLC address with identifier 125 is removed from the GMLC addresses ofthe mobile subscriber with MSISDN 3417429013.

Note: It is possible to remove all GMLC addresses for a mobile subscriberwhen GMLCID takes a value ALL.

6.1.9.3 Display Subscriber GMLC Address Response

Figure 55 Display Subscriber GMLC Address Response

<gmlcid> GMLC Address identifier (0~255)

<gmlcadd> GMLC address data (3~15 digits)

<hgmlcid> Home GMLC address identifier (0~255)

<hgmlcAdd> Home GMLC Address

<pprid> Privacy profile register address identifier (0~255)

62 155 10-CSH 150 82 Uen C 2007-01-24


<pprAdd> Privacy Profile Register Address

6.1.10 Location Services(LOCSERVICES)

Location Services are services related to the location of subscribers in thePLMN. For example, universal type service, related call service, unrelated callservice, related operator privacy and so on.

Figure 56 Defining, Changing and Deleting Subscriber Location Services data

<prov> “0” not activated; “1” activated.

<intidlist> Internal Identity List value. List of one or more types ofLOCSERVICES clients that are allowed to locate themobile subscriber. To add value, use “+0”, “+1”, “+2”,“+3”, “+4”, to remove value, use “-0”, “-1”, “-2”, “-3”, “-4”.

63155 10-CSH 150 82 Uen C 2007-01-24


<mocllist> LOCSERVICES Mobile Originating Class List, thepossible values are “+ASL”, “+BSL”, “+TTP” in definition,and “-ASL”, “-BSL”, “-TTP” or “-ALL” in deletion.

<eadd> External LOCSERVICES client Address (3-15 digits)

<gres> Restriction on the Gateway mobile location centre(0,1,9)

<notf> Location request restriction related to the Notification tothe mobile subscriber (0-4, default is 0)

<isCREL> 1, CREL; 0, CUNRL (default is 0)

<servt> Service Type. List of one or more service types forwhich an LCS client is allowed to locate the mobilesubscriber. 0-11 or 64-127.

0 Emergency services

1 Emergency alert services

2 Person tracking

3 Fleet management

4 Asset management

5 Traffic congestion reporting

6 Roadside assistance

7 Routing to nearest commercial enterprise

8 Navigation

9 City sightseeing

10 Localized advertising

11 Mobile yellow pages

64-127 Operator specific service types

ALL All service (only used in DEL sub-operation).

6.1.10.1 Defining Subscriber Location Services Data

a External Location Services data for a mobile subscriber can be defined.


64 155 10-CSH 150 82 Uen C 2007-01-24


LOCSERVICES,SET,MOCLLIST,+ASL,+BSL,

DEF,EADD,333,SET,SERVT,1,GRES,1,NOTF,1...

The External LOCSERVICES client address 333 and the LOCSERVICESmobile originating classes ASL and BSL for the mobile subscriber withMSISDN 12345678 are defined.

6.1.10.2 Changing Subscriber Location Services Data

a Location Services classes data for a mobile subscriber can be changed.

SET:HLRSUB:IMSI,12345678933333:MSISDN,12345678:

LOCSERVICES,SET,CREL,1,NOTF,1:...

Location request restriction for the call related privacy class already definedfor the subscriber with MSISDN 12345678 is changed to location requestallowed with notification.

6.1.10.3 Deleting Subscriber Location Services Data

a Location Services calsses data for a mobile subscriber can be removed.

SET:HLRSUB:IMSI,12345678933333:MSISDN,12345678:

LOCSERVICES,DEL,EADD,333,CREL,1...

Call related Location Services privacy class for the mobile subscriber withMSISDN 12345678 and external LOCSERVICES address 333 is ended.

65155 10-CSH 150 82 Uen C 2007-01-24


6.1.10.4 Displaying Subscriber Location Services Data Response

Figure 57 Displaying Subscriber LCOSERVICES Data Response

<prov> “0”, not activated; “1” activated.

<intidlist> Internal Identity List value (0-4)

<mocllist> LCS Mobile Originating Class List value (ASL, BSL,TTP)

<eadd> External LOCSERVICES client Address (3-15 digits)

<gres> Restriction on the Gateway mobile location centre(0,1,9)

<notf> Location request restriction related to the Notification tothe mobile subscriber. (0-4, default in 0)

<isCREL> 1, CREL; 0, CUNRL (default is 0)

<servt> Service Type. List of one or more service types forwhich an LCS client is allowed to locate the mobilesubscriber. 0-11 or 64-127.

0 Emergency services

1 Emergency alert services

2 Person tracking

66 155 10-CSH 150 82 Uen C 2007-01-24


3 Fleet management

4 Asset management

5 Traffic congestion reporting

6 Roadside assistance

7 Routing to nearest commercial enterprise

8 Navigation

9 City sightseeing

10 Localized advertising

11 Mobile yellow pages

64-127 Operator specific service types

ALL All service (only used in DEL sub-operation).

6.1.11 Spatial Trigger Support (SPATIALTRIGGER)

Spatial Trigger data is new feature in HLR R11 and it defines spatial triggersevent associated to a GMLC address identifier for a mobile subscriber in theHome Location Register (HLR).

Note: Spatial Trigger is only supported in HLR version 11 and higher.

6.1.11.1 Syntax of Define/Change/Delete Subscriber Spatial Trigger Data

Figure 58 Syntax of Define/Change/Delete Subscriber Spatial Trigger Data

<ste> Spatial triggers event. Numeral 0-15.

<gmlcid> Gateway Mobile Location Center (GMLC) addressidentifier. Numeral 0-255.

Examples:

...:SPATIALTRIGGER,DEF,STE,12,GMLCID,200:...

...:SPATIALTRIGGER,SET,STE,12,GMLCID,201:...

67155 10-CSH 150 82 Uen C 2007-01-24


6.1.11.2 Syntax of Retrieved Subscriber Spatial Trigger Data

Figure 59 Syntax of Retrieved Subscriber Spatial Trigger Data

<ste> Spatial triggers event. Numeral 0-15.

<gmlcid> Gateway Mobile Location Center (GMLC) addressidentifier. Numeral 0-255.

<gmlcat> Gateway Mobile Location Center (GMLC) address.

Example:

RESP:0:...:SPATIALTRIGGER,STE,12,GMLCID,200,GMLCA,49101924113:...

6.1.12 SMS Spam Control

SMS Spam control is a new feature in HLR R12. It prevents not desired SMSfrom reaching the subscriber.

6.1.12.1 Syntax of Define and Delete Subscriber SMS Data

Figure 60 Syntax of DEFINE and DELETE Subscriber SMS Spam Data

<scAdds> Short Message Service Centre (SMSC) address series.

6.1.12.2 Syntax of Retreived Subscriber SMS Spam Data

Figure 61 Syntax of Retreived Subscriber Spam Data

<active> Active status

<scAdds> Short Message Service Centre (SMSC) address series

68 155 10-CSH 150 82 Uen C 2007-01-24


6.1.13 Multiple SIM

Multiple SIM is a new feature in HLR R12. It defines multiple subscription datain the HLR. Up to four International Mobile Subscriber Identity Series (IMSIS)could be linked to a master subscription.

6.1.13.1 Syntax of Define, Set and Delete Subscriber Multiple SIM data

Figure 62 Syntax of DEFINE, SET and DELETE Subscriber Multiple SIM Data

Note: MCH is provided only once, that is when the Multiple SIM (MSIM) isdefined for the first time and not provided later on. Definition of MCH inDEF will result in MSIM initialization.

<imsi> The IMSI number of the subscription to be defined.

<mch> The Mobile Charge Rate Order number

<acImsi> Active IMSI

<mMsisdn> Master MSISDN

6.1.13.2 Syntax of Retreived Subscriber Multiple SIM Data

Figure 63 Syntax of Retreived Subscriber Multiple SIM Data

<active> Active Status


<mch> The Mobile Charge Rate Order number

69155 10-CSH 150 82 Uen C 2007-01-24


6.2 Customers Service Orders (CSO)

Note: The parameter sequence in CAI command is independent of theparameter sequence in MML command.

6.2.1 HLRSUB - CREATE

Subscriber Data may be assigned values according to Section 6.3 on page 84.The subscriber is set in-service upon definition.

6.2.1.1 Request Syntax

Figure 64 CREATE Command

<transaction_id> The transaction Id of the CREATE provisioningoperation.

<msisdn> The MSISDN number of the subscription to be defined.


<neDestAddress> Network Element Destination Address.

70 155 10-CSH 150 82 Uen C 2007-01-24


<profile> The profile containing the data that should be copied tothe new subscription, see Section 6.1.2 on page 29.

<Subscriber data> See Section 6.1.1 on page 25.

<GPRS data> See Section 6.1.8 on page 56.

<AMSISDN data> See Section 6.1.3 on page 31.

<CUG data> See Section 6.1.5 on page 49.

<CAMEL data> See Section 6.1.4 on page 32.

<MOBINT data> See Section 6.1.6 on page 53.

<GMLCA data> See Section 6.1.9 on page 61.

<LOCSERVIECSdata>

See Section 6.1.10 on page 63.

<prbt> Personal ring back tone. 0 for disabling PRBT support,and 1 for enabling PRBT support.

<SMSSPAM data> See Section 6.1.12 on page 68.

<MULTISIM data> See Section 6.1.13 on page 69.

6.2.1.2 Response Syntax

Figure 65 Response

<transaction_id> The transaction id of the CREATE provisioningoperation.


6.2.1.3 Examples

Message request to define a subscription with the following properties:

MSISDN 46455381234

IMSI 12345678933333

PROFILE 1

NAM 0

CAT 2

71155 10-CSH 150 82 Uen C 2007-01-24


CFU provided, active for TS10, Forwarded-to num.0241930203

AMSISDN No.46455383456, BC=20

PRBT 1

CREATE:HLRSUB:MSISDN,46455381234:IMSI,12345678933333:PROFILE,1:NAM,0:GPRS,DEF,PDPCONTEXT,APNID,99,PDPADD,78.54.125.8,EQOSID,4,VPAA,1:CAT,2:CFU,1,1,0241930203,TS10:AMSISDN,DEF,4645538456,20:PRBT,1;

Successful message response: RESP:0;

Unsuccessful message response, the MSISDN is already in use: RESP:2;

6.2.2 HLRSUB - SET

Note: If flexible numbering is used in the network it is recommended that IMSIis used in the set request for performance reason.

Note: If both MSISDN and IMSI number is used in a provisioning operationfrom CAS only IMSI will be used in the provisioning operations that issent to the NE and no check will be performed whether the MSISDNand IMSI belongs to the same subscription.

72 155 10-CSH 150 82 Uen C 2007-01-24



Figure 66 SET Command

<transaction_id> The transaction id of the SET provisioning operation.

<msisdn> The MSISDN number of the subscription to be modified.

<imsi> The IMSI number of the subscription to be modified.


<profile> The profile of which data should be copied to thesubscription, see Section 6.1.2 on page 29.

<Subscriber data> See Section 6.1.1 on page 25.


<AMSISDN data> See Section 6.1.3 on page 31.

<CUG data> See Section 6.1.5 on page 49 .

<Assoc old IMSI> See Section 6.1.7 on page 55.


73155 10-CSH 150 82 Uen C 2007-01-24



<LOCSERVICESdata>






Figure 67 Response



6.2.2.3 Examples

Message request to modify the following attributes of the subscription withMSISDN 46455381234:

CFU Not active for TS10, keep Forwarded-to number as0241930203

CFNRC Not active for TS10, keep the original Forwarded-tonumber

CFNRY Active for all Basic Services, Forwarded-to number0241930203

BAOC provided

AMSISDN Delete no.46455380001

AMSISDN Define no.46455380002, BC=20

SET:HLRSUB:MSISDN,46455381234:CFU,1,0,0241930203,TS10:CFNRC,1,0,KEEP,TS10:CFNRY,1,1,0241930203: BAOC,1:AMSISDN, DEL,46455380001, DEF,46455380002, 20;


Unsuccessful message response, the AMSISDN which shall be deleted isnot defined: RESP:48;

74 155 10-CSH 150 82 Uen C 2007-01-24


6.2.3 HLRSUB - GET

Subscriber Data parameters may take values as defined in Section 6.3 onpage 84.

Note that some Subscriber Data values may differ from those applicable for thesetting of Subscriber Data. Namely, the differences are:

a The activation status of Supplementary Services, when applicable, mayhave three status:

0 - not active

1 - active operational

2 - active quiescent

b In case of call forwarding services a Forwarded-to number <fnum> isdisplayed if registered. Additionally, for CFNRY the No-reply-time appears.

c The password may have a barred status. If this is the case then it isreturned in the message response as shown in Figure 68 on page 75.

d When using the service SOCB it is possible to get one of following values:0-3 (0-1 when setting the service).

Figure 68 Password Response

Note: It is recommended to handle the display request so that CAS will notbe affected by new HLR releases. This can be done by sending onlyused services in the display request. If a full response syntax is used,the results will be different depending on which release of the HLR therequest have been sent to.

Note: If flexible numbering is used in the network it is recommended that IMSIis used in the display request for performance reason.

Note: If both MSISDN and IMSI number is used in a provisioning operationfrom CAS only IMSI will be used in the provisioning operations that issent to the NE and no check will be performed if the MSISDN and IMSIbelongs to the same subscription.

75155 10-CSH 150 82 Uen C 2007-01-24



Figure 69 GET command

<transaction_id> The transaction id of the operation.

<msisdn> The MSISDN number of the subscription to bedisplayed.

<imsi> The IMSI number of the subscription to be displayed


<data_filter> Abbreviated name of the requested Subscriber Data,see section 8 for further details.

Without any given Data Filter all Subscriber Data will be displayed, otherwiseonly the requested attributes will be displayed. A table of possible SubscriberData parameters can be found in Section 6.3 on page 84.


Figure 70 Specified response (request to display a number of specified data)


<msisdn> The MSISDN number. Is only displayed if the responsecode is equal to 0.

<imsi> The IMSI number. Is only displayed if the responsecode is equal to 0.

76 155 10-CSH 150 82 Uen C 2007-01-24


<authenticationdata>

The authentication data. Possible values are“AVAILABLE”, “NO IMSI IN AUC”, “NO ACCESS TOAUC”, “STORAGE SHORTAGE”.

<data_id> Abbreviated name of the requested Subscriber Data,see Section 6.4 on page 98 for further details. Is onlydisplayed if the response code is equal to 0.

<data_value> Retrieved value(s). See Section 6.4 on page 98 forvalue formats. Is only displayed if the response codeis equal to 0.


Figure 71 Complete Response (Request to Display all Data)


<msisdn> The MSISDN number. The number is only displayed ifthe response code is equal to 0.

<imsi> The IMSI number. The number is only displayed if theresponse code is equal to 0.


<authenticationdata>

The authentication data. Possible values are“AVAILABLE”, “NO IMSI IN AUC”, “NO ACCESS TOAUC”, “STORAGE SHORTAGE”.

<AMSISDN data> As described in Section 6.1.3 on page 31.


77155 10-CSH 150 82 Uen C 2007-01-24


<CUG data> See Section 6.1.5 on page 49.

<Subscriber Data> The requested Subscriber Data. See sections 6.1.1and 6.1.4 for syntax. Possible Subscriber Data can befound in Section 6.3 on page 84. Is only displayed if theresponse code is equal to 0.



<GMLCA data> See Section 6.1.9 on page 61.

<LCS data> See Section 6.1.10 on page 63.




If there is no value attached to a subscriber attribute, only the attribute name isshown, e.g.,

RESP: 0:...: AMSISDN:...;

6.2.3.3 Examples

To display selected data of a subscriber with MSISDN, 46455381234:

GET:HLRSUB:MSISDN,46455381234:AMSISDN:CFU:CFNRC:CFNRY:CCUG:CUGSUB:CAMEL:GMLCA:LCS;

Successful message response from Ericsson Multi Activation is to displayselected data:

RESP: 0: MSISDN, 46455381234: IMSI,12345678933333:AMSISDN,46455381223,20, BS33

:CFU,1,0,TS10,0,TS60:CFNRC,1,0,TS10,0,TS60: CFNRY,1,0,,20,,TS10,0,TS60: CUG, 1, OA, 123, TS10, IA, 321, TS20:

:CUGSUB, 343, 1234-21, ICB, TS10, TS60: CAMEL,OCTDP,2,GSA,

49101924112,SK,0,DEH,0,CCH,1,OCAMEL,GCSO,0,MCSO,0,SSLO,0,GC2SO,0

:GMLCA,GMLCID,125,GMLCADD,345678:LCSD,UNIV,CREL,,NOTF,1,MOCL,BSL;

This describes a subscriber defined in the HLR as follows:

78 155 10-CSH 150 82 Uen C 2007-01-24


MSISDN 46455381234

IMSI 12345678933333

AMSISDN 46455381223, BC No. 20, BS33

CFU is provided but deactivated for TS10 (Speech) andTS60 (Fax)

CFNRC is provided but deactivated for TS10 (Speech) andTS60 (Fax)

CFNRY is provided but deactivated for TS10 (Speech) andTS60 (Fax)

CUG is provided with:

* outcoming access and preferential cug index 123 forTS10 (Speech)

* incoming access and preferential cug index 321 forTS20 (Short message)

CUGSUB is connected with following values:

* index = 343 * interlock code = 1234-21

* Incoming calls barred within the closed user group

* basic service groups = TS10 (Speech) and TS60 (Fax)

CAMEL OCTDP value 2, GSA value 49101924112, SK value 0,DEH value 0, CAMEL phase 1, GCSO value 0, MCSOvalue 0, SSLO value 0, GC2SO value 0, MC2SO value0, TIF value 0.

GMLCA GMLCID value 125, GMLCADD value 345678.

LCSD NOTF value 1, MOCL, basic self location.

PRBT 1.

To display all data of a subscriber with MSISDN 46455381234:

GET:HLRSUB:MSISDN, 46455381234;

Successful message response from Ericsson Multi Activation is to show allsubscriber data:

RESP: 0: MSISDN, 46455381234: IMSI,12345678933333:AUTHD,“NO ACCESS TO AUC” :AMSISDN, 46455381223,20,BS33: AOC,2: BAIC, 1:BAOC,1: BOIEXH,1,1,TS10,1,TS20:BS33,1: CAT,11: CAW,1: CFB,1,0,TS10: CFNRC,1,0,TS10:

79155 10-CSH 150 82 Uen C 2007-01-24


CFNRY,1,2,46304823310,20, TS10,2,46304823310,20,TS60:CFU,1,1,46101912000,TS10,1,46101912000,TS60: CLIP,1: COLP,1: CUG,1, OA, 123, TS10, IA, 321, TS20: CUGSUB, 343, 1234-21, ICB, TS10,TS60: DBSG,1: HOLD,1: OBOPRE,1: OBOPRI,1: OCSI,1: OFA,1: PWD,0876, BARRED: REGSER, 5678: SOCB,3: SOSDCF,7: TIN,1: TS11,1:TS21,1: TS22,1: TS62,1: VLRID, 3-53463598972: CAMEL,OCTDP,2,GSA,49101924112,SK,0,DEH,0,CCH,1: DEMLPP,2: EMLPP,1: MEMLPP,4:NAM, 2: GPRS,PDPCONTEXT,APNID,1,PDPADD, 136.225.1.1,EQOSID,1,PDPCONTEXT,APNID,2,PDPADD,136.225.1.2,EQOSID,2, VPAA,0,PDPCONTEXT,APNID,2047,PDPADD,136.225.1.2,EQOSID,31,VPAA,1:MOBINT,DP,1,GSA,49100000,SK,12345,ACT,1:PRBT,1;

A display message request containing requests to display some of asubscriber‘s call forwarding and barring services:

GET:HLRSUB:MSISDN, 46455381234: CFU: CFB: CFNRY: CFNRC: BAIC:BOIC;

Successful message response: RESP: 0: MSISDN, 46455381234: CFU,1,1:CFB, 1,1, 045574587: CFNRY,0:BAIC, 0: BOIC, 1,1;

This defines an HLR subscriber with following requested data:

MSISDN 46455381234

CFU Provided

CFB Provided and activated with Forwarded-to number045574587

CFNRY Not provided

BAIC Not provided

BOIC Provided and activated

Unsuccessful message response, no subscription with this MSISDN is defined:RESP:14;

6.2.4 HLRSUB - DELETE

Previously defined subscriptions can be deleted together with all dataassociated to the subscription.

Note: If flexible numbering is used in the network it is recommended that IMSIis used in the delete request for performance reason.


80 155 10-CSH 150 82 Uen C 2007-01-24



Figure 72 DELETE Command

<trans_id> The transaction id of the DELETE provisioningoperation.

<msisdn> The MSISDN number of the subscription to be deleted.

<imsi> The IMSI number of the subscription to be deleted.



Figure 73 Response



6.2.4.3 Examples

Request to delete the subscription with the MSISDN 46455381234and identify the provisioning operation with the number 12345:DELETE:HLRSUB:TRANSID, 12345:MSISDN, 46455381234;

Successful message response: RESP:TRANSID, 12345: 0;

Unsuccessful message response, no subscription with this MSISDN is defined:RESP:TRANSID, 12345: 14;

6.2.5 HLRMWINFO - GET

The CSO can print out all service center address stored in the message datawaiting list for the given subscriber.

81155 10-CSH 150 82 Uen C 2007-01-24






<imsi> The IMSI number of the subscription to be displayed.


Figure 75 Response


<resp_code> See Table 24 on page 119.

<msisdn> The MSISDN number is only displayed if the responsecode is 0.

<imsi> The IMSI number is only displayed if the response codeis 0.

<mce> Mobile station memory capacity exceeded. It can onlybe one of the following two values:

YES: indicates the mobile station memory capacity isexceeded

NO: indicates the mobile station memory is notexceeded

82 155 10-CSH 150 82 Uen C 2007-01-24


<mnr> Mobile station not reachable, only applicable in HLRR9 or earlier, It can only be one of the following threevalues:

NO: mobile station is reachable

MSC: mobile station not reachable through the MobileSwitch Centre(MSC)

SGSN: mobile station not reachable through the ServingGeneral Packet Radio Service Support Node

<mnrf> Mobile station not reachable, only applicable in HLRR9.1 or later, It can only be one of the following twovalues:

REACH: mobile station is reachable

NREACH: mobile station not reachable through theMobile Switch Centre(MSC)

<mnrg> Mobile station not reachable through the ServingGeneral Packet Radio Service Support Node, onlyapplicable in HLR R9.1 or later, It can only be one ofthe following two values:

REACH: mobile station is reachable

NREACH: mobile station not reachable through theMobile Switch Centre(MSC)

<scadd> Service Center(sc) address, expressed as na-ai where

na: Nature of address indicator (3 = National, 4 =International)

ai: Address information

6.2.5.3 Examples

GET:HLRMWINFO:MSISDN,3344556677;

All service center addresses contained in the message waiting data listcorresponding to the subscriber whose MSISDN is 3344556677 are printed.

RESP:0:MSISDN,3344556677:MCE,YES:MNR,MSC:SCADD,3-121212,4-232323;

or:

RESP:14; MSISDN not defined.

83155 10-CSH 150 82 Uen C 2007-01-24


6.3 Request and Response Parameters

Use Case specifies in which cases the parameter can be applied:

C - (Create) Parameter can take a value when a subscription/equipment iscreated.

S - (Set) Parameter can take a value when a subscription/equipment is modified.

D - (Delete) Parameter can take a value when a subscription/equipment isdeleted.

G - (Get) Parameter can take a value in the Get request for retrieving asubscription/equipment.

F - (Filter) Parameter can be used as filter in a Get request to indicate that wewant to retrieve the current value of this parameter.

R - (Returned) Parameter may be returned with a value in the answer to a Getrequest (depends on request issued and filter specified).

If a certain parameter is belonging to a Sub-MO the use case could also showin which sub-operation(s) the parameter can be used:

c - (Define, (create)) Parameter can be used in a DEF sub-operation.

s - (Set) Parameter can be used in a SET sub-operation.

d - (Delete) Parameter can be used in a DEL sub-operation.

These three sub-operation use case identifiers (c, s, d) will always appeardirectly after a Create or Set use case identifier (C, S). This shows whichsub-operations that are allowed in corresponding main operation.

If a certain parameter is belonging to a list value which can be seen as asimplified sub-MO the use case could also show in which sub-operation(s)the parameter can be used:

+ Parameter as a value can be added to a list attribute.

- Parameter as a value can be deleted from a list attribute.

These two sub-operation use case identifiers (+, -) will always appear directlyafter a Create or Set use case identifier (C, S). This shows which sub-operationsthat are allowed in corresponding main operation.

For example, use case: "CcScsdR" indicates that in a Create operation theparameter is allowed in a DEF sub-operation, in Set the parameter is allowedin DEF, SET or DEL sub-operation, in Delete it is not allowed at all and theparameter may be returned in the answer to a Get request.

84 155 10-CSH 150 82 Uen C 2007-01-24


For example, use case: "C+S-R" indicates that in a Create operation theparameter is allowed to be added to a list attribute, in a Set operation theparameter is allowed to be deleted from a list attribute and the parameter maybe returned in the answer to a Get request.

For further details about the HLR subscription parameter, see Home TranslationFunctions Changeable Exchange Adaption (HTRAN). The parameter/valuesare valid for all supported versions of actual NE type if otherwise is not statedin the tables.

Table 2 HLR Subscription Parameters

Parameters Attribute values Use Case

ACC 0-2(included in R7) CSRF

ACR 0–20 = not provided1 = provided not active2 = provided and active

CSRF

ARD 0 = UTRAN / GERAN access allowed1 = UTRAN access not allowed2 = GERAN access not allowed

CSRF

ASSOCOLDIMSI DEL S

AMSISDN 5-15 digits CSRF

BearerCapability: 0-1, 9-65534

AOC 0-2 CSRF

AUTHD “AVAILABLE”, “NO IMSI IN AUC”, “NO ACCESSTO AUC”, “STORAGE SHORTAGE”

RF

BAIC provision: 0-1 CSRF

activation:0-1

BSG:TS10, TS20, TS60, TSD0, BS20, BS30

BAOC provision: 0-1 CSRF

activation:0-1


BICRO provision: 0-1 CSRF

(excluded inGSM1900)

activation:0-1


BOIC provision: 0-1 CSRF


activation:0-1


BOIEXH provision: 0-1 CSRF

85155 10-CSH 150 82 Uen C 2007-01-24




activation:0-1


BS21 0-1 CSRF

BS22 0-1 CSRF

BS23 0-1 CSRF

BS24 0-1 CSRF

BS25 0-1 CSRF

BS26 0-1 CSRF

BS2F 0-5 CSRF

BS2G 0-1 CSRF

BS31 0-1 CSRF

BS32 0-1 CSRF

BS33 0-1 CSRF

BS34 0-1 CSRF

BS3F 0-4 CSRF

BS3G 0-1 CSRF

CAMEL CSRF

- CCH 1-4 CcScsdR

- DEH 0-1 CcScsR

- DIALNUM Dialled number. Expressed as na-dial where:na Nature of address indicator-0 Unknown-1,2 Not used-3 National number-4 International numberdial Dialled number series. Text string 1 - 15characters. Only digits 0-9, *, #, a, b and c areallowed as characters.

CcScsdR

- DSTDP 1-10, ALL(in DELETE only), this parameter isonly available in HLR R11 or later

CcScsdR

- GSA 3-15 digits CcScsR

- I Y/N CcScsR

- MMTDP 0-4, ALL(in DELETE only) (this parameter isincluded in R10)

CcScsdR

- VTTDP 12, 13, 14, ALL(in DELETE only) (this parameteris included in R10)

CcScsdR

- SK 0-2147483647 CcScsR

86 155 10-CSH 150 82 Uen C 2007-01-24



- OCTDP 2, 4 (4 is only available in HLR R10) CcScsdR

- TCTDP 12, 13, 14 (13 and 14 is only available in HLRR10)

CcScsdR

- GPRSTDP 1, 2, 11, 12, 14, ALL(in DELETE only), thisparameter is only available in R9.0 or later

CcScsdR

- OSMSTDP 1, ALL(in DELETE only), this parameter is onlyavailable in R9.1 or later

CcScsdR

- TSMSTDP 2, ALL(in DELETE only), this parameter is onlyavailable in HLR R11 or later

CcScsdR

- ECAMEL Composite Parameter SsR

- - EOICK 0-999 SsR

- - EOINCI 0-255 SsR

- - ETICK 0-999 SsR

- - ETINCI 0-255 SsR

- OCAMEL Composite Parameter SsR

- - GCSO 0-1 SsR

- - GC2SO 0-1 SsR

- - GC3SO 0-1 (included in R10) SsR

- - GC4SO 0-1 SsR

- - GPRSSO 0-1 (this parameter is only available in R9.1 orlater)

SsR

- - OSMSSO 0-2 (this parameter is only available in R9.1 orlater)

SsR

- - MCSO 0-2 SsR

- - MC2SO 0-2 SsR

- - MC3SO 0-2 (included in R10) SsR

- - MC4SO 0–2 SsR

- - MMSO 0-1 (included in R10) SsR

- - SSLO 0-1 SsR

- - TSMSSO 0-2 (included in HLR R11 or later version) SsR

- - TIF 0-1 SsR

- CCAMEL Composite Parameter (This parameter is onlyavailable in HLR R10)

SsR

- - BS TS11, TS61, TS62, TSD1, BS21, BS22, BS23,BS24, BS25, BS26, BS2G, BS31, BS32, BS33,BS34, BS3G, ALL(in DELETE only)

cd

- - BSG TS10, TS60, TSD0, BS20, BS30, ALL cd

87155 10-CSH 150 82 Uen C 2007-01-24



- - DLGH 1-15, ALL(in DELETE only) (this parameter isincluded in R10)

SsdR

- - DNUM format: na-nb, ALL (in DELETE only)na: (0-4)nb: 1-15 digits or * or #

SsdR

- - FTC N (Not forwarding) or F (forwarding) cd

- - MTY E or I SsR

CAPL 0-15 CSRF

CAT 0-13, 15, 224-254 CSRF

CAW provision: 0-1 CSRF

activation: 0-1

BSG: TS10, TS60, TSD0, BS20, BS30

CFB provision: 0-1 CSRF

activation: 0-1, 0-2 (when displaying asubscriber)

Forwarded-to number: 1-18 digits

OFA:OFA-<0-511>

Subaddress: expressed as a-b, where a is 0,1 or2 and b is 2-40 hexadecimal octets in pair

BSG:TS10, TS60, TSD0, BS20, BS30

CFNRC provision: 0-1 CSRF


Forwarded-tonumber: 1-18 digits

OFA:OFA-<0-511>

Subaddress: expressed as a-b, where a is 0, 1or 2 and b is 2-40 hexadecimal octets in pair


CFNRY provision: 0-1 CSRF



No-reply-time: 5, 10, 15, 20, 25, 30

OFA:OFA-<0-511>

Subaddress: expressed as a-b where a is 0,1 or2 and b is 2-40 hexadecimal octets in pair


88 155 10-CSH 150 82 Uen C 2007-01-24



CFU provision: 0-1 CSRF

activation:0-1, 0-2 (when displaying a subscriber)


OFA:OFA-<0-511>



CLIP 0-1 CSRF

CLIR 0-1 CSRF

COLP 0-1 CSRF

COLR 0-1 CSRF

CSP 1-255 CSF

CUG (excludedin GSM1900)

Preferential cug index: 0-32767, NONE CSRF

Access:OA, IA, OIA, NONE


CUGSUB(excluded inGSM1900)

index: 0-32767 CSRF

ic: 0000-0 to 9999-65535

restriction: ICB, OCB, NONE

BSG: BS20, BS30, TS10, TS60, TSD0

AddBSG flag: 0-1

DBSG 1,3,5,6 CSRF

DCF provision: 0-1 CSRF



No-reply-time: 5, 10, 15, 20, 25, 30

OFA:OFA-<0-511>



DEMLPP 0-6 CSRF

ECT 0-1 (included in HLR R10) CSRF

EMLPP 0-1 CSRF

89155 10-CSH 150 82 Uen C 2007-01-24



GMLCA this parameter is only available in R9 or later CSRF

- GMLCADD 3-15 digits R

- GMLCID 0-255, ALL (only applicated in deletion) CcScdR

- HGMLCADD String R

- PPRID 0–255 SsR

- PPRADD String R

GPRCSI 0-1 (this parameter is only available in HLR R9or later)

R

GPRS CSRF

- PDPCONTEXT Composive Parameter CcScdR

- - APNID integer 0-16383 or NS = Not Subscribed,or WILDCARD=WILDCARD, ALL = all APNassigned to the subscriber, only used whendeleting PDP context(s).

CcScdR

- - PDPADD IP Address or ERASEFor IPV4:oc1.oc2.oc3.oc4oc1:Numeral 0-255; oc2:Numeral 0-255;oc3:Numeral 0-255; oc4:Numeral 0-255)For IPV6 (included in R10 or later):hex1.hex2.hex3.hex4. hex5.hex6.hex7.hex8hex1: 0000-FFFF hex2: 0000-FFFFhex3: 0000-FFFF hex4: 0000-FFFFhex5: 0000-FFFF hex6: 0000-FFFFhex7: 0000-FFFF hex8: 0000-FFFF

CcScdR

- - PDPID 1-10 *** CcScdR

- - EQOSID integer 0-4095 (this parameter is only availablein HLR R9.1 or later)

CcScR

- - PDPCH format: pdppi[-pdpgb] or ERASEpdppi: 0-15pdpgb: 0-4095This parameter is only available in HLR R9.1 orlater.[-pdpgb] is only applicable in HLR R10 or later

CcScR

- - PDPTY string (size 3-4), three possible values IPV4,IPV6 and PPP (this parameter is only availablein HLR R9.1 or later, IPV6 could only be usedin HLR R10)

CcScR

- - VPAA 0 = not allowed, 1 = allowed (included in R8 orlater)

CcScR

HOLD 0-1 CSRF

HPN 0-2 CSRF

90 155 10-CSH 150 82 Uen C 2007-01-24



ICI 0-1 CSRF

IMSI 6-15 digits CDSGRF

IST 0, 15-2550 = subscriber not under IST condition.15-255 = subscriber under IST condition, ISTalert timer in minutes.

CSRF

ISTCSO 0-10 = call allowed when the IST Alert message isreceived from G(MSC-VLR).1 = call not allowed when the IST Alert messageis received from G(MSC-VLR).

CSRF

ISTGSO 0-10 = Service allowed when IST is not supported inthe interrogated GMSC1 = only Operator Determined Barring of allincoming calls when IST is not supported in theinterrogated GMSC.

CSRF

ISTVSO 0-10 = service allowed when IST is not supportedin the serving VLR1 = network induced activation of supplementaryservice Barring of All Outgoing Calls (BAOC)performed when IST is not supported in theserving VLR.

CSRF

LOCSERVICES (this parameter is only available in HLR R9 orlater)

CSRF

- CREL 0-1 CsSsR

- - NOTF 0-3 (default is 0, for HLR R9.1 or earlier)0-4 (default is 0, for HLR R10)

CcScsR

- CUNRL 0-1 CsSsR

- - NOTF 0-4 (default is 0) CcScsR

- EADD 3-15 digits CcScdsR

- - GRES 0, 1, 9 CcScsR


CcScsR

- - CREL 0, CUNRL; 1, CREL (default is 0)This parameter is applicable only in HLR R10.

CcScsR

- isCREL 0, CUNRL; 1, CREL (default is 0) CcScR

- MOCLLIST “+ASL”, “+BSL”, “+TTP” in definition, “-ASL”,“-BSL”, “-TTP”, “-ALL” in deletion.

Cs+Ss+-R

- PLMNO 0-1 CsSsR

91155 10-CSH 150 82 Uen C 2007-01-24



- - INTIDLIST “+0”, “+1”, “+2”, “+3”, “+4” in definition, “-0”, “-1”,“-2”, “-3”, “-4” in deletion.

Cs+Ss+-R

- SERVT 0-3 digits. CcScds

- - GRES 0, 1, 9 0, 1, 9 CcScsR


CcScsR

- UNIV 0-1 CsSsR

LOC vlraddress: expressed as na-ai, UNKNOWN,RESTRICTED, or BARRED, where na is 3 or 4,ai is up to 20 digits

RF

msrn: up to 15 digits

mscnumber: up to 20 digits

lmsid: 8 digits

sgsnnumber: up to 20 digits

MCA 0-1 CSRF

MEMLPP 0-6 CSRF

MOBINT DP:0-255 CSRF

GSA:3-15 digits

SK:0-2147483647

ACT:0-1

MPTY 0-1 CSRF

MSISDN 5-15 digits CDSGRF

MULTISIM (this parameter is only available in HLR R12 orlater)

CSRF

- ACIMSI Digit string 6–15, each digit 0–9 Ss

- IMSI 6-15 digits CDSGRF

- MCH 0–1 CcSsR

- MMSISDN Digit string 5–15, each one 0–9 Ss

NAM integer: 0-2 CSRF

0 = both non-GPRS and GPRS

1 = non-GPRS only

2 = GPRS only

KEEP: Retain/Not retain subscriber data relatedto the network, to which access is not allowed.

S

0 = Do not keep subscriber data, default value.

1 = Keep subscriber data.

92 155 10-CSH 150 82 Uen C 2007-01-24



neDestAddress Each digit is 0–9 or #10–#14. F

OBA 0-1 CS

OBCT 0-4 (included in HLR R10) CSRF

OBDCT 0-1 (included in HLR R10) CSRF

OBI 0-2 CSRF

OBMCT 0-1 (included in HLR R10) CSRF

OBO 0-4 CSRF

OBOPRE 0-1 CSRF

OBOPRI 0-1 CSRF

OBP 0-3 (included in HLR R10) CSRF

OBR 0-99 (standard HLR only supports 0-3) CSRF

OBRF 0-5 CSRF

OBSSM 0-1 CSRF

OBZI 0-1 CSRF

OBZO 0-3 CSRF

OCSI 0-1 RF

OFA 0-511 CSRF

OICK 0-999 CSRF

OIN 0-1 CSRF

OSB1 0-1 CSRF

OSB2 0-1 CSRF

OSB3 0-1 CSRF

OSB4 0-1 CSRF

OSMCSI 0-1 R

PAI 0-1 CSRF

PDPCP 1-255 CSF

PICI (excluded inGSM1900)

format a[-b]a: 0-255b: 0-2 (included in R10)

CSRF

PICI2 format: a[-b]a: 0-255b: 0-2 (included in R10)

CSRF

PICI3 format: a[-b]a: 0-255b: 0-2This parameter is only applicable in HLR R10.

CSRF

93155 10-CSH 150 82 Uen C 2007-01-24



PROFILE 0-255 CS

PRBT 0, 1 CSR

PWD 0000-9999 CSRF

barredstatus: NONE, BARRED (only GET)

RED 0-1 RF

REDMCH 1-2 CSRF

REGSER 0-65534 CSRF

RSA 0-128 (included in R10) CSRF

RTCA 0-1 CSRF

SCHAR format: pdppi[-pdpgb]pdppi: 0-15pdpgb: 0-4095([-pdpgb] is only applicable in HLR R10 and later)

CSRF

SMSPAM 0-1 CSRF

SMSSPAM (this parameter is only available in HLR R12 orlater)

CSRF

- SCADDS Digit string 1–15, each one 0–9 CcSsR

- ACTIVE 0–10 = not active1 = active

R

SOCB 0-1, 0-3 (when displaying a subscriber) CSRF

SOCFB 0-3 CSRF

SOCFRC 0-1 CSRF

SOCFRY 0-3 CSRF

SOCFU 0-1 CSRF

SOCLIP 0-1 CSRF

SOCLIR 0-2 CSRF

SOCOLP(excluded inGSM1900)

0-1 CSRF

SODCF 0-3 CSRF

SOSDCF 1-7 CSRF

SPATIALTRIGGER

(this parameter is only available in HLR R11 orlater)

CSRF

- STE 0-15 CcScdsR

- GMLCID 0-255 cScsR

- GMLCA 0-3 digits R

94 155 10-CSH 150 82 Uen C 2007-01-24



SPN provision: 0-1 CSRF

activation:0-1, 0-2 (when displaying a subscriber)

Forwarded-tonumber: 1-18 digits

OFA:OFA-<0-512>

BSG:TS10

STYPE 0-127 CSRF

TCSI 0-1 R

TEARDOWN 1 S

TICK 0-999 CSRF

TIN 0-1 CSRF

TS11 0-1 CSRF

TS21 0-1 CSRF

TS22 0-1 CSRF

TS61 0-1 CSRF

TS62 0-1 CSRF

TSD1 0-1 RF

TSMO integer: 0-1 CSRF

0 = transfer of SM via the MSC

1 = transfer of SM via the SGSN

VLRID UNKNOWN RF

RESTRICTED

BARRED

3-<nationalVLR address> (up to 16 digits)

4-<internationalVLR address>(up to 16 digits)

DUALSTAT 0-1 R

0 = Subscription is not linked

1 = Subscription is linked

ACTYPE 0-1 SR

0 = location updating

1 = subscriber procedure

** Quality of Service is expressed as rc-dc-pc-pt-mt. See Section 6.3.1 onpage 96.

95155 10-CSH 150 82 Uen C 2007-01-24


*** The use of parameter PDPID is dependent of if the HLR has the PDPIDpatch or not. If HLR has the patch installed, PDPID is a mandatory parameterotherwise it is not allowed.

6.3.1 HLR GPRS quality of service parameters

Table 3 RC - Reliability Class

rc Number Description

1 Acknowledged General Packet Radio Service TunnelingProtocol (GTP), Logical Link Control (LLC) and Radio LinkControl (RLC); protected data.

2 Unacknowledged GTP; acknowledged LLC and RLC; protecteddata.

3 Unacknowledged GTP and LLC; acknowkledged RLC; protecteddata.

4 Unacknowledged GTP, LLC and RLC; protected data.

5 Unacknowledged GTP, LLC and RLC; unprotected data

Table 4 DC - Delay Classes

dc Number Description

1 Delay class 1

2 Delay class 2

3 Delay class 3

4 Delay class 4

Table 5 PC - Precedence Classes

pc Number Description

1 High priority

2 Normal priority

3 Low priority

Table 6 PT - Peak Throughput

pt Number Description

1 Up to 1000 octet/s





96 155 10-CSH 150 82 Uen C 2007-01-24


pt Number Description





Table 7 MT - Mean Throughput

mt Number Description

1 100 octet/h

2 200 octet/h

3 500 octet/h

4 1000 octet/h

5 2000 octet/h

6 5000 octet/h

7 10000 octet/h

8 20000 octet/h

9 50000 octet/h

10 100000 octet/h

11 200000 octet/h

12 500000 octet/h

13 1000000 octet/h

14 2000000 octet/h

15 5000000 octet/h

16 10000000 octet/h

17 20000000 octet/h

18 50000000 octet/h

31 Best effort

6.3.2 HLR Message Waiting Parameters

Table 8 HLR Message Waiting Parameters

Parameters Attribute Values Use Case

MSISDN 5-15 digits GRF

IMSI 6-15 digits GRF

97155 10-CSH 150 82 Uen C 2007-01-24



MCE mobile station memory capacity exceeded,should be one of the two values (only in HlrR8Version):YES,NO

RF

MNR mobile station not reachable (only in HLR R9 orearlier), should be one of the three values: NO,MSC, SGSM

RF

MNRF mobile station not reachable (only in HLR R9.1 orlater), should be one of the two values: REACH,NREACH

RF

MNRG mobile station not reachable through SGSN (onlyin HLR R9.1 or later), should be one of the twovalues: REACH, NREACH

RF

SCADD Service center address list expressed as na-ai. RF

6.4 HLR Subscriber Data Abbreviations

6.4.1 Bearer Services

Table 9 Bearer Services

SUD Descriptions

BS20 All Data Circuit Asynchronous

BS21 Datacircuit asynchronous 300 baud


BS23 Datacircuit asynchronous 1200-75 baud




BS2F Fall-back asynchronousbearer service

BS2G General asynchronousbearer service

BS30 All Data Circuit Synchronous

BS31 Datacircuit synchronous 1200 baud




BS3F Fall-back synchronousbearer service

BS3G General synchronous bearer service

98 155 10-CSH 150 82 Uen C 2007-01-24


6.4.2 Tele Services

Table 10 Tele Services

SUD Descriptions

NAM Network Access Mode

TS10 All speech transmission services

TS11 Telephony

TS21 Shortmessage MT/PP

TS22 Shortmessage MO/PP

TS60 Facsimilei Basic Service Group

TS61 Alternatespeech/fax group 3 transparent

TS62 Automaticfacsimile group 3

TSD0 Auxiliary speech services

TSD1 Auxiliary telephony

TSMO Transfer of Short Message Option

6.4.3 Barring Services

Table 11 Barring Services

SUD Descriptions

BAIC Barring of All Incoming Calls

BAOC Barring of All Outgoing Calls

BICRO Barring of All Incoming Calls when RoamingOutside the home PLMN country

BOIC Barring of All Outgoing International Calls

BOIEXH Barring of All Outgoing International Calls Exceptthose directed to the Home PLMN country

6.4.4 Call Forwarding Services

Table 12 Call Forwarding Services

SUD Descriptions

CFB CallForwarding on mobile subscriber Busy

CFNRC CallForwarding on mobile subscriber Not Reachable

CFNRY CallForwarding on No Reply

CFU CallForwarding Unconditional

99155 10-CSH 150 82 Uen C 2007-01-24


SUD Descriptions

DCF DefaultCall Forwarding

SPN Single Personal Number

6.4.5 Line Identification Services

Table 13 Line Identification Services

SUD Descriptions

CLIP CallingLine Identification Presentation

CLIR CallingLine Identification Restriction

COLP ConnectedLine identification Presentation

COLR Connected Lineidentification Restriction

6.4.6 Operator Determined Barring Services

Table 14 Operator Determined Barring Services

SUD Descriptions

OBA all incoming and outgoing calls

OBI all Incoming calls

OBO all Outgoing calls

OBOPRE Outgoing Premium Rate calls (Entertainment)

OBOPRI Outgoing Premium Rate calls (Information)

OBSSM Supplementary Service Management

OBR Roaming

OBRF of Registrationof Forwarded-to number

OBZI Incoming Inter-Zonalcalls

OBZO Outgoing Inter-Zonalcalls

OSB1 Specific Barring in HPLMN (Type 1)




100 155 10-CSH 150 82 Uen C 2007-01-24


6.4.7 Subscription Options

Table 15 Subscription Options

SUD Descriptions

SOCB ControlOf Barring services

SOCFB CallForwarding on mobile subscriber Busy

SOCFRC CallForwarding on mobile subscriber not Reachable

SOCFRY CallForwarding on no Reply

SOCFU CallForwarding Unconditional

SOCLIP CallingLine Identification Presentation

SOCLIR CallingLine Identification Restriction

SOCOLP ConnectedLine identification Presentation

SODCF DefaultCall Forwarding

SOSDCF SupplementaryDefault Call Forwarding

6.4.8 Closed User Groups

Table 16 Closed User Groups

SUD Descriptions

INDEX CUG Index

IC Interlock Code

RESTRICTION CUG Restriction

BSG Basic Service Group

ADD BSG Add BSG Flag

ACCESS Access attribute

PCUG Preferential CUG

6.4.9 CAMEL

Table 17 CAMEL

SUD Descriptions

OCTDP Originating CAMEL Subscription Data Trigger DetectionPoint

TCTDP Terminating CAMEL Subscription Data Trigger DetectionPoint

GPRSTDP GPRS CAMEL Trigger Detection Point

OSMSTDP Originating SMS Trigger Detection Point

101155 10-CSH 150 82 Uen C 2007-01-24


SUD Descriptions

MMTDP Mobility Management Trigger Detection Point

MTY Match Type

FTC Forwarding Triggering Criteria

VTTDP Visitor MSC Terminating Trigger Detection Point

OSMSSO Originating SMS CAMEL denied subscription option

GSA GSM SCF Address

SK Service Key

DEH Default Error Handling

GCSO GMSC CAMEL Support subscription Option

MCSO MSC/VLR CAMEL Support subscription Option

MMSO Mobility Management CAMEL denied Subscription Option

SSLO Subscription State and Location

ETICK Extended Terminating IN Category Key

ETINCI Extended Terminating IN Capability Indicator

EOICK Extended Originating IN Category Key

EOINCI Extended Originating IN Capability Indicator

MC2SO MSC/VLR CAMEL phase 2 Support



GC2SO GMSC CAMEL phase 2 Support



TIF Translation Information Flag

GPRSSO GPRS Subscription Option

I Inhibitor Indicator

CCH CAMEL Capability Handling

6.4.10 GPRS Services

Table 18 GPRS Services

SUD Descriptions

APNID Access Point Name IDentifier

PDPADD Packet Data Protocol ADDress

EQOSID Extended Quality Of Service identifier

102 155 10-CSH 150 82 Uen C 2007-01-24


SUD Descriptions

OBP Operator Determined Barring of Packet OrientedServices

SCHAR GPRS Subscriber Charging Characteristic

VPAA Visited Public land mobile network Address Allowed

PDPID Subscriber PDP context identifier

PDPCH PDP Context Charging Characteristics

PDPTY PDP Context Type

6.4.11 Location Print Services

Table 19 Location Print Services

SUD Descriptions

MSCNUMBER Mobile Switching Centre (MSC) number

MSM Mobile Station Roaming Number (MSRN)

LMSID Local Mobile Station Identity (LMSID)

SGSNNUMBER Serving General Packet Radio Service (GPRS)Support Node (SGSN) number

VLRADDRESS Visitor Location Register (VLR) address

6.4.12 GMLC Address

Table 20 GMLC Address

SUD Descriptions

GMLCID GMLC Identifier

GMLCADD GMLC Address data

HGMLCADD Home GMLC Address

HGMLCID Home GMLC Address Identifier

PPRID Privacy Profile Register Address Identifier

PPRADD Privacy Profile Register Address

103155 10-CSH 150 82 Uen C 2007-01-24


6.4.13 Location Services(LOCSERVICES)

Table 21 Location Services

SUD Descriptions

UNIV Universal location services privacy class

CREL Call Related location services privacy class

CUNRL Call Unrelated location services privacy class

PLMNO PLMN Operator location services privacy class

INTIDLIST Internal Identity List

MOCLLIST LOCSERVICES Mobile Originating Class List

-ASL Autonomous Self Location

-BSL Basic Self Location

-TTP Transfer to Third Party

-ALL All of LOCSERVICES mobile originating classes

EADD External LOCSERVICES client Address

GRES Restriction on the Gateway Mobile Location Center(GMLC)

NOTF Location request restriction related to theNotification to the mobile subscriber

LMU Location Measurement Unit

6.4.14 Others

Table 22 Others

SUD Descriptions

ACC Account Code

AMSISDN Additional MSISDN

AOC AdviceOf Charge

AUTHD Authentication Data

CAPL Channel Allocation Priority Level

CAT SubscriberCategory

CAW CAllWaiting

CUG Closed User Group

DBSG Default Basic Service Group

DEMLPP Default Enhanced Multi-Level Precedence andPre-emption

ECT Explicit Call Transfer

104 155 10-CSH 150 82 Uen C 2007-01-24


SUD Descriptions

EMLPP Enhanced Multi-Level Precedence and Pre-emption

HOLD CallHold

HPN High Penetration Notification

ICI Immediate Call Itemization

MEMLPP Enhanced Multi-Level Precedence andPre-emption. Maximum priority level.

MOBINT Mobility ManagementIN Triggering Data

MPTY MultiParty Service

OBCT Operator Barring of Invocation of Call Transfer

OBDCT Operator Barring of Invocation of Call Transferwhere both calls are charged to the servedsubscriber

OBMCT Operator Barring of Invocation of Call Transfer ifthere is already one ongoing transferred call for theserved subscriber in the serving MSC/VLR

OCSI Originating CAMEL Subscription Information

OFA OriginFor Forwarded-to Number Analysis

OICK OriginatingIntelligent network Category Key

OIN OriginatingIntelligent Network

PAI Positioning Allowed Indicator

PICI Primary Inter-exchange Carrier Identity (highestpriority)

PICI2 Primary Inter-exchange Carrier Identity (mediumpriority)

PICI3 Primary Inter-exchange Carrier Identity (lowestpriority)

PRBT Personal Ring Back Tone

PWD SubscriberPassword

RED RedundantSubscriber

REGSER Regionalservice

RSA Roaming Service Area

STYPE Subscription Type

TCSI Terminating CAMEL Subscription Information

TEARDOWN Call Teardown

TICK TerminatingIntelligent network Category Key

TIN Terminating IntelligentNetwork

105155 10-CSH 150 82 Uen C 2007-01-24


SUD Descriptions

DUALSTAT Dual IMSI subscription flag

ACTYPE Dual IMSI activation type

6.5 HLRSUB Message Response




• Faulty data (D)

• Fatal error (F)


Table 23 HLRSUB


Type Create Set Del Get

Successful 0 x x x x

NE ANSWERS (1-200,10203-10303)

IMSI already defined 1 D x

MSISDN already defined 2 D x x

Lack of storage space insubscr. data file

3 F x

Lack of storage space in IMSIanalysis file

4 F x

Lack of storage space inMSISDN analysis file

5 F x x

Subscriber authentication datanot found

6 F x

No connection to authenticationcentre

7 T/F x

Time out while fetchingauthentication data

8 T/F x

IMSI is prefix of existing IMSI 9 D x

106 155 10-CSH 150 82 Uen C 2007-01-24




There is an IMSI prefix of theIMSI

10 D x

MSISDN is prefix of existingMSISDN

11 D x x x x

There is a MSISDN prefix ofthe MSISDN

12 D x x

IMSI is not defined 13 D x x

MSISDN is not defined 14 D x x

Subscriber data not recognized 15 S x x

Supplementary service notrecognized

16 S x x

Supplementary service notprovided

17 S x x

Supplementary service notapplicable

18 S x x

Forward-to-number restricted 19 D/S x x

Attribute not applicable 25 S x x

Forward to number missing 26 D/S x x

Operation not allowed due tointeract.

27 S x x

Subscriber data not applicable 32 S x x

Operation not allowed due tocurrent location

33 T x x

BSG not subscribed 41 S x x

BSG not recognized 43 S x x

SS not applicable to specifiedBSG

44 S x x

Subscription limit of numbersreached

47 F x x

MSISDN it not an additionalMSISDN

48 D/S x x

Storage shortage in data file 51 F x x

BC not defined 55 D/S x x

BC out of range 57 S x x

SS not applicable to anysubscribed BSG

61 D/S x x

107155 10-CSH 150 82 Uen C 2007-01-24




Supplementary service notregistered

62 S/D x x

Change-over not initiated 64 D/S x

Change-over still pending 66 T/S x

BC represents a BS notsupported

68 S x x

Subscriber disconnection inprocess

73 T x x x x

Functionality not supported bythis exchange

75 S x x

Closed user group notapplicable to bsg

76 S x x

Index already defined 77 S/D x

Interlock code already defined 78 S/D x

Basic service group includedmore than once

79 S x x

Updating closed user groupdata

80 T x

Closed user group notapplicable to any bsg

81 S x x

Max number of closed usergroups reached

82 S x x

Basic service group erase notallowed

83 S x

Index not defined 84 S/D x x

MSISDN not defined as closeduser group

85 S/D x x

Bsg not defined within anyclosed user group

86 S/D x x

Bsg not defined within a givenpcsug

87 S/D x x

Pcsug not defined as index 88 S/D x x

Pcsug not allowed 89 S x x

Odd number of characters insubaddress

102 D/S x x

Restriction not allowed 115 S x x

Index erasure not allowed 116 S x

108 155 10-CSH 150 82 Uen C 2007-01-24




Collective basic service groupnot allowed

117 S x x

No translation defined for theIMSI /Storage shortage inGPRS data file

149 S/T x x

Storage shortage in MSISDNanalysis file for flexiblenumbering / Storage shortagein PDP context datafile

150 F x x

Storage shortage in routingdata file for flexible numbering/Storage shortage in facsimiletransmission data file

151 T x x

Storage shortage in MSISDNseries analysis file

152 T x x

Storage shortage in data circuitasynchronous data file

153 T x x

Storage shortage in data circuitsynchronous data file

154 T x x

Storage shortage in routingdata file for flexible numbering/ Storage shortage in facsimiletransamissiondata file

151 F x x

Bearer Capability number isnot permitted

159 S/D x

IMSI does not belong toWCDMA network

160 S/D x x

The mobility management INtriggering subscription dataare being updated for thesubscriber

167 T x x

DetectionPoint already defined 168 S/D x x

DetectionPoint not defined 169 S/D x x

The DetectionPoint is activatedfor the subscriber

170 S/D x

The DetectionPoint is notactivated for the subscriber

171 S/D x

DetectionPoint value notallowed

172 S/D x x

109155 10-CSH 150 82 Uen C 2007-01-24




Maximum number of TriggerDetection Points has beenreached for the subscriber

173 D x x

Too many detection pointsspecified

174 S/D x x

GSM Service Control Functionaddress is not defined

175 D x x

General bearer service notsubscribed

182 F x

Parameter not supported bythis exchange

183 D x x

Updating CAMEL subscriptiondata in progress for thesubscriber

187 T x x

CAMEL subscription data notdefined

188 S/D x x

Parameter value not supportedby this exchange

189 S/D x x

MSISDN is defined as anadditional MSISDN /TCTDPnot defined

190 S/D x x x

OCTDP not defined 191 S/D x x

IMSI does not belong to anoperator /TCTDP alreadydefined

195 S/D x x

OCTDP already defined 196 S/D x

MSISDN not connected toan IMSI in the FNR, probablyexported or other number /Maximum number of TCTDPreached

197 T/S/D x x x

Maximum number of OCTDPreached

198 S/D x

Maximum number ofsubscriptions exceeded

199 F x

Storage shortage in BSG datafile / Maximum number ofGPRS subscription succeeded

200 T/F x x

No originating CAMELsubscription defined

10203 S/D x

110 155 10-CSH 150 82 Uen C 2007-01-24




No terminating CAMELsubscription defined

10204 S/D x

APN not defined 10211 S/D x x

Maximum number of subscriberPDP context reached

10215 S/D x x

SubscriberPDP context alreadydefined

10216 S/D x x

SubscriberPDP context withnon subscribed APN alreadydefined

10217 S/D x x

Updating of subscriber PDPcontext in progress

10218 T x x

Packetdata protocol contextidentifier repeated

10219 S/D x x

SubscriberNAM already hasthat value

10220 S/D x

Subscriberdata not compatiblewith stored subscriber data

10221 D x

SubscriberPDP context notdefined

10222 D x

GMLC address not defined 10240 S/D x x

Storage shortage insubaddress data file forspeech

10242 T x

Storage shortage insubaddress data file fordata circuit asynchronous

10243 T x

Storage shortage insubaddress data file fordata circuit synchronous

10244 T x

Storage shortage insubaddress data file forfacsimile

10245 T x

Storage shortage insubaddress data file forauxiliary speech

10246 T x

OFA value not allowed 10259 D x

Storage shortage in originatingCAMEL phase 2 data file

10260 T x x

111155 10-CSH 150 82 Uen C 2007-01-24




Storage shortage in terminatingCAMEL phase 2 data file

10261 T x x

Not applicable for OCTDP 10262 S x

Last OCTDP phase 2 removalnot allowed

10263 S x

Storage shortage in BSG forauxiliary speech service datafile

10265 T x

No originating CAMEL phase 2subscription defined

10266 D x

Storage shortage in originatingCAMEL phase 1 data file

10267 T x x


10268 T x x

Storage shortage in triplet datafile

10269 T x x

Storage shortage in quintetdata file

10270 T x x

Storage shortage in GPRSCAMEL phase 3 data file

10271 T x

GPRS TDP already defined 10272 S/D x x

Maximum number ofGPRSTDP reached

10273 T x x

I not applicable for this type ofTDP

10274 S//D x

CCH VALUE not allowed forthis type of TDP

10275 S/D x x

GPRSTDP not defined 10277 S/D x

Too many GPRSTDP specified 10278 S/D x x

Operation not applicable to anLMU subscriber

10279 S/D x x

Storage shortage in LCS datafile

10280 T x x

Updating of subscriber LCSdata in progress

10281 T x x

Maximum number of subscriberexternal identities reached

10282 T x x

No subscriber LCS classesdefined

10283 S/D x

112 155 10-CSH 150 82 Uen C 2007-01-24




No subscriber LCS privacyclasses defined

10284 S/D x

No subscriber LCS MO classesdefined

10285 S/D x

Subscriber LCS class notdefined

10286 S/D x

No subscriber GMLCaddresses defined

10287 x

Subscriber LCS privacy classalready defined

10291 S/D x x

Subscriber LCS MO classalready defined

10292 S/D x x

Subscriber internal identityalready defined

10293 S/D x x

External address alreadydefined

10294 S/D x x

Call unrelated LCS class notdefined

10295 S/D x x

Subscriber LCS privacy classnot defined

10296 S/D x

Subscriber LCS MO class notdefined

10297 S/D x

Subscriber external addressnot defined

10298 S/D x

Internal identity not defined 10299 S/D x

GMLC restriction not defined 10300 S/D x

Maximum number of subscriberGMLC addresses exceeded

10301 T x x

Subscriber GMLC addressalready defined

10302 S/D x x

Subscriber GMLC address notdefined

10303 S/D x

Storage shortage in originatingSMS CAMEL data file

10304 T x x

OSMSTDP already defined 10305 S/D x x

Maximum number ofOSMSTDP reached

10306 S/D x x

OSMSTDP not defined 10308 D x

Too many OSMSTDP specified 10309 S/D x

113155 10-CSH 150 82 Uen C 2007-01-24




Extended QOS not defined 10314 S/D x x

PDP type incompatible 10315 D x x

Static addressing not allowedfor PDP context

10316 D x x

Call related LCS class notdefined

10324 D x x

TSMSTDP value not allowed 10325 S/D x x

TSMSTDP not defined 10330 S/D x

DSTDP not defined 10345 S/D x

Triggering basic servicealready defined

10361 D x x

Triggering basic service notallowed

10362 D x

Maximum number of triggeringbasic services reached

10363 D x

Storage shortage in CAMELTCTDP2 criteria data file

10364 D x x

Storage shortage in CAMELOCTDP2 criteria data file

10365 D x x

Forwarding triggering criteriaalready defined

10366 D x x

Triggering criteria data notdefined

10368 D x

Destination number not defined 10369 D x

Destination number length notdefined

10370 D x

Forwarding triggering criterianot defind

10371 D x

No triggering basic servicedefined

10372 D x

BS not defined as triggeringbasic service

10373 D x

BSG not defined as triggeringbasic service

10374 D x

Maximum number of subscribercall related external identitiesreached

10375 D x

114 155 10-CSH 150 82 Uen C 2007-01-24




Maximum number of subscribercall unrelated external identitiesreached

10376 D x

Subscriber call related externaladdress not defined

10377 D x x

Subscriber call unrelatedexternal address not defined

10378 D x x

Call related external addressalready defined

10379 D x

Call unrelated external addressalready defined

10380 D x

Call related GMLC restrictionnot defined

10381 D x x

Call unrelated GMLC restrictionnot defined

10382 D x x

NAM value not allowed due tofunctionality not supported

10383 D x

Storage shortage in callunrelated external LCS clientaddress data file

10385 D x

Storage shortage in call relatedexternal LCS client addressdata file

10386 D x

Internal identity already givenin command

10387 D x x

Subscriber LCS MO classalready given in command

10388 D x x

Storage shortage in IPV6address data file

10389 D x

Storage shortage in externaladdresss data file

10390 D x

CCH value not compatible forthis TDP value

10391 D x x

VTTDP already defined 10392 D x x x

Storage shortage in OriginatingCAMEL phase 3 data file

10394 D x


10395 D x

115155 10-CSH 150 82 Uen C 2007-01-24




Storage shortage in visitor MSCterminating CAMEL phase 3data file

10396 D x x

VTTDP not defined 10397 D x x

Too many VTTDP specified 10398 D x

Maximum number of VTTDPreached

10399 D x x

Trigger detection point includedmore than once

10400 D x

Subscriber PICI alreadydefined

10401 D x x

Subscriber GMLC addressalready given

10415 D x

No destination number defined 10417 D x x

No destination number lengthdefined

10418 D x x

Storage shortage in externaladdress analysis file

10419 D x

Spatial triggers data is alreadydefined

10420 S/D x x

Storage shortage in spatialtriggers data file

10421 T x x

Subscriber spatial triger datanot defined

10422 S/D x x

Subscriber Service TypeAlready Defined

10424 S/D x x

Too many service typesspecified for the subscriber

10426 S/D x x

Subscriber service type alreadygiven in command

10427 S/D x x

No subscriber service typesdefined

10428 S/D x x

Subscriber service type notdefined

10429 S/D x x

Service type GMLC restrictionnot defined

10430 S/D x x

Subscription link already exists 10433 x

MSISDN is not a linkedMSISDN

10435 x

116 155 10-CSH 150 82 Uen C 2007-01-24




PDP Context Identifier in use 10437 S/D x x

PDP address incompatible withPDP type

10438 S/D x x

Spatial trigger event value notallowed

10444 S/D x x

Updating of subsciber spatialtrigger data in progress

10445 T x x

Command Restricted DuringDump

10446 F x x x x

Subscription belongs to amultiple subscription

10456 F x x

IMSI corresponds to mastersubscription

10457 F x x

IMSI already given in command 10458 F x x

Updating multiple subscriptiondata in progress

10459 T x x x

Too many IMSIS specified 10460 F x x

Storage shortage in multiplesubscription data file

10461 F x

Subscription is not a mastersubscription

10462 F x x

Subscription does not belongto the multiple subscription

10463 F x

Maximum number ofsubscription in multiplesubscription exceeded

10464 F x

Minimum number ofsubscription in multiplesubscription exceeded

10465 F x

Change of active subscriptionnot allowed

10466 F x

Subscriber SMSC addressseries already defined

10469 D x

Series is prefix of existingseries

10470 D x

There is a series prefix of thegiven series

10471 D x

Updating of subscriber SPAMSMS data in progress

10472 D x x

117155 10-CSH 150 82 Uen C 2007-01-24




Maximum number of subscriberSMSC address series reached

10473 D x

Storage shortage in subscriberSPAM SMS data file

10474 D x

Storage shortage in SPAMSMSC address series data file

10475 D x

No SPAM SMS data defined 10476 D x

Subscriber SMSC addressseries not defined

10477 D x

LCS address not defined 10478 D x

Subscriber has a HGMLCaddress already defined

10479 D x

Subscriber has a PPR addressalready defined

10480 D x

No subscriber HGMLC addressdefined

10481 D x

No subscriber PPR 10482 D x

Storage shortage in originatingCamel phase 4 data file

10485 D x x

Storage shortage in terminatingCamel phase 4 data file

10486 D x x

Storage shortage in VMSCterminating Camel phase 4data file

10487 D x x

NE FATAL ERRORS(1001-1100)

Ext. system communicationlink failure

1001 T/F x x x x

External system error 1002 F x x x x

Inconsistency in NE data 1003 F x x x x

Ericsson Multi ActivationFATAL ERRORS (2001-2100)

Ericsson Multi Activationdatabase error

2001 F x x x x

Internal Ericsson MultiActivation error

2002 F x x x x

NE does not exist 2003 F x x x x

118 155 10-CSH 150 82 Uen C 2007-01-24




Operation conflict withON/OFF/OFF-STORE statusof NE

2004 F/D x x x x

tableManager not found 2010 F x x

Mapping table not found 2011 F x x

QOS/EQOSID not found inmapping table

2012 F x x


Invalid command 3001 S x x x x

Operation not supported 3002 S x x x x

Unknown NE object 3003 F x x x x

Insufficient parameters 3004 S x x x x

Invalid argument or out ofrange

3005 S x x x x

Rejection, must login first 3007 S x x x x

Invalid command sequence 3008 S x x x x

Invalid license 3010 F x x x x

License expired 3011 F x x x x

Not authorized 3012 F x x x x

Table 24 HLRMWINFO



Successful 0 x

NE ANSWERS (1 -199)

IMSI is not defined 13 D x

MSISDN is not defined 14 D x

NE Fatal Errors:

External systemcommunication link failure

1001 T/F

External system error 1002 F

Inconsistency in NE data 1003 F

CAI ERRORS (3001-3100) x

Invalid command 3001 S

Operation not supported 3002 S x

Unknown NE object 3003 F x

119155 10-CSH 150 82 Uen C 2007-01-24




Insufficient parameters 3004 S


3005 S

Rejection, must log on first 3007 S x

Invalid command sequence 3008 S x

Invalid license 3010 F x

License expired 3011 F

Not authorized 3012 F x

Fault in the DC file 3013 F

120 155 10-CSH 150 82 Uen C 2007-01-24


7 FNR Subscription

7.1 Customers Service Orders


7.1.1 NPSUB

The number portability feature enables mobile subscriber to retain the MSISDNnumber when changing network operator.

NP requires a high level communication between the operators. Subscribersthat are moving from one network to another must be reported to the networkthe MSISDN belongs to, which is the network where the subscriber was created.

The NP functionality is included in the FNR network element.

Note: If the user has chosen the Splitted HLR and FNR licence duringinstallation, when doing provisioning towards HLR, only the data in HLRis affected. If there is any operation towards FNR needed, the usershould do the provisioning on FNR in addition. And this MO providesCREATE, SET, DELETE, and GET operations, which only affect thedata in FNR.

If the user hasn’t chosen the Splitted HLR and FNR licence duringinstallation, the provisioning of the FNR database will be completelyhidden for the users of Ericsson Multi Activation, that is, the necessarycommands to FNR will be sent automatically when Ericsson MultiActivation users (CAI and GUI) are doing provisioning towards theHLR. In this case, the only time the FNSUB MO need to be used is if anHLR provisioning operation has partly failed and the databases of HLRand FNR because of that has inconsistent data.

The requests towards the MO NPSUB and responses from the MONPSUB for the two cases are the same.

121155 10-CSH 150 82 Uen C 2007-01-24


7.1.1.1 NPSUB - CREATE

7.1.1.1.1 Request Syntax


<trans_id> The transaction id of the CREATE provisioningoperation.


<msisdns> The MSISDN number series of the subscription to bedefined.

<network_prefix> The network prefix of the subscription to be defined.

7.1.1.1.2 Response Syntax

Figure 77 Response Syntax


<resp_code> Response codes, see Section 7.4.1 on page 140.

7.1.1.2 NPSUB - SET



<trans_id> The transaction id of the SET provisioning operation.


<network_prefix> The network prefix of the subscription to be modified.

122 155 10-CSH 150 82 Uen C 2007-01-24






7.1.1.3 NPSUB - GET


Figure 80 GET Command



<msisdns> The MSISDN number series of the subscription to bedisplayed.


Figure 81 Specified Response (Request to Display a Number of SpecifiedData)



<network_prefix> The prefix which is only displayed if the response codeis equal to 0.

123155 10-CSH 150 82 Uen C 2007-01-24




<subtype> The subscriber type of the subscription to be displayed.

7.1.1.4 NPSUB - DELETE



<trans_id> The transaction id of the DELETE provisioning operation

<msisdn> The MSISDN number of the subscription to be deleted

<msisdns> The MSISDNS number of the series to be deleted.


Figure 83 Response



7.1.2 FNSUB

The Flexible Numbering feature enables the mobile subscriber to choose hisMSISDN much more free when his IMSI is fixed.

124 155 10-CSH 150 82 Uen C 2007-01-24


Note: The provisioning of the FNR database will be completely hidden for theusers of Ericsson Multi Activation, that is, the necessary commands toFNR will be sent automatically when Ericsson Multi Activation users(CAI and GUI) are doing provisioning towards the HLR.

The only time the FNSUB MO need to be used is if an HLR provisioningoperation has partly failed and the databases of HLR and FNR becauseof that has inconsistent data.

If the user has chosen the Splitted HLR and FNR licence duringinstallation, when doing provisioning towards HLR, only the data in HLRis affected. If there is any operation towards FNR needed, the usershould do the provisioning on FNR in addition. And this MO providesCREATE, SET, DELETE, and GET operations, which only affect thedata in FNR.

If the user hasn’t chosen the Splitted HLR and FNR licence duringinstallation, the provisioning of the FNR database will be completelyhidden for the users of Ericsson Multi Activation, that is, the necessarycommands to FNR will be sent automatically when Ericsson MultiActivation users (CAI and GUI) are doing provisioning towards theHLR. In this case, the only time the FNSUB MO need to be used is if anHLR provisioning operation has partly failed and the databases of HLRand FNR because of that has inconsistent data.

The requests towards the MO FNSUB and responses from the MOFNSUB for the two cases are the same.

7.1.2.1 FNSUB - CREATE




125155 10-CSH 150 82 Uen C 2007-01-24



<msisdns> The MSISDN series of the subscription to be defined.


<gimsi> Generic IMSI number of the subscription to be definied.

<address> HLR address




<resp_code> Response codes , see Section 7.4.2 on page 142.

7.1.2.2 FNSUB - SET








Figure 87 Response


126 155 10-CSH 150 82 Uen C 2007-01-24



7.1.2.3 FNSUB - GET







<gimsi> The Generic IMSI number of the subscription to bedisplayed.


127155 10-CSH 150 82 Uen C 2007-01-24



Figure 89 Specified Response






<gimsi> The Generic IMSI number of the subscription to bedisplayed.

<address> HRL address

7.1.2.4 FNSUB - DELETE



128 155 10-CSH 150 82 Uen C 2007-01-24



<msisdn> The MSISDN number of the subscription to be deleted.

<msisdns> The MSISDN number series of the subscription to bedeleted.

<imsi> The IMSI number of the subscription to be deleted.

<imsis> The IMSI number series of the subscription to bedeleted.

<deladdr> Flag 0–1


Figure 91 Response

<transaction_id> The transaction id of the DELETE provisioningoperation.


7.1.3 ANSISUB

7.1.3.1 ANSISUB-CREATE



<trans_id> The transaction Id of the CREATE provisioningoperation.

<msisdn> The msisdn number of the subscription to be defined.

<msisdns> The MSISDN number series of the subscription to bedefined.

<nprefix> The network prefix of the subscription to be defined.

129155 10-CSH 150 82 Uen C 2007-01-24



Figure 93 Response


<resp_code> See Table 32 on page 144 for response codes.

7.1.3.1.3 Examples

CREATE:ANSISUB:MSISDN,311300169000:NP,9955;

Successful message response: RESP: 0;

Unsuccessful message response, the subscriber number translation is notdefined: RESP: 14;

7.1.3.2 ANSISUB-SET


Figure 94 Set Command


<msisdn> The msisdn number of the subscription to be set.

<nprefix> The network prefix of the subscription to be set.


Figure 95 Response

<trans_id> The transaction Id of the SET provisioning operation.


7.1.3.2.3 Examples

CREATE:ANSISUB:MSISDN,311300169000:NP,9955;

130 155 10-CSH 150 82 Uen C 2007-01-24




7.1.3.3 ANSISUB-GET



<trans_id> The transaction id of the operation.

<msisdn> The msisdn number of the subscription to be displayed.


<nprefix> The network prefix of the subscription to be displayed.

<subtype> The subscriber type.

<subcond> The subscriber condition.


Figure 97 Response

<trans_id> The transaction id of the operation.


131155 10-CSH 150 82 Uen C 2007-01-24





<subtype> The subscriber type.

<subcond> The subscriber condition.

7.1.3.3.3 Examples

Message request to retrieve all the properties of the following subscriber withMSISDN number;

GET:ANSISUB:MSISDN,311300169000;

Successful message response: RESP:0:MSISDN,311300169000:NP,9955:SUBTYPE,HOME:SUBCOND,ANSI;

Message request to retrieve a selective number of parameters for the samesubscriber as above;

GET:ANSISUB:MSISDN,311300169000:NP;

Successful message response:RESP:0:MSISDN,311300169000:NP,9955;

GET:ANSISUB:MSISDN,311300169000:SUBTYPE;

Successful message response:RESP:0:MSISDN,311300169000:SUBTYPE,HOME;

GET:ANSISUB:MSISDN,311300169000:SUBCOND;

Successful message response:RESP:0:MSISDN,311300169000:SUBCOND,ANSI;


7.1.3.4 ANSISUB-DELETE




132 155 10-CSH 150 82 Uen C 2007-01-24


<msisdn> The msisdn number of the subscription to be deleted.

<msisdns> The MSISDN number series of the subscription to bedeleted.


Figure 99 Response



7.1.3.4.3 Examples

DELETE:ANSISUB:MSISDN,311300169000;



7.1.4 UMTSPDCSUB


The FNR for PDC and WCDMA support feature enables PDC subscribers toretain their MSN/MSISDN number when changing their subscription to be anWCDMA subscription.

The FNR for PDC and WCDMA support flexible allocation of subscriber number.

The FNR for PDC and WCDMA support function is included in the FNR networkelement.

Note: The provisioning of the FNR database will be completely hidden for theusers of Ericsson Multi Activation, that is the necessary commands toFNR will be sent automatically when Ericsson Multi Activation users(CAI and GUI) are doing WCDMAPDCSUB towards the HLR.

There are only two cases for WCDMAPDCSUB MO to be used. Onecase occurs if an HLR provisioning operation has partly failed and thedatabases of HLR and FNR because of that has inconsistent data.Another case occurs if Ericsson Multi Activation users (CAI and GUI)need to manually update the IMSI in FNR.

133155 10-CSH 150 82 Uen C 2007-01-24


7.1.4.1 FNR for PDC and UMTS Support - CREATE


Figure 100 Create command


<msisdn> The msisdn number of the subscription to be defined.

<port> Indicates if the subscriber shall be ported or not

0 = not ported

1 = ported


<msisdns> The msisdn number series of the subscription to bedefined.

<nprefix> The network prefix of the subscription to be defined.


Figure 101 Response

<transaction_id > The transaction id of the CREATE provisioningoperation.

<resp_code> See Section 7.4.4 on page 146.

134 155 10-CSH 150 82 Uen C 2007-01-24


7.1.4.2 FNR for PDC and UMTS support - SET




<msisdn> The msisdn number of the subscription to be modified.

<port> Indicates if the subscriber shall be ported or not

0 = not ported

1 = ported


<msisdns> The msisdn number series of the subscription to bemodified.

<nprefix> The network prefix of the subscription to be modified.


Figure 103 Response



135155 10-CSH 150 82 Uen C 2007-01-24


7.1.4.3 FNR for PDC and UMTS support - GET


Figure 104 Get Command





<msisdns> The msisdn number series of the subscription to bedisplayed.


Figure 105 Response



<msisdn> The MSISDN number. The number is only displayed ifthe response code is equal to 0.



<msisdns> The msisdn number series of the subscription to bedisplayed.

136 155 10-CSH 150 82 Uen C 2007-01-24



7.1.4.4 FNR for PDC and UMTS support - DELETE


Figure 106 Delete Command


<msisdns> The msisdn number series of the subscription to bedeleted.

<msisdn> The msisdn number of the subscription to be deleted.


Figure 107 Response










137155 10-CSH 150 82 Uen C 2007-01-24














7.2.1 NP Subscription Parameters

Table 25 NP Subscription Parameters


MSISDN 5-15 digits CSDGRF

MSISDNS 5-15 digits CSDGRF

IMSI 6-15 digits RF

NP 0–9 digits or #10–#14 CSRF

SUBTYPE HOME, IMPORTED, EXPORTED, OTHER RF

138 155 10-CSH 150 82 Uen C 2007-01-24


7.2.2 FN Subscription Parameters

Table 26 FN Subscription Parameters


ADDRESS 5–28 digits



IMSI 6-15 digits CSDGRF

IMSIS 6-15 digits CSDGRF

GIMSI 6-15 digits CSRF

SUBTYPE HOME, IMPORTED, EXPORTED, OTHER RF

7.2.3 ANSI Subscription Parameters

Table 27 ANSI Subscription Parameters




IMSI 6-15 digits CSRF


SUBTYPE HOME, IMPORTED, EXPORTED,OTHER

RF

SUBCOND ANSI, GSM/WCDMA RF

7.2.4 UMTSPDC Subscription Parameters

Table 28 UMTSPDC Subscriber Parameters



PORT 0-1 CSRF

SUBTYPE UMTSHOME, UMTSPORTED, PDCHOME,PDCPORTED

RF


MSISDNS 5-15 digits CSGD


139155 10-CSH 150 82 Uen C 2007-01-24


7.3 FNR Subscriber Data Abbreviations

Table 29 NP/FN Subscriber Data Abbreviations

SUD Descriptions

SUBTYPE Subscriber Type

NP Network Prefix

SUBCOND Subscriber Condition

7.4 FNRSUB Message Response




• Faulty data (D)

• Fatal error (F)


7.4.1 NPSUB

Table 30 NPSUB




NE ANSWERS (1 -199)

MSISDN already defined 2 D x


11 D x x x x

There is an MSISDN prefix ofthe existing MSISDN

12 D x x x x

MSISDN not connected 14 T x x x


75 S x x

Storage shortage in MSISDNanalysis file

150 F x x

140 155 10-CSH 150 82 Uen C 2007-01-24




Storage shortage in reroutingdata file

151 F x x

Storage shortage in MSISDNseries analysis datafile

152 F x x


189 S/D x x

MSISDN does not belongs toown country

194 D x x x x

NPREFIX has not got theproper length

196 D x x

Maximum Number ofSubscriber Series TranslationExceeded or Maximum Numberof Subscriber TranslationExceeded

199 F x


External system communicationlink failure

1001 T/F x x x x


Ericsson Multi Activation FATALERRORS (2001-2100)


2001 F x x x x


2002 F x x x x







Invalid argument or out of range 3005 S x x x x






141155 10-CSH 150 82 Uen C 2007-01-24




NPREFIX does not belong tooperator

10967 D x x

MSISDN does not belong tooperator

10968 D x

NPREFIX is additional ownnetwork prefix

10969 D x

Illegal combination of parametervalue.

10970 D

Storage shortage in seriesrerouting data file

10978 F x

7.4.2 FNSUB

Table 31 FNSUB




NE ANSWERS (1 -199)



11 D x x x x


12 D x x x x



75 S x x


150 F x x


151 F x x


152 F x x


160 S/D x x


189 S/D x x

Parameter not supported bythe exhange.

191 S x x

142 155 10-CSH 150 82 Uen C 2007-01-24




MSISDN does not belongs toown country

194 D x x x x

IMSI does not belong tooperator

195 D x x


196 D x x

Maximum Number ofSubscriber Series TranslationExceeded or Maximum Numberof Subscriber TranslationExceeded

199 F x



1001 T/F x x x x




2001 F x x x x


2002 F x x x x


Operation conflict withON/OFF/OFF-STORE status ofNE

2004 F/D x x x x












143155 10-CSH 150 82 Uen C 2007-01-24





10968 D x

Illegal combination ofparameter values

10970 D x

GIMSI does not belong tooperator

10973 D x

IMSI is prefix of existing IMSI 10974 D x x

There is an IMSI prefix of thegiven IMSI

10975 D x x

IMSI series is prefix of existingIMSI series

10976 D x

There is an IMSI series prefixof the given IMSI series

10977 D x


10978 F x

IMSI series does not belong tooperator

10979 D x

7.4.3 ANSISUB

Table 32 ANSISUB




NE ANSWERS (1 -199)



11 D x x x x


12 D x x x x



75 S x x


150 F x x


151 F x x

144 155 10-CSH 150 82 Uen C 2007-01-24





152 F x x


189 S/D x x

MSISDN does not belong toown country

194 D x x x x


196 D x x


10967 D x x


10968 D x

NPREFIX is additional ownnetwork prefix

10969 D x


10970 D x

MSISDN does not belong toGSM or WCDMA network

10971 D x x


10978 F x

Maximum number of subscribertranslations exceeded

20242 F x

Maximum number of subscriberseries translations exceeded

20243 F x


20267 S x x


20268 S x

NPREFIX is an additional ownnetwork prefix

20269 S x


20270 S x

MSISDN does not belong toGSM or WCDMA network

20271 S x x



1001 T/F x x x x


145155 10-CSH 150 82 Uen C 2007-01-24






2001 F x x x x


2002 F x x x x













7.4.4 UMTSPDCSUB

Table 33 FNR for PDC and UMTS support

Descriptions Respcode



NE ANSWERS (1-199)

MSISDN is not defined 2 D x x x x


11 D x x

There is an MSISDN prefix ofexisting MSISDN

12 D x x

MSISDN no connected 14 D x x x

Function not supported by thisexchange

75 S x x x x


150 F x x

146 155 10-CSH 150 82 Uen C 2007-01-24




Storage shortage in reroutingdatafile

151 F x x

Storage shortage in MSISDNseries analysis file

152 F x x


160 S/D x x

Parameter not supported bythe exchange

191 S x x

IMSI does not belong to theoperator

195 S/D x x

Maximum number ofsubscriptions exceed

199 F x



1001 x x x x


Inconsistency in NE data 1003 F/D x

IMSI SERIES DOES NOTBELONG TO OPERATOR

10979 D X

NPREFIX NOT ALLOWED 10986 D X X

MSN DOES NOT BELONG TOOPERATOR

10987 D X X

MSN BELONGS TOOPERATOR

10988 D X X

MSN OR SERIES NOTACCEPTED AS SERVICENODE ADDRESS

10989 D X X

ILLEGAL COMBINATION OFPARAMETER VALUE

10970 D



2001 F x x x x


2002 F x x x x



Invalid Command 3001 S x x x x

147155 10-CSH 150 82 Uen C 2007-01-24




Operation not support 3002 S x x x x


Insufficient parameters 3004 F x x x x







148 155 10-CSH 150 82 Uen C 2007-01-24


8 IMSI Change Over

Note: If the user has chosen the Splitted HLR and FNR licence duringinstallation, when doing provisioning towards IMSICH, Ericsson MultiActivation will cause no data update in FNR and will not query FNRfor any information. So, in this case, if there is any data need to beupdated in FNR for IMSI changeover, the Operator should update themthrough FNSUB or NPSUB in addition. See Section 7 on page 121 fordetailed information about FNR provisioning.

If the user hasn’t chosen the Splitted HLR and FNR licence duringinstallation, when doing provisioning towards IMSICH, Ericsson MultiActivation will update data in FNR also, but the physical implementationof FNR behind HLR will be hidden for the user.


An IMSI Change-over procedure is used to replace the subscriber’s SIM-cardwhich has the IMSI burned in. A Change-over procedure comes across somedifferent states before being considered totally executed with no reference tothe old IMSI:

Figure 108 Flow Chart of the IMSI Change-over Process

Note: A forced IMSI Change-over can be performed between different HLRsif it is a flexible numbering network. A delayed IMSI Change-over withexpiry date cannot be performed between different HLRs.

Note: In the case of a delayed IMSI change-over Ericsson Multi Activation willnot be able to automatically remove the old IMSI reference, that has tobe done in a separate command after the change-over command hastriggered. Removal of old IMSI reference can not be done through theIMSICH MO. It has to be done as a SET operation on MO HLRSUB.See Section 6.1.7 on page 55.

149155 10-CSH 150 82 Uen C 2007-01-24


8.1.1 IMSICH - CREATE

The Change-over procedure can be initiated with an activation date (State:‘Pending’). If no date is set the Change-over will take place immediately andEricsson Multi Activation will also take care of deleting associated old IMSIautomatically

Note: If flexible numbering is used in the network it is recommended that IMSIis used in the create request for performance reason.





<msisdn> The MSISDN number of the subscription the IMSIChange-over belongs to.

<imsi> The IMSI number of the subscription the IMSIChange-over belongs to.

<new_imsi> The IMSI number which will be associated to thesubscription when the Change-over is performed

<yymmdd> Activation date for the new IMSI yy - year (00-99) mm -month (01-12) dd - day (01-31)


Figure 110 Response


150 155 10-CSH 150 82 Uen C 2007-01-24



8.1.1.3 Examples

Message request to initiate an IMSI Change-over for the subscriptionwith MSISDN 46455381234. The Change-over leads to thenew IMSI 12345678944444 and will be performed latest 1stof March 2003: CREATE:IMSICH:MSISDN, 46455381234:NIMSI,12345678944444:DATE,010303;

Unsuccessful message response, there is already a Change-over proceduredefined for this subscription: RESP:63;

Message request to initiate the same IMSI Change-over immediately:CREATE:IMSICH: MSISDN, 46455381234: NIMSI,12345678944444;


8.1.2 IMSICH - SET

If the Change-over procedure is in the state ‘Pending’the expiry date may bechanged. In all other states this request will fail. If no date is given this will forcethe Change-over procedure to be executed immediately.

Note: If flexible numbering is used in the network it is recommended thatNIMSI is used in the change request for performance reason.

Note: If both MSISDN and NIMSI number are used in a provisioning operationfrom CAS, only NIMSI will be used in the provisioning operations that issent to the NE and no check will be performed if the MSISDN and IMSIbelong to the same subscription.





<new_imsi> The IMSI number which has been associated to thesubscription when the Change-over was ordered.

151155 10-CSH 150 82 Uen C 2007-01-24


<yymmdd> Activation date for the new IMSI yy - year (00-99) mm -month (01-12) dd - day (01-31)


Figure 112 Response Code



8.1.2.3 Examples

Message request to change the activation date of an IMSI Change-over forthe subscription with MSISDN 46455381234. Now the Change-over will beperformed latest 1st of April 2001:

SET:IMSICH: MSISDN, 46455381234:DATE,010401;

Unsuccessful message response, the date is not acceptable (already passed):RESP: 42;

Message request to force the execution of the still pending Change-overprocedure:

SET:IMSICH: MSISDN, 46455381234;


8.1.3 IMSICH - GET

Note: It is recommended to handle the display request so that CAS will notbe affected by new HLR releases. This can be done by sending onlyused services in the display request. If a full response syntax is used,the results will be different depending on which release of the HLR therequest have been sent to.

Note: If flexible numbering is used in the network it is recommended thatNIMSI is used in the display request for performance reason.

In order to display Change-over data the procedure must be either in state‘Pending’, ‘Forced’or ‘Executed’.

152 155 10-CSH 150 82 Uen C 2007-01-24


8.1.3.1 Request syntax

Figure 113 Request command



<new_imsi> The IMSI number which will be associated to thesubscription when the Change-over is performed

<data_filter> Name of parameters wanted back in response.

8.1.3.2 Response syntax

Figure 114 Response




<new_imsi> The IMSI number which will be associated to thesubscription when the Change-over is performed.

<old_imsi> The old IMSI number which are associated to thesubscription before the Change-over is performed.

<state> • PEND

Indicates that Change-over is ‘pending’

• EXEC

153155 10-CSH 150 82 Uen C 2007-01-24


Indicates that Change-over is ‘executed’

• FORCED

Indicates that Change-over is ‘forced’

<yymmdd> Activation date for the new IMSI yy - year (00-99), mm -month (01-12), dd - day (01-31)

8.1.3.3 Examples

Request to display the ongoing IMSI Change-over of the subscription withthe MSISDN 46455381234:

GET:IMSICH: MSISDN, 46455381234;

Successful message response:

The Change-over leads to the new IMSI 12345678955555 is pending to the1st of March 2001.

RESP:0: IMSI,123456789012: NIMSI,12345678955555: MSISDN,46455381234: STATE,PEND:DATE,010301;

Unsuccessful message response:

No IMSI Change-over procedure is defined for the specified subscription:

RESP:14;

8.1.4 IMSICH - DELETE

This request will stop the IMSI Change-over if it is still pending, otherwise therequest will fail.

Note: If flexible numbering is used in the network it is recommended thatNIMSI is used in the delete request for performance reason.

Note: If both MSISDN and NIMSI number is used in a provisioning operationfrom CAS only NIMSI will be used in the provisioning operations thatis sent to the NE and no check will be performed if the MSISDN andNIMSI belongs to the same subscription.

When flexible numbering is used in the network this command must be followedby a manual rollback of the flexible numbering database, new IMSI must bechanged back to the old IMSI.

154 155 10-CSH 150 82 Uen C 2007-01-24






<new_imsi> The IMSI number which has been associated to thesubscription when the Change-over was ordered.





8.1.4.3 Examples

Message request to delete the pending IMSI Change-over for the subscriptionwith MSISDN 46455381234:

DELETE:IMSICH:MSISDN, 46455381234;


RESP: 0;

Unsuccessful message response, there is no Change-over pending:

RESP:14;





155155 10-CSH 150 82 Uen C 2007-01-24

















156 155 10-CSH 150 82 Uen C 2007-01-24


Table 34 IMSI Change-over Parameters


DATE date:yymmdd where CSRF

yy is a numeral 00 - 99

mm is a numeral 01 - 12

dd is a numeral 01 - 31

IMSI 6-15 digits CRF


NIMSI 6-15 digits CSDGRF

STATE PEND RF

EXEC

FORCED

8.3 IMSICH Message Response




• Faulty data (D)

• Fatal error (F)


Table 35 IMSICH




NE ANSWERS (1-199)

IMSI already defined 1 D x

Lack of storage space in IMSIanalysis file

4 F x

Subscriber authentication datanot found

6 F x

157155 10-CSH 150 82 Uen C 2007-01-24




No connection to authenticationcentre

7 T/F x

Time out while fetchingauthentication data

8 T/F x

IMSI is prefix of existing IMSI 9 D x

There is an IMSI prefix of theIMSI

10 D x


11 D x

There is a MSISDN prefix of theMSISDN

12 D x

IMSI is not defined 13 D x x x x

MSISDN is not defined 14 D x x x x

Date not acceptable 42 D x x

No pending change-over 46 D/S x x

MSISDN type incorrect 53 D/S x x x

Change-over already initiated 63 D/S x

Change-over not initiated 64 D/S x x

Change-over already executed 65 D/S x x

Storage shortage inchange-over data file

70 F x

Subscriber disconnection inprocess

73 S/D x x x

A pending IMSI change-overprocedure can not be initializedbetween two HLRs

191 F x

A move between two HLRs notallowed when MSISDN not inFNR

192 F x



1001 T/F x x x x


Inconsistency in NE data 1003 F x x x x


158 155 10-CSH 150 82 Uen C 2007-01-24





2001 F x x x x


2002 F x x x x












159155 10-CSH 150 82 Uen C 2007-01-24


160 155 10-CSH 150 82 Uen C 2007-01-24


9 AUC Subscription


This chapter explains the details of different parameters that can be used inCSOs. Due to editorial reasons this has been a section of its own in order tosimplify the readability of Section 9.2 on page 163. Terms and expressionsare fetched from the following:

a See reference: Home Translation Functions Changeable ExchangeAdaption (HTRAN)

b See reference: Interworking Subscriber Data Translation ChangeableExchange Adaptation (ISDTRAN)

c See reference: System Operations Manual

d See reference: Application Information block ASD

e See reference: Application Information block AMAPTC

f See reference: Application Information block AGEN

g See reference: SOG-MC Generic Interface Specification

h See reference: Authentication Centre, Key Data, Define

CAI supports two different types of AUC: SEMA AUC and AXE based AUC-10.The two AUC differs in the respect of parameters. Where there are differencesthe document will give one description for each type.

9.1.1 Decrypting Algorithm

The decrypting algorithm is used when decrypting the subscriber’sauthentication key (Ki).

Figure 117 The Decrypting Algorithm

<version_number> The version number of the Ad algorithm used to decryptKi

<key_index> The index of the key to be used in association with theDEA 1 version of the algorithm Ad

161155 10-CSH 150 82 Uen C 2007-01-24


Note: AD is mandatory for SEMA AUC and not valid for AUC-10. However,CAS can still send this parameter to Ericsson Multi Activation whereaction is taken automatically to ignore it if the affected NE is a AUC-10.

9.1.1.1 Setting Decrypting Algorithm

The setting of the decrypting algorithm is done when creating an AUCsubscriber (operation CREATE on the MO object AUCSUB), e.g.,

CREATE:AUCSUB:...:AD, 1: ADKEY, 1:....

This indicates the AUC uses Ad algorithm version 1 and point to key number 1.

9.1.2 Authentication Algorithms

The authentication algorithm is used to generate the ciphering key (Kc) andthe authentication response (SRES), which are used during call setup andcall decrypting.

A ciphering algorithm argument is defined as follows:

Figure 118 The Authentication Algorithm

<a4_version_number>

The version number of the A4 algorithm

<a38_version_number>

The version number of the A38 algorithm (for SEMAAUC and AUC 10 GSM)

<fset_ind> Function SET INDicator (only for WCDMA)

9.1.2.1 Setting Authentication Algorithm

The setting of the authentication algorithm is done when creating aAUC subscription (operation CREATE on the NE object AUCSUB), e.g.,CREATE:AUCSUB:...:A38,3:....

This indicates the AUC uses A38 algorithm version 3 to generate SRES.

9.1.3 Additional Algorithm Specific Information

Note: This section is only applicable for SEMA AUC. However, CAS can stillsend this parameter to Ericsson Multi Activation where action is takenautomatically to ignore it if the affected NE is a AUC-10.

162 155 10-CSH 150 82 Uen C 2007-01-24


The standard authentication algorithms take a random number (RAND) anda security key (Ki) as input to the algorithm and produce a signed response(SRES) and encrypherment key (Kc). The additional information is used as athird input to the algorithm and can therefore be used for customer specificauthentication algorithms. The main benefit is to enhance the security of suchalgorithms.

The additional information field is therefore treated as a secure field in a similarmanner to the Ki.

Figure 119 The Additional Algorithm

<addinfo> Specific authentication algorithm information.

9.1.3.1 Setting Additional Algorithm

The setting of the additional algorithm is done when creating an AUCsubscription (operation CREATE on the NE object AUCSUB), e.g.,CREATE:AUCSUB:...:ADDINFO,10258ade:... . The field consists of eighthexadecimal digits, where valid values are “0-9”, “a-f” and “A-F”.



9.2.1 AUCSUB - CREATE




<imsi> The IMSI number of the subscriber to be defined.

163155 10-CSH 150 82 Uen C 2007-01-24


<authentication_key>

The authentication key of the subscriber to be defined.

<DecryptAlgorithm>

The decrypting algorithm that should be used to decryptKi, Section 9.1.1 on page 161

<AuthenticationAlgorithm>

The ciphering algorithm that should be used to generatethe ciphering key (Kc) and the signed response (SRES),see Section 9.1.2 on page 162.

<Add info> See Section 9.1.3 on page 162.

<ki> Encrypted Subscriber Authentication key.

<amf> Authentication Management Field (0-65535 or“DEFAULT”) this parameter is for WCDMA only.


Figure 121 Response



9.2.1.3 Examples

Message request to define an SEMA AUC subscription with the followingproperties:

IMSI 123456789012345

Ki 12345678901234567890123456789012

Ad version 1

Ad key 1

A38 version 2

CREATE:AUCSUB:IMSI, 123456789012345:KI,12345678901234567890123456789012:AD,1: ADKEY,1: A38,2;


Unsuccessful message response, the subscriber already exists:

164 155 10-CSH 150 82 Uen C 2007-01-24


RESP:301;

9.2.2 AUCSUB - SET




<imsi> The IMSI number of the defined subscriber.

<amf> Authentication Management Field (0-65535 or“DEFAULT”) this parameter is for WCDMA only.





9.2.2.3 Examples

Message request to change the Authentication Management Field of an AUCfor the subscriber with IMSI 123456789012345:

SET:AUCSUB: IMSI, 123456789012345:AMF,34741;

Unsuccessful message response, if no WCDMA subscriber is defined: RESP:336;


9.2.3 AUCSUB - GET

Note: It is recommended to handle the display request so that CAS will notbe affected by new AUC releases. This can be done by sending onlyused services in the display request. If a full response syntax is used,the results will be different depending on which release of the AUC therequest have been sent to.

165155 10-CSH 150 82 Uen C 2007-01-24




Note: AD is not applicable for AUC-10.


<imsi> The exact IMSI number of a subscriber.

<aka_type> Authentication and Key Agreement (AKA) type.


Figure 125 Response

Note: AD is not applicable for AUC-10.



<imsi> The IMSI number of the subscriber.

<aka_type> Authentication and Key Agreement (AKA) type.

<a4_vernum> A4 algorithm version number.

<a38_vernum> A38 algorithm version number.

<version_num> Ad algorithm version.

166 155 10-CSH 150 82 Uen C 2007-01-24


<key_index> The index of the key to be used in association with theDEA 1 version of the algorithm Ad.

<ki> Encrypted Subscriber Authentication key.

<fset_ind> Function set indicator (only for WCDMA).

<amf> Authentication Management Field (0-65535) thisparameter is for AUC 10 WCDMA only.

9.2.3.3 Examples

Message request to get an SEMA AUC subscription with the followingproperties:

IMSI 123456789012345

GET:AUCSUB:IMSI,123456789012345;

Successful message response: RESP: 0:IMSI,123456789012345:A38,1:AD,1:ADKEY,1;

IMSI 123456789012345

A38 2

Ad 1

Ad key 1

Unsuccessful message response, the subscriber does not exists:

RESP:302;

9.2.4 AUCSUB - DELETE




<imsi> The IMSI number of the defined subscriber.

167155 10-CSH 150 82 Uen C 2007-01-24



Figure 127 Response



9.2.4.3 Examples

Message request to delete an AUC subscription with the IMSI123456789012345:

DELETE:AUCSUB:IMSI, 123456789012345;


Unsuccessful message response, the subscriber does not exist: RESP:302;












168 155 10-CSH 150 82 Uen C 2007-01-24










Table 36 AUC Subscription Parameters


IMSI 6-15 digits CDGRFS

KI 32 hexadecimal digits CRF

A4 0-7 (excluded in SEMA AUC, included in R8) CRF

AKATYPE integer 0-1. Default value is: a. 0 if only GSMAKA type is supported by the exchange. b.1 if only WCDMA AKA type supported by theexchange. c. Default value is determined by anAXE parameter if both GSM and WCDMA AKAtypes are supported by the exchange.

GFR

0 = GSM

1 = WCDMA

AMF 0-65535, “DEFAULT” (included in R10) CSRF

A38 0-15 CRF

FSETIND 0-15 CRF

AD 0-127(excluded in AUC-10) CRF

ADKEY 0-255(SEMA AUC) CRF

169155 10-CSH 150 82 Uen C 2007-01-24



0-511(AUC-10)

ADDINFO 8 hexadecimal digits (excluded in AUC-10) C

Note: AD and ADDINFO are not applicable for AUC-10. However, CAS canstill send this parameter to Ericsson Multi Activation where action istaken automatically to ignore it if the affected NE is a AUC-10.

9.4 AUCSUB Message Response




• Faulty data (D)

• Fatal error (F)


Table 37 AUCSUB




NE ANSWERS (301 -349)

Data already exist for key 301 D x

Subscriber does not exist 302 D x x x

Unknown algorithm versionnumber

303 S/D x

Command RestrictedDuring Dump

307 F x x x x

Adkey not defined 308 D x

Storage shortage in IMSIanalysis file

309 F x

Storage shortage insubscriber data file

310 F x

Key data operation inprogress

312 S/D x x

170 155 10-CSH 150 82 Uen C 2007-01-24




Subscription operation inprogress

313 D x x

Maximum number ofsubscriptions exceeded

314 F x

A4IND not supported 315 D x

Key data change inprogress

316 T x

Key data change pending 317 T x

Customer key operation inprogress

320 T x

Functionality not supportedby this exchange

324 D x x

FSETIND only supportedfor AUC WCDMA

327 T/F x

OP change in process 330 T x

AKA Algorithm change inprogress

332 D x x

AKA Algorithm changepending

333 D x x

WCDMA IMSI series notdefined

334 D x

No WCDMA subscribersdefined

336 D x x

No WCDMA subscribersdefined for specified fset

337 D x x

Subscription data changepending

340 D x x

No subscription datachange pending

341 D x x

NE response is series, noIMSI matched

349 D x



1001 T/F x x x

External system error 1002 F x x x

Ericsson Multi ActivationFATAL ERRORS(2001-2100)

171155 10-CSH 150 82 Uen C 2007-01-24





2001 F x x x


2002 F x x x


Operation conflict withON/OFF/OFF-STOREstatus of NE

2004 F/D x x x


Invalid command 3001 S x x x

Operation not supported 3002 S x x x

Unknown NE object 3003 F x x x

Insufficient parameters 3004 S x x x


3005 S x x x

Rejection, must login first 3007 S x x x

Invalid command sequence 3008 S x x x

Invalid license 3010 F x x x

License expired 3011 F x x x

Not authorized 3012 F x x x

172 155 10-CSH 150 82 Uen C 2007-01-24


10 EIR Subscription


10.1.1 EIREQU Subscription

This chapter describes the EIR equipment subscription.


10.1.1.1 EIREQU - CREATE




<imei_number> The start IMEI number of the equipment range to bedefined.

<end_serial_number>

The End Serial number of the equipment range to bedefined.

<list_type> The list type of equipment to be defined. Values 0-9are valid. The definition of the lists is site specific andmapped against the status of the lists internally in theEIR. For example can <list_type>= 1 mean ‘StolenPhone’ and be mapped against the status ‘grey list’.


Figure 129 Response

173155 10-CSH 150 82 Uen C 2007-01-24




10.1.1.1.3 Examples

Message request to define an equipment range with the following properties:

IMEI 123456789012340

ESN 901240

LISTTYPE 1

CREATE:EIREQU:IMEI, 1234567890123456: ESN, 901240: LISTTYPE, 1;


Unsuccessful message response, part or all of equipment range already exists:RESP:202;

10.1.1.2 EIREQU - GET

This command allows the user to retrieve either the active EIR equipment list orall lists for a single equipment.

Note: It is recommended to handle the display request so that CAS will notbe affected by new EIR releases. This can be done by sending onlyused services in the display request. If a full response syntax is used,the results will be different depending on which release of the EIR therequest have been sent to.




<imei> The IMEI number of the equipment to be retrieved.

174 155 10-CSH 150 82 Uen C 2007-01-24



Figure 131 Response



<imei> The IMEI number of the equipment to be retrieved.

<list_type > The list type of equipment to be retrieved. Values 0-9are valid. The definition of the lists is site specific andmapped against the status of the lists internally in theEIR. For example can <list_type>= 1 mean ‘StolenPhone’ and be mapped against the status ‘black list’.

<status> The status that the displayed equipment is active in.Following values are valid:

-1 - unknown

0 - white list

1 - black list

2 - grey list

10.1.1.2.3 Examples

Message request to retrieve an equipment with the following properties:

IMEI 123456789012340

GET:EIREQU:IMEI,123456789012340:LISTTYPES;

Successful message response: RESP:0:IMEI,1234567890123456:LISTTYPES,1,2;

The response indicates that the equipment is registered for both list type 1and list type 2.

GET:EIREQU:IMEI,123456789012340:LISTTYPE:STATUS;

Successful message response: RESP:0:IMEI,123456789012340:LISTTYPE,7:STATUS,0;

175155 10-CSH 150 82 Uen C 2007-01-24


The response indicates that the equipment is active in the white list for listtype 7.

Unsuccessful message response, part or all of equipment range does not exist:RESP:203;

10.1.1.3 EIREQU - DELETE



<trans_id > The transaction id of the DELETE provisioningoperation.

<imei_number> The start IMEI number of the equipment to be deleted.

<end_serial_number>

The End Serial number of the equipment range to bedeleted.

<list_type> The list type of equipment to be deleted. Values 0-9are valid. The definition of the lists is site specific andmapped against the status of the lists internally in theEIR. For example can <list_type>= 1 mean ‘StolenPhone’ and be mapped against the status ‘black list’.


Figure 133 Response



10.1.1.3.3 Examples

Message request to delete an equipment range with the following properties:

176 155 10-CSH 150 82 Uen C 2007-01-24


IMEI 123456789012340

ESN 901240

LISTTYPE 1

DELETE:EIREQU:IMEI, 1234567890123456: ESN, 901240: LISTTYPE, 1;


Unsuccessful message response, part or all of equipment range does not exist:RESP:203;

10.1.2 EIRMST Subscription

This chapter describes the EIR Mobile Station subscription.


10.1.2.1 EIRMST - CREATE




<imei_number> The IMEI number.

<imsi_number> The IMSI number.

<svn> The Software version number.

Note: svn will be ignored by Ericsson Multi Activationif it equals to 0.

177155 10-CSH 150 82 Uen C 2007-01-24



Figure 135 Response


<resp_code> SeeTable 43 on page 188 for response codes.

10.1.2.1.3 Examples

Message request to define a Mobile Station with the following properties:

IMEI 123456789012340

IMSI 123456789012345

SVN 2

CREATE:EIRMST:TRANSID,1:IMEI,123456789012340:IMSI,123456789012345:SVN,2;

Successful message response: RESP:TRANSID,all:0;

10.1.2.2 EIRMST - GET








178 155 10-CSH 150 82 Uen C 2007-01-24



Figure 137 Response



<imei_number> The IMEI number .


10.1.2.2.3 Examples

Message request to retrieve a Mobile Station with the following properties:

IMEI 123456789012340

SVN 2

GET:EIRMST:TRANSID,1:IMEI,123456789012340:SVN,2;

Successful message response: RESP:0:IMEI,123456789012340:IMSI,123456789012345;

10.1.2.3 EIRMST - DELETE







179155 10-CSH 150 82 Uen C 2007-01-24



Figure 139 Response



10.1.2.3.3 Examples

Message request to delete a Mobile Station with the following properties:

IMEI 123456789012340

SVN 2

DELETE:EIRMST:TRANSID,1:IMEI,123456789012340:SVN,2;


10.1.3 EIR IMRC Subscription

IMRC maintains the internal roamers database table, creates foreign roamerreports, and transfers these reports to an external system.

10.1.3.1 EIRIMRC — SET



<object_id> The object id of the operation.

<thrd_id> The id of the threshold for the object.

<tel_num> The threshold exceeded limit.

<rwl_num> The returned value within limit for a threshold.

<action> The value is the wanted action for IMRC object.

180 155 10-CSH 150 82 Uen C 2007-01-24



Figure 141 Response

<resp_code> See Table 43 on page 188

10.1.3.2 EIRMRC — GET





Figure 143 Response


<primId> The primary backup of IMRC object id.

<secndId> The secondary backup of IMRC object id.

181155 10-CSH 150 82 Uen C 2007-01-24


<usercount> The number of objects used by this object.

<class> The object class of the used object.

<provdcount> The number of objects to which this object provides aservice.

<provdclass> The object class of the object that a service is providedfor.

<operstate> The operational status.

<adminstate> The administrative state of a object.

<health> Ok or failed.

<thrdcount> The number of thresholds for the object.

<thrdId> The id of a threshold for the object.

<tel> The threshold exceeded limit.

<rwl> The returned value within limit for a threshold.

<sbuff> The number of internal buffers allocated to the object.

<objectversion> The version number of the object being run.

10.1.4 EIRMKEY

This chapter describes the EIR identification of a Mobile Station.


10.1.4.1 EIRMKEY – GET



<msisdn> The phone number of the mobile station.

<imsi> The unique identifier for a SIM card.

182 155 10-CSH 150 82 Uen C 2007-01-24


<startdate> The earliest date on which to search an IMEI Track logfile for a matching IMEI.

<enddate> The latest date on which to search an IMEI Track log filefor a matching IMEI.


Figure 145 Response


<imsi> The unique identifier for a SIM card.

<imei> A unique identifier for the handset comprising:

• 6-digit TAC.

• 2-digit FAC.

• 6-digit serial number.

• 1-digit spare digit (must be 0).

10.1.4.1.3 Examples

Message request to get an IMEI with the following properties:

MSISDN 123456789123456

IMSI 123456789012345

STARTDATE 20061108

ENDDATE 20061109

GET:EIRMKEY:MSISDN,123456789123456:IMSI,123456789012345:STARTDATE,20061108:ENDDATE,20061109;

Successful message response: RESP: 0:IMSI,123456789012345:IMEI,355991001551465

IMSI 123456789012345

IMEI 2355991001551465



183155 10-CSH 150 82 Uen C 2007-01-24



















184 155 10-CSH 150 82 Uen C 2007-01-24


Table 38 EIR Equipment Parameters


IMEI 15-16 digits CDGRF

ESN 6 digits CD

LISTTYPE 0-9(for SEMA V4/V5) CDRF

LISTTYPES 0-9(for SEMA V4/V5) RF

STATUS -1= no list RF

0= white list

1= black list

2 = grey list

Table 39 EIR Mobile Station Parameters


IMEI 15 digits (TAC+FAC+SerialNumber) CDGRF

IMSI 15 digits CR

SVN 2 digits CDG

Table 40 EIR IMRC Parameters for Airguide 8.0 and 8.1


EIRIMRC

-OBJECTID 8 digits R

-ACTION StringLOCK: locks the administrative state of IMRCobject.UNLOCK: unlocks the administrative state ofIMRC object.DISABLE: disables the executable IMRC object.ENABLE: enables the executable IMRC object.SHUTDOWN: performs an orderly shutdown ofthe IMRC before setting the administrative stateto locked.

S

-ADMINSTATE

Integer0: locked1: shutdown2: unlocked

R

-HEALTH Integer0: Ok1: Failed

R

-OBJECTVERSION

String, 8 digits R

185155 10-CSH 150 82 Uen C 2007-01-24



-PRIMID Numeric String, 8 digits, could be any IMRC objectID

R

PROVDCLASS- CLASS

String, 4 R

-PROVDCOUNT

Integer, 1 – 99 R

-PROVDCLASS-OBJECTID

Numeric String, 8 R

-SBUFF Numeric String, 100 – 9999 R

-SECNDID Numeric String, 8, could be any IMRC object ID R

-THRDCOUNT Numeric String, 0 – 9 R

-USERCLASS- CLASS

String, 4 R

-USERCOUNT Numeric String, 1 – 99 R

-USERCLASS- OBJECTID

Numeric String, 8, could be any of executableobject’s ID

R

-THRSID String, 4, For example: BUFF R

-TEL Integer, 1 – 32000. For example: 1400 SR

-RWL Integer, 1 – 32000. For example: 800 SR

Table 41 EIR MKEY Parameters for EIR v9


STARTDATE Text, 8, format: YYYYMMDD. G

ENDDATE Text, 8, format: YYYYMMDD G

MSISDN Numeric, 15. G

IMEI Numeric, 15, example 123456781234560 where:• TAC 123456• FAC 78• Serial number 123456• Spare digit 0

R

IMSI Numeric, 15. R

10.3 Message Response



186 155 10-CSH 150 82 Uen C 2007-01-24



• Faulty data (D)

• Fatal error (F)


Table 42 EIREQU


Type Create Del Get

Successful 0 x x x

NE ANSWERS (201-299)

Equipment not known 201 D x

Part or all equipment rangealready exists

202 D/S x

Part or all of equipment rangedoes not exist

203 D/S x

Range of IMEIs must notoverlap with any other

204 D/S x

Start of range must be less thanor equal to the end of range

205 D/S x x

TAC and FAC fields cannot beupdated

206 D/S x

Equipment not found in any listin the default search order

207 D x

Invalid argument 1 208 D/S x x x

Cannot parse action request 209 D/S x x x


Ext. system communication linkfailure

1001 T/F x x x




2001 F x x x


2002 F x x x



187155 10-CSH 150 82 Uen C 2007-01-24



Type Create Del Get




Invalid argument or out of range 3005 S x x x






Table 43 EIRMST


Type Create Del Get

Successful 0 x x x

NE ANSWERS (201-299)

Equipment not known 201 D x

Part or all equipment rangealready exists

202 D/S x

Part or all of equipment rangedoes not exist

203 D/S x

Range of IMEIs must notoverlap with any other

204 D/S x

Start of range must be less thanor equal to the end of range

205 D/S x x

TAC and FAC fields cannot beupdated

206 D/S x

Equipment not found in any listin the default search order

207 D x

Invalid argument 1 208 D/S x x x

Cannot parse action request 209 D/S x x x

Invalid object id 210 D/S x x x

Wrong number arguments 211 D/S x x x

Mobile station with this IMEI(and SVN) does not exist

212 D/S x x

Mobile station with this IMEI(and SVN) already exist

213 D/S x

188 155 10-CSH 150 82 Uen C 2007-01-24



Type Create Del Get

Other User Database Error 290 D/S x x

Unknown EIR error 291 D/S x x x



1001 T/F x x x




2001 F x x x


2002 F x x x












Table 44 EIRIMRC


Type Create Set Get

Can not parse action request 209 D x x x

Invalid Object id 210 D x x x

Wrong number arguments 211 D x x x

Object is locked 230 D x x

Object is unlocked 231 D x x

Object is not unlocked 232 D x x

Object is already disabled 233 D x x

Object is not disabled 234 D x x

189155 10-CSH 150 82 Uen C 2007-01-24



Type Create Set Get

Object is disabled 235 D x x

Other user database error 290 D x x

Unknown EIR error 291 D x x x

Other Non-Database Error 292 D x x


1001 T/F x x x




2001 F x x x


2002 F x x x












Table 45 EIRMKEY


Type Create Set Get

Invalid Argument 208 D x

Can not parse action request 209 D x

Invalid Object id 210 D x

Wrong number arguments 211 D x

Other Fault 292 D x

Unknown EIR error 291 D x


190 155 10-CSH 150 82 Uen C 2007-01-24



Type Create Set Get


1001 T/F x x x


EMA FATAL ERRORS(2001-2100)

EMA database error 2001 F x x x

Internal EMA error 2002 F x x x












191155 10-CSH 150 82 Uen C 2007-01-24


192 155 10-CSH 150 82 Uen C 2007-01-24


11 CMS11HLR Subscription


This chapter explains the details of different parameters that can be used inCSOs. Due to editorial reasons this has been a section of its own in order tosimplify the readability of Section 11.2 on page 194.

11.1.1 LIA List

The list of LIAs for subscriber.

11.1.1.1 Syntax of Defining LIA list

Figure 146 Syntax of Defining LIA List

<lia> Limited Area. This parameter enables the subscriber tobe restricted to one or more Limited Areas (LIA), wherethe service is available within the specified LIA(s), butnot outside of them. A LIA is a logical area that mayspan more than one MSC.

11.1.1.2 Syntax of retrieved LIA list

Figure 147 Syntax of retrieved LIA List

<lia> Limited Area. This parameter enables the subscriber tobe restricted to one or more Limited Areas (LIA), wherethe service is available within the specified LIA(s), butnot outside of them. A LIA is a logical area that mayspan more than one MSC.

11.1.1.3 Example

Defining LIA list

...:LIALIST, DEF, 1, DEF, 2, DEF, 3: ...

RESP:0: ...:LIALIST, 1, 2, 3: ...

193155 10-CSH 150 82 Uen C 2007-01-24




11.2.1 CMS11HLRSUB - CREATE



Note:

<transaction_id> The transaction ID of the CREATE operation.

<imsi> International Mobile Subscriber Identity.

<snb> Subscriber Number. 10 or 11 digits long.

<msnb> Mobile Station Number. Consists of exactly 10 digits.This is the starting value for the MIN range.

<CDMA> The air interface the of the user.

<PCODE> Procedure Passcode. the default value is 0000. It is asecurity measure to prevent unauthorized users frommodifying certain subscriber services.

194 155 10-CSH 150 82 Uen C 2007-01-24


<PORTIN> Ported-in Subscription. This parameter definesa subscription as a ported-in subscription. If thisparameter is omitted, the subscription is defined as anHLR-owned subscription.

<authperunit> Assigns an Authentication Period on a subscriber basis,0-7.

<rdg> Restrict Digits Group. It allows operators to restrictcertain calls made by subscribers by specifying adirectory number to which all calls will be redirected if abarring service is activated, 1-16 digits.

<denauthperunit> Assigns a Denied Authentication Period on a subscriberbasis.

<sclgrp> Service Class Group designation, 1-250 characters.

<srnb> Mobile Station Serial Number (8 hexadecimal digits).The default value is FFFFFFFF.

<vmsnb> Fixed Voice Mail System Number for call transfer tovoice mail (1-20 diallable characters).

<winact> Dynamic WIN Feature Activation, “0” or “1”.

<wincap> Dynamic WIN Feature Capability, “0” or “1”. If set to “0”,then the value for WINACT is implicitly set to “0” andshould not be specified in the command.

<List of SCLs> List of Service Class. See Section 11.4 on page 205.

<lialist> See Section 11.1.1 on page 193.

<haid> Home Area Identifier. Possible values for HAID is[0..100,000]. Default value: [0]. (0 means that no HomeArea is assigned for the subscriber).


Figure 149 Response

<transaction_id> The transaction ID of the CREATE transaction.

<resp_code> See Section 11.5 on page 217.

11.2.1.3 Examples

Message request to create a subscriber with the following properties:

195155 10-CSH 150 82 Uen C 2007-01-24


This CAI commands will connect the SNB and IMSI and provide the followingHLR services:

• CAW, Call Waiting is provided and activated.

• TBF, Call transfer on busy, fixed is provided, activated and the C-numberis 5143457901.

• LIALIST, limiting subscriber to the Areas 1, 2 and 3.

• CPDS service is provided and activated with service level 2 and Quality ofService 15–15.

• HTL is provided and activated with the Hotline services, and with theHotline number 2272500001.

• HAID, set the Home Area to 1.

CREATE: CMS11HLRSUB:IMSI, 310_00_5143457915:SNB,5143457900:TBF,1,1,5143457901: LIALIST,DEF,1,DEF,2,DEF,3:HTL,1,1,2272500001:CPDS,2,1,15,15:HAID,1;


Unsuccessful message response, subscriber already exists: RESP:15037;

196 155 10-CSH 150 82 Uen C 2007-01-24


11.2.2 CMS11HLRSUB - SET



<transaction_id> The transaction ID of the SET operation.




<sclpass> The possible value is "1". All Service Classes assignedto a given class group or default profile with an activitystatus will be de-activated.

197155 10-CSH 150 82 Uen C 2007-01-24



<rdg> Restrict Digits Group. It allows operators to restrictcertain calls made by subscribers by specifying adirectory number to which all calls will be redirected if abarring service is activated, 1-16 digits.


<sclgrp> Service Class Group designation, 1-250 characters.This parameter is not allowed if SCLGRP_OR is set.

<sclgrp_or> Service Class Group designation, 1-250 characters.This parameter is not allowed if SCLGRP is set.



<winact> Dynamic WIN Feature Activation, “0” or “1”.

<wincap> Dynamic WIN Feature Capability, “0” or “1”. If set to “0”,then the value for WINACT is implicitly set to “0” andshould not be specified in the command.


<pcode> Procedure passcode.

<exm> Cooperating Exchange Designation.



<resetpincounter> Resets the number of times that the subscriber canretry to change his PIN.


Figure 151 Response

<transaction_id> The transaction ID of the SET transaction.

198 155 10-CSH 150 82 Uen C 2007-01-24



11.2.2.3 Examples

Message request to modify a subscription with the following properties:

SET:CMS11HLRSUB:SNB,5143457900:TBF,1,1,5143457901:LIALIST,DEF,1,DEF,2,DEF,3: HTL,1,1,2272500001:CPDS,2,1,15,15:HAID,2:RESETPINCOUNTER,3;


Unsuccessful message response, Subscription does not exist: RESP:15036;

11.2.3 CMS11HLRSUB - GET




<snb> Subscriber Number. 10 or 11 digits long. It can be up to32 diallable digits (which includes * and # characters)in the case of single DIRNUM ranges and if the SNB isnot used as subscriber key.



199155 10-CSH 150 82 Uen C 2007-01-24




<pinfailurecnt> Number of times that the subscriber failed to changehis PIN..


Figure 153 GET Response

<transaction_id> The transaction ID of the operation.




<srnb> Mobile Station Serial Number (8 hexadecimal digits).

<status> Connection Status.

<PCODE> Procedure Passcode. the default value is 0000. It is asecurity measure to prevent unauthorized users frommodifying certain subscriber services.

<mw> Messages Waiting.

<npa> Numbering Plan Area status indicator. 0-2

200 155 10-CSH 150 82 Uen C 2007-01-24


<hlrowned> Subscriber number HLR-owned. The availability of thisparameter depends on commercial agreements.



<airinterface> The air interface.

<loc> Multi value parameter with the format: STATUS, EXM,CCM, POINTCODE, MSCID, PROTOCOL





<pinfailurecnt> Number of times that the subscriber failed to changehis PIN..

11.2.3.3 Examples

Message request to get the properties of a subscriber:

GET:CMS11HLRSUB :SNB,5143457915;


RESP:0:IMSI, 310_00_5143457915:SNB, 5143457915: MSNB, 5143457915:PCODE, 1984: SRNB, 00000000: STATUS, CONNECTED: MW,3: HLROWNED, PORTED_IN: AUTHPERIODUNIT, INDEFINITE:DENIEDAUTHPERIODUNIT,"NUMBER OF CALLS": AIRINTERFACE,CDMA: LOC, NOT CONNECTED, , , , , : CNAP,0,1:MWI,7,1:CIN,1:DLQ,0:OCA,0:OLA,1:OPA,4:PIC,0:PINFAILURECNT,2;


201155 10-CSH 150 82 Uen C 2007-01-24


11.2.4 CMS11HLRSUB - DELETE



<transaction_id> The transaction ID of the DELETE operation.




<PORTOUT> Subscription Ported-out. The subscription is marked asported out. Any subsequent connection using a portedout subscriber number will be rejected.


Figure 155 Response

<transaction_id> The transaction ID of the DELETE transaction.


11.2.4.3 Examples

DELETE:CMS11HLRSUB:IMSI,123545643223 :PORTOUT,1;


Unsuccessful message response, Subscriber does not exist: RESP:15036.



202 155 10-CSH 150 82 Uen C 2007-01-24



















203155 10-CSH 150 82 Uen C 2007-01-24


Table 46 CMS11HLRSUB Subscription Parameters


AIRINTERFACE “CDMA” or “TDMA” FR

AUTHPERUNIT Assigns an Authentication Period ona subscriber basis. Values are:0: Not Used1: Per Call2: Hours3: Days4: Weeks5: Per Agreement6: Indefinite (default value) 7:Number of Calls.

CSFR

CDMA 1 C

DENAUTHPERUNIT Assigns a Denied AuthenticationPeriod on a subscriber basis. Valuesare:0: Not Used1: Per Call (default value)2: Hours3: Days4: Weeks5: Per Agreement6: Number of Calls7: Minutes

CSFR

EXM String or“UNKNOWN”

S

HAID 0-100 000 (included in R5) CSFR

HLROWNED Possible values are:PORTED_INPORTED_OUTOWNED

FR

IMSI 6-15 digits CSFR

LIALIST Composite parameter.Note:This parameter is mandatory if theLIA is specified.

CSFR

LIA Integer (included in R5 only) CSFR

LOC STATUS, EXM, CCM, POINTCODE,MSCID, PROTOCOL

FR

MSNB Mobile Station Number. Consists ofexactly 10 digits.

CSFR

MW 0: No messagesinteger: Number of messages

FR

204 155 10-CSH 150 82 Uen C 2007-01-24



NPA 0: No NPA split1: Min NPA split initiated, no accesswith NPAmin received2: Min NPA split initiated, accesswith NPAmin received3: Dirnum NPA split initiated4: Min & Dirnum NPA split initiated,no access with NPAmin received5: Min & Dirnum NPA split initiated,access with NPAmin received

FR

PCODE 0000-9999 (default value is 0000) C

PINFAILURECNT Integer (included in R5 only) R

PORTIN 1 C

PORTOUT 1 D

RDG 1-16 digits CSFR

RESETPINCOUNTER Integer (included in R5 only) S

SCLGRP 1-250 characters. Not allowed ifSCLGRP_OR is set.

CSFR

SCLGRP_OR 1-250 characters. Not allowed ifSCLGRP is set.

CSFR

SNB 10 or 11 digits CSFR

SRNB 8 hexadecimal digits. Default valueis FFFFFFFF

CSFR

SCLPASS 1 S

STATUS One of the following value:CONNECTEDNOT CONNECTEDUNDEFINED

FR

WINACT 0-1 CSFR

WINCAP 0-1 CSFR

VMSNB 1-20 digits CSFR

11.4 CMS11HLR Subscriber Data Abbreviations

In the table below, Activity indicates that the service needs to be activated.value “0” means the service is set as passive, value “1” means the serviceis active.

C-number indicates if the service has a C-number (“forward to” number).

205155 10-CSH 150 82 Uen C 2007-01-24


The value of the subscriber data should be seperated with commas, forexample: TBF,<value>,<activity>,<c-number>

Table 47 CMS11HLR Services

Service Desc. Value Activity C- number

ACB Automatic Call Barring.Automatically applies a specifiedbarring level to outgoing callswhen the subscriber becomesinactive (ex. turns power off).

0-15 x

ABA Abbreviated Alert.It enables the called party to bealerted with a short tone whena call is being forwarded, dueto the activation of the calledparty’s immediate call transferrelated services (CTF, CTV andVMT).Note:Included in R5 only.

0-1 X (Activeby default)

AIN Access to Originating INServices.Allows the HLR to be used asa network access point towardsthe SCP providing subscribers,in this way, access to IN servicesfor all incoming calls. This is anEricsson proprietary service.

0-1

ANT A-number Transfer.Provides subscriber with thenumber identification of thecalling party.

0,1,2 x

APB A-number Presentation Barring.Allows a subscriber to preventhis/her telephone number frombeing displayed when the calledparty has the ANT service.

0-1 x

ASU Absent Subscriber Service.Allows the operator to define asubscriber as absent.

0-15

AUH Authentication.Identifies the subscribers mobile phone as beingauthentication-capable. Thisservice is not allowed in a groupprofile.

0-1 x

206 155 10-CSH 150 82 Uen C 2007-01-24


BIC Barring of Incoming Calls.Allows the operator to barincoming calls to a subscriber, forexample, delinquent accounts.

0-1

BIN Access to Terminating INServices.Allows the HLR to be used asa network access point towardsthe SCP, allowing in this way,operators to bar incoming callsto a subscriber (i.e., in the caseof delinquent account). This isan Ericsson proprietary service.

0-1

CAW Call Waiting.Notifies a subscriber of anincoming call while on anothercall.

0-1 x

CBA Call Barring.Applies a specified barring levelto all of the subscriber s outgoingcalls.

0-63

CCA Subscriber-Controlled AbsentSubscriber Service.Allows a subscriber to indicatethat he/she is absent.

0-15 x

CCB Subscriber-Controlled CodeControl Barring.This service allows a subscriberto apply a specified barring levelto his outgoing calls.

0-15 x

CCC Control Channel Capability.Allows the operator to define thecontrol channel capability of asubscriber s mobile. It can beused to prevent unnecessaryuse of resources in attempting topage the subscriber.

0-3

CIN Access to Call Transfer INServices.Allows the HLR to be used asa network access point towardsthe SCP providing access to INservices for all outgoing callswith transfer.

0-1

207155 10-CSH 150 82 Uen C 2007-01-24


CNAP Call Name Presentation.Provides mobile subscribers withthe means to have the name ofthe calling party displayed ontheir mobile phone.

0,1,2 x

CNAPRND

Calling Name Presentation andRestriction-Redirecting NameDelivery.Displays both the name of thecalling party and the name of thedialed party on the subscriber smobile phone.

0-1

CPDS CDMA Packet Data Service.Allows communication servicesto access private or public PacketData Networks (PDNs such as,the internet or intranets), usingan air interface provided by thewireless service provider. Alsoallows movement of a wirelessuser engaged in a Packet Datasession. CPDS is replacing PDSand HSD, although these twoservices are kept for backwardcompatibility only.Note:CPDSQOS value is attached tothe service CPDS as::CPDS,x,y,<ap,nap|0>Possible values for CPDDSQOS:ap: Assured Priority Level:[0–15] (’0’ being the lowestpriority).nap: Non-Assured Priority Level:[0–15] (’0’ being the lowestpriority).0: Removes optional Quality ofService (QoS) priorities.Note:Included in R5 only.

0,1,2 X (Activeby default)

CTF Immediate Call Transfer, Fixed.Permits a subscriber to sendincoming calls to another fixeddirectory number regardlessof the call state (idle, busy, ornot reachable). All calls to thesubscriber s mobile station areimmediately forwarded to thesubscriber-defined C-number.

0-1 x x

208 155 10-CSH 150 82 Uen C 2007-01-24


CTV Immediate Call Transfer,Variable.Permits a subscriber to sendincoming calls to anotherdirectory number specified bythe subscriber regardless ofthe call state. All calls to thesubscriber s mobile station areimmediately forwarded to thesubscriber-defined C-number.

0-1 x x

DDB Do Not Disturb.Allows a subscriber to indicatethat his/her mobile is temporarilyunavailable. Prevents asubscriber from receivingincoming calls.

0-1 x

DOB Dynamic Outgoing Barring.Allows a subscriber todynamically control the outgoingcalls made from his mobile unit.The operator can regulate theservice level to specific networkneeds. The DOB servicelevels are operator definedproprietary values, which needto be mapped to the OI value, astandard interface parameter, inorder to send the information tothe MSC.Note:Included in R5 only.

0-15 x

DLQ Delinquent Account.Provides the Operator with themeans to manage subscriberswith overdue telecommunicationbills.

0-1

DPR Data Privacy.Allows a subscriber to encryptdata for transmission. Thisservice is not allowed in a groupprofile.

0-1

209155 10-CSH 150 82 Uen C 2007-01-24


DSV Data Service.Allows a subscriber to transmitand receive data digitallyon his/her mobile includingreceiving G3 faxes (up to 9600bit/s) from another mobile orsending a fax. The subscriber smobile must be G3 fax capable.

0-3 x

DUT Digit-by-Digit User Type.Designates a subscriber aspart of a fixed cellular network.This is an Ericsson proprietaryservice and is only available inEricsson MSCs.

0-1

DVP Digital Voice Privacy.Permits encrypting of digitalvoice channel if the subscribers MSC and the serving MSCsupport the service.

0-1 x

EricssonMulti Activation

Emergency Area.Specifies that calls are routed ina specific way in an MSC.

0-15

ENQ Enquiry. 0-4

HSD High Speed Packet Data. 0-1 x

HTL The Hotline service allows asubscriber to dial any number(with the exception of emergencynumbers and feature codes) toget connected to he subscriberdefined Hotline number. Asubscriber, through a featurecode, can change the Hotlinenumber.Note:HTLNB value is attached to theservice HTL as:: HTL, x, y,<htlnb>Note:Included in R5 only.

0-1 x

ICS Interception Service.Allows the operator to stop calldelivery to a subscriber andto route the calls to anotherdestination.

0, 1-15

210 155 10-CSH 150 82 Uen C 2007-01-24


IPC International PreferredInterexchange Carrier.Allows subscribers to choosethe Interexchange Carrier (IC)that is to be used for calling longdistance.

0,1-9998

ISE Immediate Charging Service.Outputs charge informationimmediately about a call to adesignated point defined on thenetwork. This is an Ericssonproprietary service and is onlyavailable in Ericsson MSCs.

0, 1-15

LBS Location Base Service. 0-1

LIA Limited Area.This service enables thesubscriber to be restricted toone or more Limited Areas (LIA),where the service is availablewithin the specified LIA(s), butnot outside of them. A LIA is alogical area that may span morethan one MSC.

0-1 X (Activeby default)

LIR Location Information Restriction. 0, 1, 2,3, 4

x

MCA Mobile Charging Area.Allows the operator to designatean area in which the subscribercan receive service at a specialcharge rate. This is an Ericssonproprietary service and isavailable only in Ericsson MSCs.

0,1-1023

MCD Mobile Call Delivery.Determines whether or not callsare to be delivered based on thesubscriber’s location.

0,1-127

x

MCH Mobile Charge Rate Order.Delivers charge rate informationabout incoming and outgoingcalls to the subscriber s mobilephone. This is an Ericssonproprietary service and is onlyavailable in Ericsson MSCs.

0, 1, 2

211155 10-CSH 150 82 Uen C 2007-01-24


MCN Mobile Charging AreaNotification.Notifies the subscriber whenhe/she is making a call in anarea with a high charge rate.This is an Ericsson proprietaryservice and is only available inEricsson MSCs.

0-1 x

MCT Malicious Call Tracing.Allows the subscriber to havecalls traced. This is an Ericssonproprietary service and is onlyavailable in Ericsson MSCs.

0-1 x

MPO Mobile Positioning Capability.Indicates the type of geographicpositioning information that theMS can provide to the network.

0-103 x

MPS Mobile Priority Subscriber.Provides the subscriber priorityaccess to voice or traffic channelfor outgoing calls, allowingoperators to identify subscriberswith high demands. This is anEricsson proprietary service andis only available in EricssonMSCs.

0, 1-17

MSA Mobile Subscription Area.Allows the operator to restrictthe subscriber from a particularmobile subscription area. This isan Ericsson proprietary serviceand is only available in EricssonMSCs.

0, 1-127

MVP Mobile Voice Privacy.Permits masking of the voicechannel by analog if thesubscriber s MSC and theserving MSC support thisservice. This is an Ericssonproprietary service and is onlyavailable in Ericsson MSCs.

0, 1-15

MWI Message Waiting Indicator.Informs a subscriber when amessage is available for retrievalif the subscriber has voice mail.

0-7 x

OCA Origin for C-Number Analysis.Origin for C-Number Analysis

0-511

212 155 10-CSH 150 82 Uen C 2007-01-24


OIA Origin for International RoamingAnalysis.Indicates the index of theInternational Analysis Tableto be used for InternationalRoaming Analysis.

0-511

OLA Origin for Location Analysis.Internal reference for theLocation Analysis Table.

0-511

OPA Origin for Procedure Code.A unique number used internallyin the HLR to identify theprocedure code table to be usedat service call.

0-15

OSA Origin for SMS Analysis Data.Allows to specify a list of nodesto which the subscriber isauthorized to send SMSRequestmessages and receiveSMSNotification message.

0-2147483646

OTG Origination Trigger Data.Allows the operator to specifycriteria for a subscriber sorigination triggers. Thesetriggers are used to activateWIN feature execution for thesubscriber when the subscribermakes a WINcall.

integer

PDS Packet Data Service.Provides support for packet databased applications.

0-1 x

PIC Preferred Inter-ExchangeCarrier.It is a unique number for the PICused internally within the HLR.Allows subscribers to choosethe Interexchange Carrier (IC)that is to be used for calling longdistance.

0-9998

PLI Preferred Language Indicator.Indicates the PreferredLanguage feature activitystatus and language associatedwith the subscriber.

0-255

213155 10-CSH 150 82 Uen C 2007-01-24


PLV Preferred Language VariableSupport.This allows the subscriber tochange his preferred languagethrough a feature code.

0-1

PPA Prepaid Application.Note:Included in R5 only.

0-255 X (Activeby default

PPP Prepaid.This allows the operator tospecify which exchange willsupport the prepaid service fora subscriber.

0-1

PRI Subscriber Priority.Specifies that calls should berouted in a specific way in anEricsson MSC.

0-3

RBT Customized Ring Back Tone.Allows the subscriber tocustomize their ring back toneto be like music, a song, or arecorded message, instead ofthe traditional ring back tone.The customized ring back tonewill be played to the calling partyuntil the call is being answeredor timed out.Note:Included in R5 only.

0-16 x

SMO Mobile Originating ShortMessage Service.Allows the operator to restrict thesubscriber’s SMS for outgoingmessages.

0-2

SMS SMS Terminating Restriction.Allows the operator to restrict thesubscriber’s SMS for incomingmessages.

0-2

214 155 10-CSH 150 82 Uen C 2007-01-24


SOT CDMA Service Option Table.A new set of commands wascreated to allow service optionsto be configured in the CDMAService Option Table (SOT).SOT is not a Service; it is areference to a Table. The SOTtables are provisioned through anew set of commands: HNSOC,HNSOE, HNSOF, HNSOI, andHNSOP.Note:Included in R5 only.

0-512

SPINA Subscriber PIN Access.Allows the subscriber to blockoriginating calls from a MobileStation when this service isactivated. The user of theMobile Station can receive butnot originate any calls, exceptemergency ones.Note:Included in R5 only.

0-1 x

SRM Subscriber Restricted Mobility.Specifies that calls should berouted in a particular way in anMSC.

0-1

TAL Trigger Address List.Provides an MSC with lists oftriggers and the associatedaddress of the network entitythat provides the service controlfunction for each list of triggers.

integer

TBF Call Transfer on Busy, Fixed.Allows a subscriber to sendincoming calls to a fixeddirectorynumber when the call state isbusy.

0-1 x x

TBV Call Transfer on Busy, Variable.Allows a subscriber to sendincoming calls to anotherdirectory number (C-Number)specified by the subscriberwhenthe call state is busy.

0-1 x x

TCL Type of Subscriber.Specifies the way calls arerouted in an MSC.

0-15

215155 10-CSH 150 82 Uen C 2007-01-24


TNF Call Transfer on No Reply,Fixed.Permits a subscriber to sendincoming call to a fixed directorynumber when the call state isnot reachable (inactive, no pageresponse, or no answer).

0-1 x x

TNV Call Transfer on No Reply,Variable.Permits a subscriber to sendincoming call to a directorynumber specified by thesubscriberwhen the call state isnot reachable (inactive, no pageresponse, or no answer).

0-1 x x

TTG Termination Triggers.Allows the operator to specifycriteria for a subscriber sterminating triggers. Theterminating triggers are used tostart WIN feature execution fora called subscriber if they aredetected during call setup.

0-46

VMB Busy Call Forwarding, VoiceMail.Permits a subscriber to sendincoming calls to a voice mailboxwhen the call state is busy.

0-1 x

VMN No Reply Call Forwarding, VoiceMail.Permits a subscriber to sendincoming calls to a voice mailboxwhen the call state is notreachable (inactive, no pageresponse, or no answer).

0-1 x

VMP Voice Mail Gateway Service.Registers the subscriber inthe voice mailbox service byspecifying his/her PEG, as wellas his/her voice mailbox number.

0-254

VMT Immediate Call Transfer, VoiceMail.Permits a subscriber to sendincoming calls to a voice mailboxregardless of the call state (idle,busy, or not reachable).

0-1 x

216 155 10-CSH 150 82 Uen C 2007-01-24


11.5 CMS11HLR Message Response

Here follows a description of the possible message response codes that can bereceived in a message response. The tables contain a column Type, indicatingthe seriousness/category of each response. Available categories are:



• Faulty data (D)

• Fatal error (F)


Table 48 CMS11HLRSUB




NE Answers (15001-15104)

IMSI format error 15001 S x x x x

Only one of the SNB or MSNBor IMSI can be specified

15002 D x x x x

Only one of the SNB or MSNBcan be specified

15005 D x x x x

Only one of SCLGRPor SCLGRP_OR can bespecified

15006 D x x

Format Error 15011 S x x x x

Missing Mandatory parameterRDG

15014 D x x

Maximum 50 subscribers canbe specified at a time

15015 D x

Range not supported 15016 D x x x x

Repetition in the parametervalue (followed by a dynamicmessage)

15017 D

SCL specified more thanonce (followed by a dynamicmessage)

15018 D x x

Multiple values not supported 15019 D x x x x

SNB not allowed with PREP 15020 D

217155 10-CSH 150 82 Uen C 2007-01-24




Missing mandatory parameter(followed by a dynamicmessage)

15021 D x x x x

Command Unknown 15022 S x x x x

Missing parameter value(followed by a dynamicmessage)

15026 S/D x x x x

Unreasonable value 15027 D x x x x

Subscriber number andC-number identical

15028 D x x

Invalid class value forsubscriber class

15030 D x x

Activity not valid for specifiedservice (followed by a dynamicmessage)

15033 D x x

Subscriber does not exist 15036 D x x x x

Subscriber already connectedto the HLR

15037 D x

MSNB cannot be used assubscriber key

15043 D x

IMSI cannot be used assubscriber key

15044 D x

EXM not defined (followed bya dynamic message)

15050 D x

Subscriber number notdefined

15051 D x x x

Authentication data notdefined

15055 D x x

Service for specifiedC-number not assignedto subscriber

15057 D x x

Subscriber does not havespecified service

15060 D x x

Specified RDG is invalid 15062 D x x

Dynamic WIN feature inactive 15064 D x x

Authentication Data notremoved

15065 D x x x

Number protected forauthentication

15069 D x

218 155 10-CSH 150 82 Uen C 2007-01-24




C-number is invalid 15070 D x x

Supplementary dataunavailable

15071 D x x

Combination of sbscriberclasses not allowed (followedby a dynamic message)

15074 D x x

Specified subscriber classnot allowed (due to thedependency on other classes)

15075 D x x

Subscriber not defined as aPort-in subscription

15077 D x

A Port-in subscriber numbercannot be ported out

15078 D x

Subscriber number notdefined as an HLROWNEDsubscription

15079 D x

Subscriber is ported-out 15080 D x

Cannot delete SI range if theSNB will be ported-out

15083 D x

Group not defined (followedby a dynamic message)

15089 D x x x x

MML provisioning notauthorized for user

15092 D x x x x

MML command not authorizedfor user

15093 D x x x x

Operation not authorized forservice

15094 D x x x x

Operation not authorized forlogical group

15095 D x x x x

Provisioning restricted by thelicense manager (followed bya dynamic message)

15097 D x x x x

Access Denied 15098 S/D x x x x

Session time-out 15100 T x x x x

Processing failure 15101 F x x x x

Node out of service 15103 T x x x x

More than one MSA in conflictfor the same MSC in assignedLIAs.

15104 D x x x

219155 10-CSH 150 82 Uen C 2007-01-24




Table not defined. 15105 D x x x

Limited area not defined. 15106 D x x x


Ext.system communicationlink failure

1001 x x x x




2001 F x x x x


2002 F x x x x








3005 S x x x x






220 155 10-CSH 150 82 Uen C 2007-01-24


12 CMS11AC Subscription

There are two versions of the CMS11AC. One is co-located AC with the HLRand the other is standalone AC.

When the AC is co-located with the HLR there are some dependencies betweenservice classes on the HLR subscription and the AC subscription. Routing ofcommands to the co-located AC is based on one of IMSI, MSNB and SNB.

When the AC is standalone, there are no dependencies between HLR and ACsubscriptions. Routing of commands to the standalone AC is based on IMSIonly.



12.1.1 Co-located AC

12.1.1.1 CMS11ACSUB - CREATE





<snb> Subscriber Number. 10 or 11 digits. This parameter isnot allowed when PREP and SRNB is used.

221155 10-CSH 150 82 Uen C 2007-01-24



<authkey> Operator Specified Sub-A-key: If this parameteris specified in the command, an A-key number isgenerated by the AC based on the given sub-A-keynumber.

<akeylength> System Generated A-key: The system generated A-keynumber is automatically created by the AC based onthe specified A-key length entered in the AC by theoperator, possible value: 6-26.

<DEFAULT> If the Default A-key parameter is specified in thecommand, a default A-key number is assigned to thespecified subscriber. The possible value is “1”.

<encauthkey> Encrypted Authentication Key: Operator specifiedencrypted sub-A-key number. Consists of either 16 or20 hexadecimal digits:

- 16 hex. digits: If DES algorithm is used for encryption.

- 20 hex. digits: if MCLAR Algorithm is used forencryption.

<prep> Indicates that the specified subscriber will bepre-provisioned in the AC.


<ssdsharable> Indicates whether Secret Share Data value is allowed tobe shared with the MSC for the indicated subscriber ornot. Only applicable for co-located.


Figure 157 Response



12.1.1.1.3 Examples


222 155 10-CSH 150 82 Uen C 2007-01-24


CREATE:CMS11ACSUB: IMSI,223495918582 :DEFAULT,1:SSDSHARABLE,1;



12.1.1.2 CMS11ACSUB - SET


Figure 158 SET command





<authkey> Operator Specified Sub-A-key: If this parameteris specified in the command, an A-key number isgenerated by the AC based on the given sub-A-keynumber.

<akeylength> System Generated A-key: The system generated A-keynumber is automatically created by the AC based onthe specified A-key length entered in the AC by theoperator, possible value: 6-26.

<DEFAULT> If the Default A-key parameter is specified in thecommand, a default A-key number is assigned to thespecified subscriber. The possible value is “1”.

223155 10-CSH 150 82 Uen C 2007-01-24







Figure 159 Response



12.1.1.2.3 Examples


SET:CMS11ACSUB :SNB,5143457900 :AKEYLENGTH,15:SSDSHARABLE,1;



224 155 10-CSH 150 82 Uen C 2007-01-24


12.1.1.3 CMS11ACSUB - GET


Figure 160 GET Operation




<snbstatus> Subscriber number AC connection status.

<akeystatus> Authentication Key status.

<ssdstatus> Shared Secret Data (SSD) status.

<auhactivity> Authentication activity status.

<autufailure> Total number of failures to respond correctly to uniquechallenge.

<ssdfailure> The number of SSDregeneration request failures.

<autrfailure> Total number of failures of authentication validation.


225155 10-CSH 150 82 Uen C 2007-01-24
















226 155 10-CSH 150 82 Uen C 2007-01-24


12.1.1.3.3 Examples


GET:CMS11ACSUB :IMSI,12345678912345;

Successful message response: RESP:0 :IMSI,12345678912345:SNB,5143457915 :MNSB,5143457915;


12.1.1.4 CMS11ACSUB - DELETE








Figure 163 Response



12.1.1.4.3 Examples

DELETE:CMS11ACSUB:IMSI,123545643223;



227155 10-CSH 150 82 Uen C 2007-01-24


12.1.2 Standalone AC

12.1.2.1 CMS11ACSUB - CREATE


Figure 164 CREATE Operation






<akey> Authentication Key, 1-20 digits.

<checksum> The default value is NONE. A number consisting of6 digits, which corresponds to the last 6 digits of theA-key.

<ruim> Removable User Identify Module.

1: Subscriber is RUIM capable.

0: Subscriber is not RUIM capable.



228 155 10-CSH 150 82 Uen C 2007-01-24



Figure 165 Response



12.1.2.1.3 Examples


CREATE:CMS11ACSUB: IMSI,223495918582 :AKEY,12453 :RUIM,1:SRNB,FFFFFFFF;



12.1.2.2 CMS11ACSUB - SET


Figure 166 SET Operation


<imsi> International Mobile Subscriber Identity. 6-15 digits.

<ruim> Removable User Identify Module.

1: Subscriber is RUIM capable.

0: Subscriber is not RUIM capable.

<srnb> Mobile Station Serial Number (8 hexadecimal digits).The default value is FFFFFFFF. This parameter is notallowed if DEACTIVATE is set.

229155 10-CSH 150 82 Uen C 2007-01-24



<deactivate> De-activates a subscriber in the AC. This parameter isnot allowed if SRNB is set.


Figure 167 Response



12.1.2.2.3 Examples


SET:CMS11ACSUB :IMSI,12345156561233 :DEACTIVATE,1;



12.1.2.3 CMS11ACSUB - GET


Figure 168 Get Operation




230 155 10-CSH 150 82 Uen C 2007-01-24















12.1.2.3.3 Examples


GET:CMS11ACSUB :IMSI,12345678912345;

231155 10-CSH 150 82 Uen C 2007-01-24


Successful message response: RESP:0 :IMSI,12345678912345:SNB,5143457915 :MSNB,5143457915;


12.1.2.4 CMS11ACSUB - DELETE


Figure 170 DELETE Operation




Figure 171 Response



12.1.2.4.3 Examples

DELETE:CMS11ACSUB:IMSI,123545643223;









232 155 10-CSH 150 82 Uen C 2007-01-24















Table 49 CMS11ACSUB Subscription Parameters


AKEY 1-20 digits CSFR

AKEYLENGTH 6-26 digits CSFR

233155 10-CSH 150 82 Uen C 2007-01-24



AKEYSTATUS Possible values are:INITIALPENDINGALARMEXPIREDCONFIRMED

FR

AUHACTIVITY Possbile values are:ACTIVEPASSIVEUNKNOWN

FR

AUTHKEY 1-20 digits CSFR

AUTRFAILURE integer FR

AUTUFAILURE integer FR

CHECKSUM 6 digits or NONE C

DEACTIVATE Possible value: 1(Not available in R5)

S

DEFAULT Possible value: 1 CSFR

ENCAUTHKEY 16 or 20 hexadecimal digits:16 hex. digits: If DES algorithm isused for encryption.20 hex. digits: If MCLAR Algorithmis used for encryption.

FR

IMSI 6-15 digits CSFR

MSNB Mobile Station Number. Consists ofexactly 10 digits.

CSFR

PREP Possible value: 1 C

RUIM 0-1 CS

SNB 10 or 11 digits. CSFR

SNBSTATUS Possible values are:CONNECTEDUNDEFINEDOTASP CONNECTED

FR

SRNB 8 hexadecimal digits. Default valueis FFFFFFFF

C

SSDFAILURE Integer FR

SSDSHARABLE 0,1 (included in R5 only) CSFR

SSDSTATUS Possible values are:UNSETPENDINGCONFIRMED

FR

234 155 10-CSH 150 82 Uen C 2007-01-24


12.3 CMS11AC Message Response

Here follows a description of the possible message response codes that can bereceived in a message response. The tables contain a column Type, indicatingthe seriousness/category of each response. Available categories are:



• Faulty data (D)

• Fatal error (F)


Table 50 CMS11ACSUB




NE Answers (15300-15499)

IMSI format error 15301 S/D x x x x

Only one of the SNB or MSNBor IMSI can be specified

15302 S/D x x x x

Only one of the SNB or MSNBcan be specified

15305 S/D x x x x

RUIM format error (followed bya dynamic message)

15307 S/D x

AKEY format error (followed bya dynamic message)

15308 S/D x

CHECKSUM format error(Followed by a dynamicmessage)

15309 S/D x

ESN format error (Followed bya dynamic message)

15310 S/D x

Format Error 15311 S x x x x

Missing mandatory parameterAKEYLENGTH or AUTHKEYor DEFAULT

15313 D x

Range not supported 15316 D x x x x

Multiple values not supported 15319 D x x x x

SNB not allowed with PREP 15320 D x

235155 10-CSH 150 82 Uen C 2007-01-24




Missing mandatory parameter(followed by a dynamicmessage)

15321 D x x x x

Command Unknown 15322 S/D x x x x

Missing parameter value(followed by a dynamicmessage)

15326 D x x x x

Unreasonable value 15327 DD x x x x

Subscriber already exists 15335 D x

Subscriber does not exist in theHLR

15336 D x x x x

Subscriber already connectedto the AC

15338 D x

Subscriber not connected tothe AC

15339 D x x x

Subscriber already connected 15347 D x

Subscriber number not defined 15351 D x x x x

Serial number not defined(followed by a dynamicmessage)

15352 D x

Subscriber does not haveauthentication service

15356 D x

Subscriber already activated 15358 D x

Subscriber alreadyde-activated

15359 D x

Authentication class active 15363 D x

SSD update ongoing 15368 T x

Not found (followed by adynamic message)

15382 S/D x x

MIN already defined (followedby a dynamic message)

15385 D x

SNB not defined (folloed by adynamic message)

15387 D x

Group not defined (followed bya dynamic message)

15389 D x x x x

Deletion not allowed whenAKEYSTATE is alarm

15390 T x

MML command not authorizedfor user

15392 F x x x x

236 155 10-CSH 150 82 Uen C 2007-01-24




Operation not authorized forservice

15393 F x x x x

Operation not authorized forlogical group

15394 F x x x x

Provisioning restricted by thelicense manager (followed by adynamic message)

15396 F x x x x

Access Denied 15397 F/T x x x x

Session time-out 15399 F x x x x

Processing failure 15400 F x x x x

Node out of service 15402 T x x x x


Ext.system communication linkfailure

1001 x x x x




2001 F x x x x


2002 F x x x x








3005 S x x x x






237155 10-CSH 150 82 Uen C 2007-01-24


238 155 10-CSH 150 82 Uen C 2007-01-24


13 MPC Subscription



a See reference: Reference [19]

b See reference: Reference [22]

c See reference: Reference [20]

d See reference: Reference [23]

e See reference: Reference [24]

f See reference: Reference [25]

g See reference: Reference [21]

h See reference: Reference [26]

13.1.1 Allowed/Barred Mobile Stations Data

The MPC node holds three Mobile Station (MS) lists that decides which MS’sthat is allowed/barred from the positioning service.

The three different kinds of lists are:

• ALLOWMSISDN - All allowed MS’s

• CLBARMSISDN - All client barred MS’s

• PLMNBARMSISDN - All PLMN barred MS’s

In all of these three lists it is possible to add (DEF) or delete (DEL) differentMSISDNs.

239155 10-CSH 150 82 Uen C 2007-01-24


13.1.1.1 Syntax of Modifying Allowed/Barred MS Data

Figure 172 Modify Allowed/Barred MSISDNs in a command

<def_msisdn> MSISDN to be added to one of the three lists.

<del_msisdn> MSISDN to be deleted from one of the three lists.

Changing the Allowed/Barred lists in an existing subscriber:

SET:MPCSUB:CLIENTID,CarRent:ALLOWMSISDN,DEF,46455395285,

DEL,46455395432:PLMNBARMSISDN,DEF,46455395678;

13.1.1.2 Syntax of Retrieved Allowed/Barred MS Data

Figure 173 Allowed/Barred MS Data response

<msisdn> An MSISDN tied to one of the three possible lists.

Note: Each list tag can only appear exactly zero or one time in response.

Example of a response containing Allowed/Barred MS Data:

RESP:0: ... :ALLOWMSISDN,46455395285,46455395432:

PLMNBARMSISDN,46455395678: ... ;

13.1.2 ServiceMappingList Data

13.1.2.1 Syntax of Modify ServiceMappingList Data

Figure 174 Modify ServiceMappingList data in command

240 155 10-CSH 150 82 Uen C 2007-01-24


<service_id> service_id be modified in the list .

<service_type> service_type be modified in the list

Changing the ServiceMappinglist in an existing subscriber:

SET:MPCSUB:CLIENTID,CarRent:SERVICEMAPPINGLIST,DEF,1,2,DEF,3,4;

SET:MPCSUB:CLIENTID,CarRent:SERVICEMAPPINGLIST,DEL, 1;

13.1.2.2 Syntax of Retrieved ServiceMappingList Data

Figure 175 ServiceMappingList data response

<service_id> service_id in response.

<service_type> service_type in response

Example of a response containing ServiceMappingList data:

RESP:0: ... :SERVICEMAPPINGLIST,1,2,3,4;



13.2.1 MPCSUB - CREATE


241155 10-CSH 150 82 Uen C 2007-01-24


Figure 176 CREATE Command242 155 10-CSH 150 82 Uen C 2007-01-24



<client_id> The client ID of the subscriber.

<client_name> The name of the subscriber.

<client_no> The number of the subscriber.

<client_type> The type of the subscriber.

<pwd> The password of the client ID.

<hide_bts> This parameter is set if the position answer to thesubscriber shall be distorted.

<priority> Priority of the positioning request sent from the client.

<authlevel> Defined which are the lists to be checked in order toconfirm that a specific client is allowed to positionspecific MSISDNs.

<maxdelay> Maximum number of seconds that the request can bedelayed.

<address> Address of the subscriber.

<activated> Indicates whether to activate a subscriber.

<city> The city in which the subscriber resides.

<contactperson> Responsible contact person.

<contactphone> Phone number of the contact person.

<mail> Contact person’s E-mail address.

<poi> Indicates if the subscriber shall be allowed to positionan MS (not supported in GMPC 5.0 ATI).

<postal> Subscriber’s postal number.

<gmpcclienttype> The type of the subscriber. 0 indicates that this clientbelongs to current GMPC and 1 indicates that this clientbelongs to other GMPC.

<internalid> Internally used identity to indicate the section used inthis client.

<callrelated> Indicate the client authorizations for the client. 0 meansauthorizations method and 1 means authorizations byMS number in callrelatedlist.

<dialledbyms> The number in callrelatedlist for authorizations.

243155 10-CSH 150 82 Uen C 2007-01-24


<maxmsreq> The request a subscriber can send towards GMPC canbe restricted. The limitation is set in terms of maximumnumber of MS and maximum number of positioningtimes each request is allowed to contain.

<checkbarredmsisdn>

If set as 1, the numbers in the Barred MSISDN list arebarred and unable to be positioned.

<checkplmnbarredmsisdn>

If set as 1, the numbers specified in PLMN barred listare barred and unable to position.

<checkallowedmsisdn>

If set as 1, the numbers in the Allowed MSISDN list canbe positioned.

<horizontalaccuracy>

Defines the subscriber’s default accuracy for thepositioning.

<pushurl> The URL where to push data.

<pushpassword> The pushpassword of the subscriber.

<pushuserid> The pushuserid of the subscriber when pushing data toa specific URL.

<responsetime> The response time for a positioning request.

<timeperiod> The reference used when limiting the subscriber to amaximum number of allowed positions per time period.

<maxmsisdninperiod>

The maximum number of MSISDN that the subscriberis allowed to position during the time perioud. A defaultvalue is assigned if leave the field empty, set as 0 todisable the function.

<geodatum> The reference system that describes the size and shapeof the earth.

<coordsys> Coordinate System, specifies the location on the earth.

<Allow/Bar MSData>


<maxTriggerTime> The maximum trigger time

<maxTriggerStartTimeDelay>

The maximum trigger start time delay

<minTriggerRecurrenceTime>


<triggersEnabled> Trigger enabled flag, 1 enabled , 0 disabled

244 155 10-CSH 150 82 Uen C 2007-01-24


<triggerPushID> The trigger of push ID

<triggerPushURL> The trigger of push URL

<serviceMappingList data>

The list of service mapping with contain service_id andservice_type


Figure 177 Response



13.2.1.3 Examples


CREATE:MPCSUB:CLIENTID,CarRent:CLIENTNO,614000 :CLIENTNAME,Car_retal_inc.:PWD,2secret:HIDEBTS,1 :ADDRESS,AbbyRoad:CLIENTTYPE,2:POSTAL,37268 :CITY,Cheesebourg:CONTACTPERSON,Mike.Johnson:CONTACTPHONE,045588877:MAIL,[email protected] :ACTIVATED,1:PRIORITY,0:POI,0:GEODATUM,1 :COORDSYS,1:MAXMSREQ,45:ALLOWMSISDN,DEF ,1234500000,DEF,1234500001:CLBARMSISDN,DEF,1234500002,DEF,1234500003:PLMNBARMSISDN,DEF ,1234500004:GMPCCLIENTTYPE,0:INTERNALID,2 :CALLRELATED,1:CALLRELATEDLIST,123456,654321 :MAXMSREQ,100:MAXMSISDNINPERIOD,400 :RESPONSETIME,1:MAXTRIGGERTIME,48:MAXTRIGGERSTARTIMEDELAY,20:MINTRIGGERRECURRENCETIME,100:TRIGGERSENABLED,1:TRIGGERPUSHID,1:TRIGGERPUSHPWD,123:TRIGGERPUSHURL,”http://www.ericsson.com”:SERVICEMAPPINGLIST,DEF,1,2;



13.2.2 MPCSUB - SET


245155 10-CSH 150 82 Uen C 2007-01-24


Figure 178 Set command

246 155 10-CSH 150 82 Uen C 2007-01-24







<pwd> The password of the client ID.

















247155 10-CSH 150 82 Uen C 2007-01-24



<checkbarredmsisdn>













<maxmsisdninperiod>




<Allow/Bar MSData>








248 155 10-CSH 150 82 Uen C 2007-01-24







Figure 179 Response



13.2.2.3 Examples


SET:MPCSUB:CLIENTID,CarRent:CLIENTNO,614000 :CLIENTNAME,Car_retal_inc.:PWD,2secret:HIDEBTS,1 :ADDRESS,AbbyRoad:CLIENTTYPE,2:POSTAL,37268 :CITY,Cheesebourg:CONTACTPERSON,Mike.Johnson:CONTACTPHONE,045588877:MAIL,[email protected] :ACTIVATED,1:PRIORITY,0:POI,0:GEODATUM,1 :COORDSYS,1:MAXMSREQ,45:ALLOWMSISDN,DEF ,1234500000,DEF,1234500001:CLBARMSISDN,DEF,1234500002,DEF,1234500003:PLMNBARMSISDN,DEF ,1234500004:GMPCCLIENTTYPE,0:INTERNALID,2 :CALLRELATED,1:CALLRELATEDLIST,123456,654321 :MAXMSREQ,100:MAXMSISDNINPERIOD,400 :RESPONSETIME,1:MAXTRIGGERTIME,48:MAXTRIGGERSTARTIMEDELAY,20:MINTRIGGERRECURRENCETIME,100:TRIGGERSENABLED,1:TRIGGERPUSHID,1:TRIGGERPUSHPWD,123:TRIGGERPUSHURL,”http://www.ericsson.com”:SERVICEMAPPINGLIST,DEF,1,2,DEL,3;


Unsuccessful message response, Subscription not exists: RESP:8602;

13.2.3 MPCSUB - GET


249155 10-CSH 150 82 Uen C 2007-01-24





250 155 10-CSH 150 82 Uen C 2007-01-24


<Allow/Bar MSData>



251155 10-CSH 150 82 Uen C 2007-01-24


Figure 181 Response

252 155 10-CSH 150 82 Uen C 2007-01-24























253155 10-CSH 150 82 Uen C 2007-01-24



<checkbarredmsisdn>













<maxmsisdninperiod>




<Allow/Bar MSData>








254 155 10-CSH 150 82 Uen C 2007-01-24






13.2.3.3 Examples

Message request to get all allowed MSISDN properties of the followingsubscriber with CLIENTID,CarRent:

GET:MPCSUB:CLIENTID,CarRent:ALLOWMSISDN;

Successful message response: RESP:0:CLIENTID,CarRent:ALLOWMSISDN,1234500000,1234500001;


Message request to get COORDSYS property:

GET:MPCSUB:CLIENTID,CarRent:COORDSYS;

Successful message response: RESP:0:CLIENTID,CarRent:COORDSYS,1;


13.2.4 MPCSUB - DELETE


Figure 182 DELETE command




Figure 183 Response



255155 10-CSH 150 82 Uen C 2007-01-24


13.2.4.3 Examples

DELETE:MPCSUB:CLIENTID,CarRent;










R - (Returned) Parameter can be returned with a value in the answer to a Getrequest (depends on request issued and filter specified).









256 155 10-CSH 150 82 Uen C 2007-01-24



For example, use case: "CcScsdR" indicates that in a Create operation theparameter is allowed in a DEF sub-operation, in Set the parameter is allowedin DEF, SET or DEL sub-operation, in Delete it is not allowed at all and theparameter can be returned in the answer to a Get request.

For example, use case: "C+S-R" indicates that in a Create operation theparameter is allowed to be added to a list attribute, in a Set operation theparameter is allowed to be deleted from a list attribute and the parameter canbe returned in the answer to a Get request.

Table 51 MPC Subscription Parameters


ADDRESS (Quoted) String: 1 - 255 characters CSFR

ACTIVATED 0-1 CSFR

AUTHLEVEL 0-3, default is 3 (excluded in MPC5.0 and 6.0)

CSFR

CALLRELATED 0-1, default is 0 (included in MPC6.0)

CSFR

CALLRELATEDLIST Sub-MO (included in MPC 6.0) CSFR

- <dialledbyms> String: 5-38 characters CcScdR

CHECKPLMNBARREDMSISDN

0-1 (included in MPC 5.0 and 6.0) CSFR

CHECKBARREDMSISDN 0-1 (included in MPC 5.0 and 6.0) CSFR

CHECKALLOWEDMSISDN 0-1 (included in MPC 5.0 and 6.0) CSFR

CITY (Quoted) String: 1-64 characters CSFR

CLIENTID (Quoted) String: 4-15 characters CSDGFR

CLIENTNAME (Quoted) String: 1-64 characters CSFR

CLIENTNO Integer: 3-15 digits (included in MPC5.0 and 6.0)

CSFR

CLIENTTYPE 0-3 (included in MPC 5.0 and 6.0) CSFR

CONTACTPERSON (Quoted) String: 1-64 characters CSFR

CONTACTPHONE (Quoted) String: 1-30 characters CSFR

COORDSYS 0 (undefined), 1 (LL), 2 (UTM), 3(RT90)(0 is not acceptable in MPC 5.0 and6.0)

CSFR

257155 10-CSH 150 82 Uen C 2007-01-24



GEODATUM 0 (Undefined), 1 (WGS-84), 2(Bessel-1841)(0 is not acceptable in MPC 5.0 and6.0)

CSFR

GMPCCLIENTTYPE 0-1 (this parameter is mandatory inMPC 6.0 and 0 will be set as defaultif not included in CAI)

CSFR

HIDEBTS 0-1 CSFR

HORIZONTALACCURACY 0-2 (included in MPC 5.0 and 6.0) CSFR

INTERNALID 0-4 (included in MPC 6.0) CSFR

MAIL (Quoted) String: 1 - 128 characters CSFR

MAXDELAY 0-65535 (excluded in MPC 5.0 and6.0)

CSFR

MAXMSIDINPERIOD integer: 0-8640000 (included inMPC 5.0 and 6.0)

CSFR

MAXMSREQ 1-200 CSR

POI 0-1, default 0 CSFR

POSTAL (Quoted) String: 1-15 characters CSFR

PRIORITY 0-65535 (this parameter ismandatary in MPC 5.0 and 6.0)

CSFR

PUSHURL string: 1-128 characters (included inMPC 5.0 and 6.0)

CSFR

PUSHUSERID string: 1-15 characters (included inMPC 5.0 and 6.0)

CSFR

PUSHPASSWORD string 1-15 characters (included inMPC 5.0 and 6.0)

CSFR

PWD String: 4-10 characters CS

RESPONSETIME 0-1 (included in MPC 5.0 and 6.0) CSFR

TIMEPERIOD integer: 1-86400 (in seconds)(included in MPC 5.0 and 6.0)

CSFR

ALLOWMSISDN Sub-MO CSF

- <Msisdn> Two value types: 1. <msisdn1>string: 5-15 characters 2.<msisdn1-msisdn2> string: 5-31characterNote msisdn1 & msisdn2 must havethe same length

CcScdR

CLBARMSISDN Sub-MO CSF

258 155 10-CSH 150 82 Uen C 2007-01-24




CcScdR

PLMNBARMSISDN Sub-MO CSF


CcScdR

MAXTRIGGERTIME 1–168(inlucde in MPC7.0) CSFR

MAXTRIGGERSTARTTIMEDELAY

1–48(inlucde in MPC7.0) CSFR

MINTRIGGERRECURRENCETIME

30–1440(included in MPC7.0) CSFR

TRIGGERSENABLED 0 (disabled) 1 (enabled) (included inMPC7.0)

CSFR

TRIGGERPUSHID String (included in MPC7.0) CSFR

TRIGGERPUSHPWD String (included in MPC7.0) CSFR

TRIGGERPUSHURL String (included in MPC7.0) CSFR

SERVICEMAPPINGLIST Sub-MO(included in MPC7.0) CSFR

— <service_id> Interger(included in MPC7.0) CcScdR

— <service_type> Interger(included in MPC7.0) CcScR

13.4 MPCSUB Message Response




• Faulty data (D)

• Fatal error (F)


259155 10-CSH 150 82 Uen C 2007-01-24


Table 52 MPCSUB

Description RespCode



NE Answers (8601-8700)

Client Id already exists 8601 D x

Client Id does not exist 8602 D x x x

No data stored in MPC 8603 T x x x

Error when reading allowedMSISDNs

8604 D x x x

Error when reading barredMSISDNs

8605 D x x x

Error when reading PLMNbarred MSISDNs

8606 D x x x

Invalid allowed MSISDN 8607 D x x

Invalid barred MSISDN 8608 D x x

Invalid PLMN barred MSISDN 8609 D x x

No need for this action due toclient level of authority

8610 S x x x

The specified MO is notregistered in MPC

8611 F/T x x x x

Unknown fault in MPC 8620 F x x x x

Invalid Client Id 8651 D x

Invalid Password 8652 D x x

Invalid Client Name 8653 D x

Password has no value 8654 D x

Client Name has no value 8655 D x

Invalid Clinet No. 8656 D x x

Invalid Coordinate Systemvalue

8657 D x x

Invalid Geodetic Datum value 8658 D x x

Invalid HideBTS value 8659 D x x

Invalid ClientType value 8660 D x x

Invalid MSISDN Period value 8661 D x x

Invalid TimePeriod value 8662 D x x

Invalid PrivacyOverride value 8663 D x x

Invalid MSISDN value 8664 D x x

260 155 10-CSH 150 82 Uen C 2007-01-24




CoordinateSystem andGeodeticDatum should besupplied together

8665 D x x

GMPCClientType is missing 8666 D x x

GMPCClientType is out ofrange

8667 D x x

ClientType is not set to"PLMNOperator" when settingInternal Id, or invalid Internal Idis used.

8668 D x x

PrivacyOverride is included inthe "addClient" request

8669 D x x

MaxMSID is out of range 8670 D x x

ResponseTime is out of range 8671 D x x

CallRelated is out of range, orCallRelatedList is included inrequest but CallRelated is notset

8672 D x x

DialledByMS is out of range 8673 D x x

Two identical DialledByMS inthe same CallRelatedList

8674 D x x

Service mapping not whithinrange

8675 D x x


Ext.system communication linkfailure

1001 x x x x




2001 F x x x x


2002 F x x x x






261155 10-CSH 150 82 Uen C 2007-01-24





3005 S x x x x






262 155 10-CSH 150 82 Uen C 2007-01-24


14 AAA Subscription



a See reference: Reference [19]

b See reference: Reference [22]

c See reference: Reference [20]

d See reference: Reference [23]

e See reference: Reference [24]

f See reference: Reference [25]

g See reference: Reference [21]

h See reference: Reference [26]

14.1.1 AAA

14.1.1.1 SecurityAssocMNHA Data

This is the way Ericsson AAA Server implements a security associationbetween a mobile node (the user) and a Home Agent (Ha) by linking an HAIP address to a secret (HA Security Association).

14.1.1.1.1 Syntax of SecurityAssocMNHA Data Definition

Figure 184 SecurityAssocMN-HA Data in Create Command

<index> Index of array.

<haipaddress> IP address for the Home Agent.

<SPI> Security Parameter Index, for E-AAA 2.1 only.

263155 10-CSH 150 82 Uen C 2007-01-24


<hasecurityassoc> Identify the key used to establish a secure connectionbetween the Mobile Node (MN) and the HomeAgent(HA).

14.1.1.1.2 Syntax of SecurityAssocMNHA Data Changing

Figure 185 SecurityAssocMN-HA Data in Set Command


<haipaddress> IP address for the Home Agent.

<SPI> Security Parameter Index, for E-AAA 2.1 only.

<hasecurityassoc> Identify the key used to establish a secure connectionbetween the Mobile Node (MN) and the HomeAgent(HA).

14.1.1.1.3 Syntax of SecurityAssocMNHA Data Deletion

Figure 186 SecurityAssocMN-HA Data in Delete Command


264 155 10-CSH 150 82 Uen C 2007-01-24


14.1.1.2 ActiveSessions Data

14.1.1.2.1 Syntax of Retrieved ActiveSessions Data

Figure 187 ActiveSessions Data Response

<session_id> Session Identifier.

<session_name> The name of a session.

<client_ip> The IP address of a user connecting to the server.

<request_id> Request Identifier.

<request_time> The start time of request.

14.1.1.2.2 Syntax of ActiveSessions Data Deletion

Figure 188 ActiveSessions Data Deletion

<session_id> Session Identifier.

Note: This operation is only applicable for E-AAA 2.1.

14.1.1.3 AccessServicesArray

AccessServicesArray is a list of AAA-AccessServices an user is associated to.This subMO is only applicable for E-AAA 2.1.

14.1.1.3.1 Syntax of AccessServicesArray Definition

Figure 189 Access Services Array Definition

<accessservice_id>

Access Service Identifier.

265155 10-CSH 150 82 Uen C 2007-01-24


14.1.1.3.2 Syntax of AccessServicesArray Deletion

Figure 190 Access Services Array Deletion

<accessservice_id>

Access Service Identifier.

14.1.1.4 AdditionalInfoList Data

This attribute allows to define specific user information according to operatorneeds.

14.1.1.4.1 Syntax of ADDITIONALINFOLIST Definition

Figure 191 USIS 1.0 ADDITIONALINFOLIST DEF Definition

Figure 192 USIS 2.0 ADDITIONALINFOLIST DEF Definition

Array Index Unsigned type, Example: "0"

Tag String Type, Example: "sponsor"

Value String Type, Example: "enterprise"

14.1.1.4.2 Syntax of ADDITIONALINFOLIST Deletion

Figure 193 USIS 1.0 ADDTIONALINFOLIST DEL Definition

Figure 194 USIS 2.0 ADDITIONALINFOLIST DEL Definition

14.1.2 AAAPRIVPROFILE

14.1.2.1 RequestValidationList Data

RequestValidationList Data specifies a set of requirements by means of alogical formula that must be met in order to accept Access-Request.

266 155 10-CSH 150 82 Uen C 2007-01-24


14.1.2.1.1 Syntax of RequestValidationList Data Definition

Figure 195 RequestValidationList in Create Command

<arrayindex> Index of array. Must be used in order.

<attributevendorid>

ID number of the attribute vendor.

<attributetype> The type of the attribute.

<value1> The start value of the validation list.

<value2> The end value of the validation list.

<requestcreteria> The creteria of the value request.

<operatorwithnext>

Specifies the logic relationship with the next entry.

<parentheses> parentheses

14.1.2.1.2 Syntax of RequestValidationList Data Changing

Figure 196 RequestValidationList Data in Set Command

<arrayindex> Index of array. Must be used in order.

<attributevendorid>



<value1> The start value of the validation list.

<value2> The end value of the validation list.

<requestcreteria> The creteria of the value request.

267155 10-CSH 150 82 Uen C 2007-01-24


<operatorwithnext>

Specifies the logic relationship with the next entry.

<parentheses> parentheses

14.1.2.1.3 Syntax of RequestValidationList Data Deletion

Figure 197 RequestValidationList Data in Delete Command

<arrayindex> Index of array. Must be used in order, the last indexshould be deleted first in DELETE operation.

14.1.2.2 ReplyGenerationList Data

ReplyGenerationList specifies the list of attributes to include in anAccess-Accept message.

14.1.2.2.1 Syntax of ReplyGenerationList Data Definition

Figure 198 USIS 1.0 REPLYGENERATIONLIST DEF Syntax

Figure 199 USIS 2.0 REPLYGENERATIONLIST DEF Syntax

<arrayindex> Index of array.

268 155 10-CSH 150 82 Uen C 2007-01-24


<profileelementmode>

The mode of the profile element.

<listentrymode> The mode of list entry.

<attributevendorid>



<value> value

<calculatedBasedattribute>

new added. Boolean Type. TRUE/FALSE

<filter> new added

14.1.2.2.2 Syntax of ReplyGenerationList Data Changing

Figure 200 USIS 1.0 REPLYGENERATIONLIST SET Syntax

Figure 201 USIS 2.0 REPLYGENERATIONLIST SET Syntax


<profileelementmode>

The mode of the profile element.

<listentrymode> The mode of list entry.

269155 10-CSH 150 82 Uen C 2007-01-24


<attributevendorid>



<value> value

<calculatedBasedattribute>

new added. Boolean Type. TRUE/FALSE

<filter> new added

14.1.2.2.3 Syntax of ReplyGenerationList Data Deletion

Figure 202 ReplyGenerationList Data in Delete Command


14.1.2.3 TriggerList Data

TriggerList data is a list of event types with associated actions, possibley empty.

14.1.2.3.1 Syntax of TriggerList Data Definition

Figure 203 TriggerList Data in Create Command


<eventid> ID number of the event.

<handlername> The handler name.

14.1.2.3.2 Syntax of TriggerList Data Changing

Figure 204 TriggerList Data in Set Command


270 155 10-CSH 150 82 Uen C 2007-01-24


<eventid> ID number of the event.

<handlername> The handler name.

14.1.2.3.3 Syntax of TriggerList Data Deletion

Figure 205 TriggerList Data in Delete Command


14.1.2.4 PoolsList Data

The IP pool is a list of pool of IP addresses from which the user IP addresswill be fetched.

14.1.2.4.1 Syntax of PoolsList Data Definition

Figure 206 PoolsList Data in Create Command


<poolname> The pool name.

14.1.2.4.2 Syntax of PoolsList Data Changing

Figure 207 PoolsList Data in Set Command


<poolname> The pool name.

14.1.2.4.3 Syntax of PoolsList Data Deletion

Figure 208 PoolsList Data in Delete Command


271155 10-CSH 150 82 Uen C 2007-01-24



14.2.1 AAASUB

14.2.1.1 AAASUB - CREATE


Figure 209 Create Command


<username> The name of the subscriber. It should be unique in theuser registry.

<organisationname>

The organization name of the subscriber to be defined.

<imsi> The IMSI number of the subscriber to be defined.

<msisdn> The MSISDN number of the subscriber to be defined.

<min> The MIN number of the subscriber to be defined. Thisnumber is similar to IMSI in GSM.

<password> The password for the subscriber in the registry database(encrypted).

<profileselectorname>

The key of AAA_ProfileSelector to be defined.

<sharedprofilename>

The key of AAA_SharedProfile to be defined.

272 155 10-CSH 150 82 Uen C 2007-01-24


<SecurityAssocMNHA Data>

See Section 14.1.1.1 on page 263.

<AccessServicesArray>

See Section 14.1.1.3 on page 265. (This subMO is onlyapplicable in E-AAA 2.1)


Figure 210 Response

<transaction_id> The transaction Id of the CREATE transaction.

<resp_code> The response code that is returned. See Table 55 onpage 292.

14.2.1.1.3 Examples

Message request to define a subscription with the following properties:

CREATE:AAASUB: USERNAME,"[email protected]": ORGANISATIONNAME,ABC: IMSI,3105143457900: PASSWORD,abc123: SHAREDPROFILENAME,profile-a: SECURITYASSOCMNHA,DEF,0,12.12.12.13,1,ABE343;


Unsuccessful message response: RESP: 11801;

14.2.1.2 AAASUB - SET

The subscriber data might be assigned values according to the parameterdefinitions in asn.1 file.

273155 10-CSH 150 82 Uen C 2007-01-24




<trans_id> The transaction Id of the SET provisioning operation.


<organisationname>

The organisation name of the subscriber which is to bemodified.

<imsi> The IMSI number of the subscriber to be modified.

<msisdn> The MSISDN number of the subscriber to be modified.

<min> The MIN number of the subscriber to be defined. Thisnumber is similar to IMSI in GSM.

<password> The password for the subscriber to be modified.


The key of AAA_ProfileSelector to be modified.

<sharedprofilename>

The key of AAA_SharedProfile to be modified.





274 155 10-CSH 150 82 Uen C 2007-01-24


<ActiveSessionsData>



Figure 212 Response

<trans_id> The transaction Id of the SET transaction.


14.2.1.2.3 Examples


SET:AAASUB:USERNAME,"[email protected]": ORGANISATIONNAME,RDC: IMSI,3105143457900: MSISDN,86011234567: PASSWORD,abc123:SHAREDPROFILENAME,profile-a: SECURITYASSOCMNHA,DEF,0,"11.11.11.11",1,2344,DEF,1,"12.12.12.12",2,2322;



14.2.1.3 AAASUB - GET



275155 10-CSH 150 82 Uen C 2007-01-24



<organisationname>

The organization name of the subscriber to bedisplayed.


Figure 214 Response



<organisationname>

The organization name of the subscriber to bedisplayed.

<imsi> The IMSI number of the subscriber to be displayed.

<msisdn> The MSISDN number of the subscriber.

<min> The MIN number of the subscriber to be displayed. It’sonly used in U.S. which is similar to IMSI in GSM.


The key of AAA_ProfileSelector to be displayed.

<sharedprofilename>

The key of AAA_SharedProfile to be displayed.

<ActiveSessionsData>


276 155 10-CSH 150 82 Uen C 2007-01-24


<hasactivesession>

The identifier whether the subscriber has activesessions.





14.2.1.3.3 Examples

Message request to get all the properties of a subscriber with USERNAMEand ORGANIZATIONNAME:

GET:AAASUB:USERNAME,"[email protected]":ORGANIZATIONNAME,RDC;

Successful message response: RESP:0: USERNAME,"[email protected]":ORGANISATIONNAME,RDC: IMSI,3105143457900:SHAREDPROFILENAME,profile-a: ACTIVESESSION,123,11.22.33.44,23,2,4612372,234.234.234.234,16: HASACTIVESESSION,1:SECURITYASSOCMNHA,0,12.12.1.1,2,abcdf2;

Unsuccessful message response: RESP:11812;

Message request to get the properties SHAREDPROFILENAME of a subscriberwith USERNAME and ORGANISATIONNAME:

GET:AAASUB:USERNAME,"[email protected]": ORGANIZATIONNAME,RDC: SHAREDPROFILENAME;

Successful message response: RESP:0: USERNAME,"[email protected]":ORGANIZATIONNAME,RDC: SHAREDPROFILENAME,profile-a:


14.2.1.4 AAASUB - DELETE



<trans_id> The transaction Id of the DELETE provisioningoperation.


277155 10-CSH 150 82 Uen C 2007-01-24


<organisationname>

The organisation name of the subscriber which is to bedeleted.


Figure 216 Response

<trans_id> The transaction Id of the DELETE transaction.


14.2.1.4.3 Examples

Message request to delete a subscriber with the following properties:

DELETE:AAASUB:USERNAME,"[email protected]":ORGANISATIONNAME,RDC;



278 155 10-CSH 150 82 Uen C 2007-01-24



14.2.2.1 AAAPRIVPROFILE - CREATE


Figure 217 Create Command



<organisationname>


<privateprofilename>

The name of the private profile.

<RequestValidationList Data>


279155 10-CSH 150 82 Uen C 2007-01-24


<ReplyGenerationList Data>


<TriggerList Data> See Section 14.1.2.3 on page 270.

<PoolList Data> See Section 14.1.2.4 on page 271.

<maxconcurrentsessions>

The maximum concurrent sessions that can be reached.

<isprepaid> Specifies if the private profile belongs to a prepaid user.

<accumulatedreplenishment>

Contains the sum of all credit refills for a prepaid user.

<accumulatedusage>

Contains all credit consumed by a prepaid user.

<useprivatethreshold>

Specifies where to get prepaidThreshold from (privateor shared profile).

<prepaidthreshold>

Specifies the minimum amount of the credit.

Note: The parameter PRIVATEPROFILENAME should have the same valuewith one of pre-defined SharedProfiles’ name.

Note: When both USEPRIVATETHRESHOLD and ISPREPAID value are setto 1, make sure that the value of “ACCUMULATEDREPLENISHMENT- ACCUMULATEDUSAGE” is larger than the value ofPREPAIDTHRESHOLD.


Figure 218 Response

<trans_id> The transaction Id of the CREATE transaction.


14.2.2.1.3 Examples

Message request to define a private profile with the following properties:

CREATE:AAAPRIVPROFILE:USERNAME,"[email protected]":ORGANISATIONNAME,"RDC"

280 155 10-CSH 150 82 Uen C 2007-01-24


:PRIVATEPROFILENAME,p-01:REQUESTVALIDATIONLIST,DEF,0,333,11,val1,val1,

REQUESTSPECIFICVALUEORRANGE,AND,0,DEF,1,444,22,ff,gg,

REQUESTSPECIFICVALUEORRANGE,AND,0,DEF,2,333,33,cc,ccc,

REQUESTSPECIFICVALUEORRANGE,UNUSED,0:REPLYGENERATIONLIST,DEF,0,

ADD,FIXED,11,111,aaaa,DEF,1,ADD,FIXED,22,222,bbbb,DEF,2,ADD,FIXED,33,333,ccc:

TRIGGERLIST,DEF,0,ACCESSREQUEST,aaa,DEF,1,ACCESSREQUEST,bbb,

DEF,2,ACCESSREQUEST,ccc:MAXCONCURRENTSESSIONS,20

:POOLSLIST,DEF,0,aaa,DEF,1,bbb,DEF,2,ccc;



14.2.2.2 AAAPRIVPROFILE - SET

The private profile data might be assigned values according to the parameterdefinitions in asn.1 file.

281155 10-CSH 150 82 Uen C 2007-01-24




<trans_id> The transaction ID of the SET provisioning operation.


<organisationname>










282 155 10-CSH 150 82 Uen C 2007-01-24







<accumulatedusage>




<prepaidthreshold>


Note: When both USEPRIVATETHRESHOLD and ISPREPAID value are setto 1, make sure that the value of “ACCUMULATEDREPLENISHMENT+ ACCUMULATEDUSAGE” is larger then the value ofPREPAIDTHRESHOLD.


Figure 220 Response

<trans_id> The transaction Id of the SET transaction.


14.2.2.2.3 Examples


SET:AAAPRIVPROFILE:USERNAME,"[email protected]":ORGANISATIONNAME,"RDC"

:PRIVATEPROFILENAME,p-01:REQUESTVALIDATIONLIST,SET,1,333,11,val1,val1,

REQUESTSPECIFICVALUEORRANGE,AND,0,SET,2,444,22,ff,gg,

REQUESTSPECIFICVALUEORRANGE,AND,0,DEL,3:

REPLYGENERATIONLIST,DEF,9,ADD,FIXED,99,999,aaaa,SET,2,ADD,

FIXED,23,223,bbbb,DEL,3:TRIGGERLIST,DEF,9,ACCESSREQUEST,aaa9,SET,2,

283155 10-CSH 150 82 Uen C 2007-01-24


ACCESSREQUEST,bbb2,DEL,3:MAXCONCURRENTSESSIONS,90

:POOLSLIST,DEF,9,aaa9,SET,2,bbb,DEL,3;



14.2.2.3 AAAPRIVPROFILE - GET



<trans_id> The transaction Id of the GET provisioning operation.


<organisationname>




284 155 10-CSH 150 82 Uen C 2007-01-24



Figure 222 Response













285155 10-CSH 150 82 Uen C 2007-01-24


<organisationname>





<accumulatedusage>




<prepaidthreshold>


14.2.2.3.3 Examples

Message request to get all the properties of a private profile with USERNAMEand ORGANISATIONNAME:

GET:AAAPRIVPROFILE:USERNAME,"[email protected]":ORGANISATIONNAME,"ABC"

:PRIVATEPROFILENAME,"p-01";

Successful message response: RESP:0:USERNAME,"[email protected]":ORGANISATIONNAME,ABC: PRIVATEPROFILENAME,p-01: ISPREPAID,0:ACCUMULATEDREPLENISHMENT,100: ACCUMULATEDUSAGE,10:USEPRIVATETHRESHOLD,1: PREPAIDTHRESHOLD,50;


14.2.2.4 AAAPRIVPROFILE - DELETE



<trans_id> The transaction Id of the DELETE provisioningoperation.

286 155 10-CSH 150 82 Uen C 2007-01-24



<organisationname>

The organization name of the subscriber to be deleted.




Figure 224 Response

<trans_id> The transaction Id of the DELETE transaction.


14.2.2.4.3 Examples

Message request to delete private profile with the following properties:

DELETE:AAAPRIVPROFILE:USERNAME,"[email protected]":ORGANISATIONNAME,"RDC"

:PRIVATEPROFILENAME,"p-01";










287155 10-CSH 150 82 Uen C 2007-01-24


R - (Returned) Parameter can be returned with a value in the answer to a Getrequest (depends on request issued and filter specified).










For example, use case: "CcScsdR" indicates that in a Create operation theparameter is allowed in a DEF sub-operation, in Set the parameter is allowedin DEF, SET or DEL sub-operation, in Delete it is not allowed at all and theparameter can be returned in the answer to a Get request.

For example, use case: "C+S-R" indicates that in a Create operation theparameter is allowed to be added to a list attribute, in a Set operation theparameter is allowed to be deleted from a list attribute and the parameter canbe returned in the answer to a Get request.

14.3.1 AAA Subscription Parameters

Table 53 AAA Subscription Parameters


USERNAME String: 1-64 characters CSDGFR


MSISDN 5-15 digits CSRF

MIN 10 digits CSRF

PASSWORD String: 1-64 characters CSRF

288 155 10-CSH 150 82 Uen C 2007-01-24



ORGNISATIONNAME

String: 1-30 characters CSRF

PROFILESELECTORNAME


SHAREDPROFILENAME


ACCESSSERVICESARRAY

accessserviceid: String CcSdRF

ACTIVESESSIONS

-sessionID: String CSdR

-clientIP: 7-15 digits CcSsR

-requestID: Integer 0-65535 CcSsR

-requestTime: String CcSsR

-sessionName: String 1-64 characters CcSsdR

HASACTIVESESSION

0-1 RF

SECURITYASSOCMNHA

-index: Integer 0-255 CcSsdR

-haIpAddress: 7-15 digits CcSsR

-SPI: Integer (only for E-AAA 2.1) CcSsR

-haSecurityAssoc: String CcSsR

AdditionalInfoList

-ArrayIndex: Unsigned type, Example: "0"

-Tag: String Type, Example: "sponsor"

-Value: String Type, Example: "enterprise"

14.3.2 AAAPRIVPROFILE Parameters

Table 54 AAAPRIVPROFILE Subscription Parameters


ACCUMULATEDREPLENISHMENT

Integer: 0-65534Default value: 0(only for E-AAA 2.1)

CSRF

ACCUMULATEDUSAGE


CSRF

289155 10-CSH 150 82 Uen C 2007-01-24



ISPREPAID 0-1Default value: 0(only for E-AAA 2.1)

CSRF

MAXCONCURRENTSESSIONS

Integer: 0-65534Default value: 1

CSRF

REQUESTVALIDATIONLIST

-ARRAYINDEX

Integer: 0-65534 CcScsdR

-ATTRIBUTEVENDORID

Integer: -1-32766 CcScsR

-ATTRIBUTETYPE

Integer: 0-65534 CcScsR

-VALUE1 String: 0-256 characters CcScsR

-VALUE2 String: 0-256 characters CcScsR

-REQUESTCRITERIA

String. Possible values are:REQUESTSPECIFICVALUEORRANGEREQUESTANYVALUEDENYSPECIFICVALUEORRANGEDENYALLVALUES

CcScsR

-OPERATORWITHNEXT

String. Possible values are:UNUSEDANDORNANDNORXOR

CcScsR

-PARANTHESES

Integer -32767-32766 CcScsR

REPLYGENERATIONLIST

-ARRARYINDEX


-PROFILEELEMENTMODE

String. Possible values are:ADDDELETEREPLACE

CcScsR

290 155 10-CSH 150 82 Uen C 2007-01-24



-LISTENTRYMODE

String. Possible values are:FIXEDREQUESTVALUEDEFAULTVALUEDERIVEDVALUEANYREQUESTVALUE

CcScsR

-ATTRIBUTEVENDORID


-ATTRIBUTETYPE


-VALUE String: 0-256 characters CcScsR

TRIGGERLIST

-ARRARYINDEX


-EVENTID String. Possible values are:ACCESSREQUESTACCTREQUESTSTARTACCTREQUESTSTOPACCTREQUESTINTERIMACCTREQUESTTUNNELSTARTACCTREQUESTTUNNELSTOPACCTREQUESTTUNNELREJECTACCTREQUESTTUNNELLINKSTARTACCTREQUESTTUNNELLINKSTOPACCTREQUESTTUNNELLINKREJECT

CcScsR

-HANDLERNAME

String: 0-254 CcScsR

POOLSLIST

-ARRAYINDEX


-POOLNAME String: 0-254 CcScsR

PREPAIDTHRESHOLD


CSRF

USEPRIVATETHRESHOLD

0-1Default value: 0(only for E-AAA 2.1)

CSRF

14.4 AAASUB Message Response


291155 10-CSH 150 82 Uen C 2007-01-24




• Faulty data (D)

• Fatal error (F)


14.4.1 AAASUB

Table 55 AAASUB




Subscription alreadyexists/Data uniquenessvalidation

11801 D x

Subscription not defined 11802 D x x x

NE busy 11803 T/F x x x x

NE login error/Not enoughauthority

11804 F x x x x

Data inconsistency in NE 11805 F x x x

Operation timeout 11806 T/F x x x x

Constraint validation 11807 F x x

Type or value already exists 11808 F x x

Concurrent accessing ofUnique Identifier Counter

11809 T/F x

Unable to get a valid UniqueIdentifier Counter

11810 T/F x

A syntactically invalid DN wasspecified or the authenticationmethod specified is unknown

11811 D x x x x

NE can’t find the specifiedobject

11812 T/F x


Ext.system communicationlink failure

1001 T/F x x x x

External System Error 1002 F x x x x

292 155 10-CSH 150 82 Uen C 2007-01-24






2001 F x x x x


2002 F x x x x







3005 S x x x x


Table 56 AAAPRIVPROFILE




Subscription alreadyexists/Data uniquenessvalidation

11801 D x

Subscription not defined 11802 D x x x x

NE busy 11803 T/F x x x x

NE login error/Not enoughauthority

11804 F x x x x

Data inconsistency in NE 11805 F x x x

Operation timeout 11806 T/F x x x x

Constraint validation 11807 F x x

Type or value already exists 11808 F x x

Concurrent accessing ofUnique Identifier Counter

11809 T/F x

Unable to get a valid UniqueIdentifier Counter

11810 T/F x

293155 10-CSH 150 82 Uen C 2007-01-24




A syntactically invalid DN wasspecified or the authenticationmethod specified is unknown

11811 D x x x x

NE can’t find the specifiedobject

11812 T/F x

Array Index Error 11820 D x x

Operator of RVL Error 11821 D x x

Inappropriate Matching 11822 D x x


Protocol Error 1001 F x x x x

External System Error 1002 F x x x x



2001 F x x x x


2002 F x x x x







3005 S x x x x

294 155 10-CSH 150 82 Uen C 2007-01-24


15 Appendix A (Graphical Structure)

To simplify the algorithms for the user in Customer Service Orders, the structureis displayed graphically. In this appendix the structure is explained in detailwith the help of the examples below.

15.1 Example 1

Figure 225 An Example of the Algorithm Structure Usage

The first row in this figure will be translated as follows:

RESP:<resp_code>:MSISDN, <msisdn_number>

In the second row it will be possible to do either:

• nothing

• IMSI AND AMSISDN

• IMSI OR AMSISDN

In the last row it will possible to do either:

• nothing

• Subscriber data (1 to x times)

15.2 Example 2

Figure 226 An Example Showing the Usage for Special Parameter

295155 10-CSH 150 82 Uen C 2007-01-24


In the second row of this figure, both parameters MSISDN and IMSI aresurrounded by square boxes, that is Ericsson Multi Activation will route thiscommand to corresponding NE based on this two key identifiers of the HLRsubscription.

In the second row of this figure, the optional parameter Subscriber Data isitalicized, that is this parameter refers to more detailed description from anotherplace in this document. The referred section has been listed below.

15.3 Example 3

Figure 227 An Example Showing the use of a Mandatory Path

The * sign indicates that one of the paths is mandatory. In this example it ismandatory for SEMA AUC to send the parameter AD.

296 155 10-CSH 150 82 Uen C 2007-01-24


16 Appendix B (Typical X.25 Configuration)

CAI uses the SUN X.25 package and taking a peek at SUN’simplementation of X.25, the configuration parameters can be found in the file(/etc/SUNWconn/x25/x25params.0). SUN has built a graphical user interfacewith which it is possible to configure this file (and other necessary system files).

Figure 228 X.25 Interface Configuration

The file itself has three parts: an interface section, a link section, and an x25(packet level) section. The order of parameters within a section can vary andthe contents are listed in the following sections.

297155 10-CSH 150 82 Uen C 2007-01-24


16.1 The Interface Section:

Interface l’d is the minor device number

interface 1 associated with the xpkt device used for this interface.

16.2 The Link Section:

link <linktype><control>

mandatory; indicates start of the link

link llc section describing the data link characteristics, and alsospecifies some of the link‘s properties. These propertiescan be in any order.

• The link type can be ‘‘llc’’ or ‘‘hdlc’’ and is mandatory.

• The control can be either ‘‘normal’’ or ‘‘extended’’. It is optional for hdlc,and not required for llc.

• The default for hdlc is normal; It is always extended for llc

lsap <number> optional for llc, not required for hdlc. default for llc is0x7e

speed <number> optional for hdlc, not required for llc; link speed inbits/sec, default 9600

tick <number> optional; timer resolution in ms; default for hdlc 500,llc 500

poll_timeout<number>

optional; poll timeout in ms; default for hdlc 4500, llc2000

idle_timeout<number>

optional; idle timeout in ms; default for hdlc 18000, forllc 10000

busy_timeout<number>

optional; busy timeout in ms; default for hdlc 6000, llc6000

rej_timeout<number>

optional; reject timeout in ms; default for hdlc 6000, llc6000

ack_timeout<number>

optional; ack timeout in ms; default for hdlc 6000, llc6000

ack_delay<number>

optional; ack delay in ms; default for hdlc 2000, for llc500

max_frame_size<number>

optional; maximum link frame size in bytes; default forhdlc 133, llc 1031

298 155 10-CSH 150 82 Uen C 2007-01-24


max_retries<number>

optional; number of times poll will be retried; default forhdlc 10, llc 10

window_size<number>

optional; default for hdlc 7, llc 127

16.3 The X.25 (packet level) Section:

x25 <version><format> <mode>

signifies start of section describing

x25 1984 packet level, and also some properties; properties canbe in any order

• The version can be ‘‘1984’’ or ‘‘1988’’. It is optional; the default is 1984

• The format can be ‘‘normal’’or ‘‘extended’’ . It is optional; the default isnormal;

• It determines whether modulo 8 or modulo 128 sequence numbers willbe used.

• The mode can be ‘‘dte’’or ‘‘dce’’ . It is optional; the default is dte. This alsodetermines the link address for hdlc.

address <address> mandatory; the X.121 address for this node

address 21-1-0 in DNIC-NTN-SUBADDRESS format, or ‘‘NULL’’. ForLLC interfaces, it is necessary to specify NULL in orderto inhibit sending the calling address field.

def_window_size<number>

optional; default for hdlc is 2, llc 7

def_throughput9600

optional; default is speed parameter, for hdlc links, and9600 for llc links; should not exceed speed parameterfor hdlc.

def_packet_size<number>

optional; default for hdlc is 128, llc 1024

flow_control_negotiation

{yes | no} optional; default is yes; if no, will not negotiatepacket and window sizes, will just indicate default toinitiator

throughput_negotiation

{yes | no} optional; default is yes; if no, will not negotiatethroughput, will just indicate default to initiator thefollowing lcn ranges are always written from the pointof view of a DTE; at least one range must be specified;absence of a range will mean that range is null. Also‘‘empty’’ for null ranges

299155 10-CSH 150 82 Uen C 2007-01-24


lcn_incoming<number>

<number>

lcn_two_way<number>

<number>

lcn_outgoing<number>

<number>

lcn_incoming empty

lcn_two_way 1-15

lcn_outgoing empty

window rotationtimer

0; default is 150 sec.

restart_timeout<number>

optional; default is 180 sec

call_timeout<number>


reset_timeout<number>


clear_timeout<number>


restart_retries<number>

optional; default is 3

call_retries<number>


reset_retries<number>


clear_retries<number>


send_buffer_size<number>


recv_buffer_size<number>


D_bit {yes|no} optional; default is no

300 155 10-CSH 150 82 Uen C 2007-01-24


called_address_opt

{full | no_dnic} optional; default is full; if set to no_dnic,DNIC will not be sent on local calls (calls where thecalled address has the same DNIC as the DNIC forthis link.)

calling_address_opt

{full | no_dnic | subaddress_only} optional; default isfull Applies to all calls.

address_prefix<digit>

optional; default is no prefix; if present, specified prefixdigit will be used to indicate presence of DNIC for calledand calling address.

301155 10-CSH 150 82 Uen C 2007-01-24


302 155 10-CSH 150 82 Uen C 2007-01-24


17 Appendix C (Error Recovery)

The CAI message responses are closely corresponding with each specificnetwork element type (compare HLRSUB’s message responses with thosefound in HLR).

The CAI message responses have been categorized into different types oferrors and each type has there own preferred action or error managementprocedure. Note that a specific error may be caused by several reasons andtherefore belong to several categories.

Table 57 Error categories and preferred actions

Type of error Preferred action / Description

Syntax error Occurs due to inconsistent use of CAI. Caused by syntaxerror or semantic error in CAS. Write fault report on CAS.

Temporary error Caused by simultaneous actions (from the network or fromCAS) performed on the subscribers data or temporary faultsin the network. Repeat the provisioning operation, eitherimmediately or after some time.

Data fault Faulty data has been submitted from CAS. Change theparticular data and try again.

Fatal error Manual intervention needed. Use the error log to find thecause of the problem.

To create suitable error management routines the table above can be used asa guideline. More information can be obtained from the documents referencedbelow.

For HLR recovery procedures, see HLR Operational Instructions (OPT)referenced in User Guide For Subsystem: HRS.

For AUC-10 recovery procedures, see AUC-10 Operational Instructions (OPT)referenced in the following documents:

• Authentication Centre, Key Data, Define.

• Authentication Centre, Key Data, Delete.

• Authentication Centre, Mobile Subscriber.

• Authentication Centre, Mobile Subscriber.

For Sema EIR/AUC recovery procedures, see System Operations Manual andSystem Maintenance Manual.

For MC recovery procedures, see each vendors documentation.

303155 10-CSH 150 82 Uen C 2007-01-24


Also remember that the processing log provides valuable information whenseeking the root of a problem.

In the processing log the complete provisioning operation will be logged. Eachprovisioning operation entry contains an incoming CSO from CAS, all NSOssent to the NE plus each NSO’s response. With the help of the responses itis possible to find suitable procedures via the help of the network elementspecific user documentation.

For instance, consider the following print-out from the processing log:

Figure 229 Print-out from Processing Log

This scenario happens if the subscriber for instance has the CFU alreadyactivated. According to the log, after this provisioning operation the CAT willhave the new value of 11, but OBI has not been changed.

Preferred action here would be (according to the table in Section 6.5 on page106) to write a fault report on CAS since CAS allows the user to use the CFNRYwithout turning off the CFU. It can also be corrected by first removing the CFUbefore setting the CFNRY.

To ensure data consistency, remove the CFNRY from the SET operation andissue it again or issue a GET requesting the status of OBI and CAT to retrievecorrect status.

304 155 10-CSH 150 82 Uen C 2007-01-24


18 Appendix D (New or Changed NEs andMOs in Ericsson Multi Activation 4.0)

Table 58 New or Changed NEs and MOs in Ericsson Multi Activation 4.0

NE Composite Parameters Parameters

305155 10-CSH 150 82 Uen C 2007-01-24


306 155 10-CSH 150 82 Uen C 2007-01-24

Glossary

Glossary

AAAAuthentication, Authorization and Accounting

ACAuthentication Center

Activation status of SupplementaryServices0 - not active

1 - active operational

2 - active quiescent

Active Operational implies that invocation ofthe service is allowed.

Active QuiescentImplies that a service is active but invocationof the service is temporarily inhibited.

Additional MSISDN’sThe HLR will make use of several (installationdependent up to 16) MSISDN‘s calledadditional MSISDN‘s so that each of them willbe uniquely associated with a specific BearerCapability.

AKAAuthentication and Key Agreement

A-KeyAuthentication Key

AMSISDNAdditional MSISDN

ANSIAmerican National Standards Institute

ASApplication Server

AUCAuthentication Centre

AUC-10Authentication Centre built on AXE-10

Basic ServiceSome telecommunication services areconsidered as basic. Basic Services aredivided into two main categories: BearerServices (BSxx) and Teleservices (TSxx).

Basic Service GroupBasic Services are organized into groups ofservices (BSGs). When the first Basic Serviceis subscribed, this BSG is understood as beingsubscribed, which implies that SupplementaryServices can be activated for this BSG.

BCBearer Capability

Bearer CapabilityThe Bearer Capability (BC) defines thetechnical features (e.g. baud rate) of a BearerService by low OSI-layer attributes.

Bearer ServiceBearer Services provide the capability ofdata transmission between access points ofuser-network interfaces.

BSBasic Service

BSGBasic Service Group

CACCustomer Access Control

CAICustomer Administration Interface

307155 10-CSH 150 82 Uen C 2007-01-24

Glossary

CAMELThe CAMEL feature can be used to provideoperator specific services not providedby competing operators, this providing anexcellent service differentiation capability.This will allow operators to target certainmarket segments with tailored services. TheHLR stores the Originating and TerminatingCamel Subscription Information (O-CSI andT-CSI) for subscribers requiring CAMELsupport.

CASCustomer Administration System

Ciphering key (Kc)This is an 64-bit ciphering key, generatedusing subscriber‘s authentication key (Ki) andciphering key generating algorithm A38. It isalso generated by the mobile using Ki andalgorithm A38 stored on the SIM (SubscriberIdentity Module) Where required, Kc is used toencrypt traffic on the radio path, thus providingsecure communications to/from the mobile.

Closed User GroupThe purpose of this function is to enablesubscribers to form closed user groups(CUGs) to and from which access is restricted.A subscriber may be a member of up to 10CUGs. Each CUG membership applies to aspecified set of BSGs.

CSOCustomer Service Order

CUSACCUStomer Access Control

DCDistributed Configuration

DNFDistinguished Name Function

E-AAAEricsson AAA

EIREquipment Identity Register

End Serial NumberThe last serial number in an IMEI range. Theserial number is a part of an IMEI number:IMEI = TAC + FAC + serial number + spare.

EMAEricsson Multi Activation

EQOSIDExtended Quality Of Service Identifier

EREEricsson Rating Engine

ESNEnd Serial Number

FACFinal Approval Code, part of the IMEI number

FAFFamily And Friends

FBCFlexible Bearer Charging

Flexible NumberingThis functions purpose is to make it possibleto freely choose MSISDN to IMSI connectionwithout any constrains set by the HLR.

FNFlexible Numbering

FNRFlexible Numbering Register

Forwarded-to numberA number to which a mobile subscriberconditionally or unconditionally forwardsincoming calls.

GGSNGateway GPRS Supporting Node

GMLCGateway Mobile Location Centre

GMRMGemMobile Remote Manager

308 155 10-CSH 150 82 Uen C 2007-01-24

Glossary

GPRSGeneralized Packet Radio System

GSMGlobal System for Mobile Communication

GSM networksGSM 900, GSM 1800 and GSM 1900. Thesethree networks together are called GSM inthis document.

HLRHome Location Register

HLR ProfileA set of permanent Subscriber Data(i.e. provided services), used to facilitatesubscription administration.

HMSIInternational Mobile Subscriber Identity

ICCIDIntegrated Circuit Card Identity

IMEIInternational Mobile Station EquipmentIdentity

IMSIInternational Mobile Subscriber Identity,(E214)

IMSISInternational Mobile Subscriber Series

IMSI Change-overAn IMSI Change-over procedure is used toreplace the subscriber‘s SIM-card which hasthe IMSI burned in. The Change-over can onlybe performed within one HLR. A Change-overprocedure has different states before beingtotally executed: Pending, Forced, Executed.

INSIntelligent Network Server

IPInternet Protocol

IPMMIP MultiMedia

IVRInteractive Voice Response

JASJambala Application Server

KiSubscriber Authentication Key

LEXLocal EXchange

LDAPLightweight Directory Access Protocol

List typeAn IMEI range is always connected to a listtype: Values 0-9 are valid. The definition ofthe lists is site specific and mapped againstthe status of the lists internally in the EIR.

LOCSERVICESLocation services

MCMessage Centre

MMCMultimedia Messaging Center

MMLMultimedia Messaging Library

MMSMultimedia Messaging Service

MOManage Object

MOIPMessage over IP

MO/PPMobile Originated Point to Point

MPCMobile Positioning Center

MSMobile Station

309155 10-CSH 150 82 Uen C 2007-01-24

Glossary

MSIMMultiple SIM

MSISDNMobile Subscriber ISDN Number, (E164)

MT/ PPMobile Terminated Point to Point

NENetwork Element

No-reply-timeDefines the time interval from the point whenthe subscriber is first alerted until the call isredirected. The value must be in the range 5sec - 30 sec in steps of 5 sec.

NPNumber Portability

NPREFIXNetwork Prefix (also abbreviated as NP)

NSONetwork Service Order

OTASPOver-the-Air User and SubscriptionManagement

PLMNPublic Land Mobile Network

PDCPacific Digital Cellular

PDPADDPacket Data Protocol ADDress

PDPCONTEXTPacket Data Protocol CONTEXT

PPSPrepaid System

Primary Inter-exchange CarrierThe operator can assign and removea Primary Inter-exchange Carrier for asubscriber. It is generally used for allinter-LATA (Local Access and TransportArea) call segments for which the involvedsubscriber is the charged party. This carrierwill apply generally for inter-LATA calls unlessthe involved subscriber selects anotherInter-exchange Carrier when dialling theB-number. The Primary Inter-exchangeCarrier is assigned to the mobile subscriberusing a PICI.

QOSQuality Of Service.

RedundancyA failure in an HLR makes the subscriberunable to make or receive calls. To avoid thisthe redundancy concept has been introduced.Two network elements, a primary and aredundant cooperates. All data stored inthe primary is duplicated to the redundant.If the primary goes down, the redundantnetwork element will take over. EricssonMulti Activation handles this concept by firstsending commands to the primary NE andcopying the same to the redundant NE. TheEricsson Multi Activation concept is availablefor HLR, FNR and AUC.

Regional ServicesAllows the operator to emulate a PSTNconcerning charging. The service givesthe opportunity to offer mobile subscribersa subscription without constraints inside adefined area. Outside this area the service isnot granted or the tariff may be different.

SOSSubscriber and Operator Services

SSDShared Secret Data

SUDSubscriber Data

SURFSubscriber Update Request Protocol

310 155 10-CSH 150 82 Uen C 2007-01-24

Glossary

Service ActivationThe action taken by the mobile subscriber orthe service provider to take a certain serviceinto operation.

Service ProvisionThe action to make a certain service availableto a mobile subscriber.

Service RegistrationThe action taken by the mobile subscriberor the service provider to insert informationwhich enables the utilization of a service(Forwarded-to number, No-reply-time).Registration of a Supplementary Serviceimplies its activation.

Signed Response (SRES)This is a 32-bit number generated by boththe AUC and the mobile using Ki, and theauthentication algorithm A38. It is sent by boththe AUC ad the mobile to the VLR (VisitingLocation Register). Here the two generatedSRESs are compared. Providing they match,the subscriber will be authenticated and callset-up will proceed.

SMSCIDShort Message Service Center Identity

StatusAn IMEI range can be connected to a liststatus: white list = valid mobile equipmentgrey list = faulty/non-approved equipmentblack list = barred mobile equipment

SubaddressA subaddress can be added to theForwarded-to number. This Forwarded-tosubaddress is transported transparentlythrough the network and can be used foraddressing within an application locatedbeyond the end-point.

Subscriber DataThe term Subscriber Data is used to designateinformation associated with a subscriberstored in the HLR:

Supplementary ServiceBasic Services can be enhanced or modifiedby Supplementary Services. Supplementaryservices are provided for a subscription by theoperator but can be activated/deactivated bythe subscriber himself.

TACType Approval Code, part of the IMEI number

TCPTransmission Control Protocol

TIFTranslation Information Flag

TeleserviceTeleservices provide a complete capabilityincluding terminal equipment functions forcommunication between users (seeSection6.4.2 on page 99).

TSMOTransfer of Short Message Option

UMUnified Messaging

VIGVideo Gateway

VLRVisitor Location Register

VMVoice Mail

VMSIVisitor Mobile Subscriber Identity

VPAAVisited Public land mobile network AddressAllowed

WCDMAWideband Code Division Multipal Access

311155 10-CSH 150 82 Uen C 2007-01-24

Glossary

312 155 10-CSH 150 82 Uen C 2007-01-24

Reference List

Reference List

[1] Function Specification Ericsson Multi Activation 5.0, 155 17-CSH 15082 Uen

[2] Supplementary Service and Operator Determined Barring Interactions inHLR, 59/ 155 17-ANT 238 01 Uen

[3] Home Translation Functions Changeable Exchange Adaption (HTRAN),2/155 18-CNT 238 0047 Uen

[4] User Guide For Subsystem: HRS, 1553-ANT 238 01

[5] TELNET Protocol Specification, RFC 854 ISI May 1983 J.Postel and J.Reynolds

[6] System Operations Manual, INS/UG/2 Sema AUC/EIR Database Systems

[7] System Maintenance Manual, INS/UG/3 Sema AUC/EIR DatabaseSystems

[8] System Administrators Guide Ericsson Multi Activation 5.0 DatabaseBased, 1/1543-CSH 150 82 Uen

[9] SOG-MC Generic Interface Specification, 155 10-FAB 760 014

[10] Interworking Subscriber Data Translation Changeable ExchangeAdaptation (ISDTRAN), 2/155 18-CNT 296 0002 Uen

[11] Application Information block ASD, 2/155 18 - CNT 304 0003 Uen

[12] Application Information block AMAPTC, 2/155 18 - CNT 304 0004 Uen

[13] Application Information block AGEN, 2/155 18 - CNT 304 0001 Uen

[14] Authentication Centre, Key Data, Define, 1/154 31-CNT 304 0002

[15] Authentication Centre, Key Data, Delete, 2/154 31-CNT 304 0002

[16] Authentication Centre, Mobile Subscriber, 3/154 31-CNT 304 0002

[17] Authentication Centre, Mobile Subscriber, 4/154 31-CNT 304 0002

[18] System Administration Graphical User Interface Ericsson Multi Activation5.0, 1553-CSH 150 82 Uen

[19] Home Translation Functions Changeable Exchange Adaption (HTRAN),2/155 18-CNT 238 0047 Uen

313155 10-CSH 150 82 Uen C 2007-01-24

Reference List

[20] System Operations Manual, INS/UG/2 Sema AUC/EIR DatabaseSystems

[21] SOG-MC Generic Interface Specification, 155 10-FAB 760 014

[22] Interworking Subscriber Data Translation Changeable ExchangeAdaptation (ISDTRAN), 2/155 18-CNT 296 0002 Uen

[23] Application Information block ASD, 2/155 18 - CNT 304 0003 Uen

[24] Application Information block AMAPTC, 2/155 18 - CNT 304 0004 Uen

[25] Application Information block AGEN, 2/155 18 - CNT 304 0001 Uen

[26] Authentication Centre, Key Data, Define, 1/154 31-CNT 304 0002

314 155 10-CSH 150 82 Uen C 2007-01-24

ema _wireless_commands

Documents

response parameters

cms11hlr message response

message response format

cms11ac message response

hlrsub message response

fnrsub message response

imsich message response

mpcsub message response