ZXIN10 SACP IMP Interface Integration Guide

Internal Use Only ▲

ZXIN10 SACP IMP (V2.1) Interface Integration Guide

ZTE CORPORATION

All Rights reserved, No Spreading abroad without Permission of ZTE

Page 1 of 22

Internal Use Only ▲

Revision History

Document

Version

Drafted

No.

No.

by/Modified by

R1.0

Qian Jun

Examined by

Wu Yanhua

Drafted/Modi fied on 2010-02-20

All Rights reserved, No Spreading abroad without Permission of ZTE

Reason for Revision SOP documentation, 2010

Page 2 of 22

Major  Revisions The first draft

Internal Use Only▲

Table of Contents Chapter 1 Overview ........................................................................................................................ 4 1.1 Abstract ....................................................................................................................................... 4 1.2 IMP Introduction ......................................................................................................................... 4 1.3 Installation Procedure................................................................................................................. 5 1.3.1 Flow Chart ............................................................................................................................... 5 1.3.2 Procedure Description............................................................................................................. 5 Chapter 2 Debugging MML Interface............................................................................................ 7 2.1 Overview ..................................................................................................................................... 7 2.2 Installation Procedure................................................................................................................. 7 2.2.1 Flow Chart ............................................................................................................................... 7 2.2.2 Procedure Description............................................................................................................. 7 2.3 Uploading MML Version ............................................................................................................. 8 2.4 Deploying MML Version ............................................................................................................. 9 2.5 Test Verification ........................................................................................................................ 12 Chapter 3 Debugging Diameter Interface .................................................................................. 14 3.1 Overview ................................................................................................................................... 14 3.2 Installation Procedure............................................................................................................... 14 3.2.1 Flow Chart ............................................................................................................................. 14 3.2.2 Procedure Description........................................................................................................... 14 3.3 Uploading Diameter Version .................................................................................................... 15 3.4 Deploying Diameter Version..................................................................................................... 16 3.5 Test Verification ........................................................................................................................ 21

All Rights reserved, No Spreading abroad without Permission of ZTE

Page 3 of 22

ZXIN10 SACP IMP Interface Integration Guide

Internal Use Only▲

Chapter 1 Overview 1.1

Abstract This document presents detailed step and method of interface integration of  SACP service IMP. Section 1.2 presents the concept and function of IMP. Section 1.3 describes the procedure of integration. Chapter 2 presents the integration step and method of MML interface for SACP account opening and closing. Chapter 3 presents the integration step and method of Diameter interface.

1.2

IMP Introduction IMP is mainly used to enable the interaction among different systems. Due to the variations of external systems, the demand of interface is different. In order  to solve the reuse of IMP code and low maintainability, the general functions are separated to form the interface platform, which is called IMP platform, to provide fundamental support for the running of various interfaces. The location of IMP in the IN platform is shown in Figure 1.2-1.

SCP

SMP

WEB Server  IMP Server 

CDR

SMAP

Server 

Fiber Switch

EMC Disk Array

Figure 1.2-1 Location of IMP in Intelligent Network

All Rights reserved, No Spreading abroad without Permission of ZTE

Page 4 of 22

ZXIN10 SACP IMP Interface Integration Guide

1.3

Installation Procedure

1.3.1

Flow Chart

Internal Use Only▲

Because interfaces are interdependent of each other, interface integration should be performed in certain order. Figure 1.3-1 describes the main steps and order of interface integration. The general order is first to debug MML interface for SACP account opening and closing, and later to debug Diameter interface connected with OCS. Start

Debug MML Interface

Debug Diameter  Interface

End

Figure 1.3-1 Flow Chart of Integration

1.3.2

Procedure Description Purpose To complete the installation and debugging of IMP to enable the functions of  various interfaces Personnel SACP IMP interface integration engineers Prerequisites IP address of peer end OCS and port information provided by the customer and MML specification manual should also be provided. Procedure Description 1.

MML interface integration.

All Rights reserved, No Spreading abroad without Permission of ZTE

Page 5 of 22

ZXIN10 SACP IMP Interface Integration Guide

Internal Use Only▲

Complete the debugging of MML interface to enable the function of  account opening and closing of BOSS-side on SACP. 2.

Diameter interface integration. Complete the debugging of Diameter and the link with OCS to enable diameter message interaction.

Note: Both IMP and external network element interface are fundamentally based on pure IP protocol. Therefore, the two main parts of IMP interface integration are: debugging of network layer and debugging of protocol layer.

IP network between IMP and external network element must be connected. This can be related to the configuration of router, firewall and switch. This part, however, is not illustrated in this document. For detailed information, please refer to relevant materials.

All Rights reserved, No Spreading abroad without Permission of ZTE

Page 6 of 22

ZXIN10 SACP IMP Interface Integration Guide

Chapter 2 2.1

Internal Use Only▲

Debugging MML Interface

Overview This chapter presents the integration step and method of SACP service interface. Section 2.2 introduces the procedure of integration. Section 2.3 presents uploading MML version files. Section 2.4 introduces the installation of MML version and the modification of  files configured. Section 2.5 presents the verification of MML interface.

2.2

Installation Procedure

2.2.1

Flow Chart The integration procedure between IMP and SCP of SACP is shown in Figure 2.2-1.

Start

Upload MML Version

Deploy MML Version

End

Figure 2.2-1 Integration Flow Chart b etween IMP and SCP of SACP

2.2.2

Procedure Description Purpose To complete the debugging between IMP and SMP, as well as IMP and BOSS

All Rights reserved, No Spreading abroad without Permission of ZTE

Page 7 of 22

ZXIN10 SACP IMP Interface Integration Guide

Internal Use Only▲

To complete the debugging of SACP basic internal interface Personnel SACP IMP interface integration engineers Prerequisites Such data as SCP and BOSS-side have been prepared. Procedure Description 1.

Upload MML interface version. Upload the version needed by MML to IMP server.

2.

Configure relevant data of SMP on IMP. Configure such relevant data as SMP of SACP service on IMP.

3.

Perform SACP service test. Perform basic test of SACP service to ensure there is no problem with the interface.

2.3

Uploading MML Version Purpose To upload MML version to IMP server and install it Personnel SACP IMP interface integration engineers Procedure Description 1. As user  zxin10, decompress MML platform version packet, and upload service300.dll and service302.dll via FTP in BIN mode to the directory /home/zxin10/lib of IMP server and upload mmlapcfg.ini via FTP in ASCII mode to the directory /home/zxin10/etc. The way to get the version file is shown in Figure 2.3-1.

All Rights reserved, No Spreading abroad without Permission of ZTE

Page 8 of 22

ZXIN10 SACP IMP Interface Integration Guide

Internal Use Only▲

Figure 2.3-1 MML Platform Version File

2. Upload service357.dll of MML interface version packet via FTP in BIN mode to the directory /home/zxin10/lib of IMP server as user . The way to get the version file is shown in Figure 2.3-2.

Figure 2.3-2 MML Interface Version

2.4

Deploying MML Version Purpose To load SACP service interface and configure service data to enable it with the integration function Personnel SACP IMP interface integration engineers

All Rights reserved, No Spreading abroad without Permission of ZTE

Page 9 of 22

ZXIN10 SACP IMP Interface Integration Guide

Internal Use Only▲

Procedure Description The specific method of deploying service interface on IMP is as follows. 1. Configure in imp.ini. [general] alarm

; alarm module enabling flag: 1 – enable, 2 – enable the

=2

virtual node alarm at the same time, others – not enable comm

; communication module enabling flag: 1  – enable,

= 0

others – not enable ; new communication module enabling flag: 1 – enable,

activeNewComm = 1

others – not enable, the default is 1 dbconn

=0

; number of database connections: idf1, idf2 ...

logfilenum = 30

; number of IMP log files, 500 at most ; number of IMP: interface1, interface2…

interfacecount = N+2

ftpcnt

; number of FTP thread: ftpap1, ftpap2…

=0

cdrconvertcnt = 0

; number of cdrconvert dll: cdrconvert1, cdrconvert2...,

the largest is 10 monitor

= 0

; Monitor auto switchover enabling flag (only valid on

Windows): 1 – enable, others – not enable ;log storage position, default is c: \zxin10\log logfilepath = c:\zxin10\log ; add thread 357 configuration in imp.ini: [interfaceN+1]

; add IMP configuration

= 1; integrate several threads in a DLL, 1 – each thread (i. e., a pno)

dllflag

uses one DLL, 0 – each thread corresponds to several I MPs mainpno

= 357 ;

core thread No., all the external messages are sent to this

thread. slavepno

= stacksize

= 256

; the stack size of thread, unit: k

; add the configuration of thread 300 and thread 301 in imp.ini: [interfaceN+2] dllflag

=1

mainpno

= 300

slavepno stacksize

= 301 = 256

2. Add server terminal to the client of SMP in itcom.ini. [general] module

= 186

postoffice = 16 areacode

= 21

; node No. ; office ID ; area code

myipaddress = 10.40.56.24

alarmmodule = 133

; the IP address of the host

; alarm node No.

All Rights reserved, No Spreading abroad without Permission of ZTE

Page 10 of 22

ZXIN10 SACP IMP Interface Integration Guide

servercnt

; number of server terminal configured

=

clientcnt

Internal Use Only▲

; number of client configured

= N+1

Support WINNTTCP connection to use non-5000 port (5000 port connection is always WINNTTCP connection) 1 – support (peermodule configured of the client is valid all the time. To make it ordinary connection, peermodule must be 0). It is defaulted as 0 (to make it internal connection, the port No. should be 5000). noLimitPort = 0 ; configuration of server terminal: [serverN+1]; configure server terminal of the interface mainpno

= 300

; the binding thread No.

myipaddress = 10.40.56.24 port

= 6000

socketnum

= 10

; the IP address of the host

; port No. ; the maximum connection number allowed

; configuration of the client: [client1] mainpno

; the binding thread No. (invalid for internal

= 357

connection) myipaddress = 10.40.56.24

; the IP address of the host ; the module No. or node No., and can only be

peermodule = 133

valid when peer end is IN system. peeripaddress = 10.40.155.139 port

= 5000

; IP address of peer end SMP ; port No. of peer end

socketnum

=1

; connection number 

longconn

=1

; whether it is long connection; 1 -1 long

connection commpno

= 100

; the assigned communication thread

3. Add MMLRegInf configuration in mmlapcfg.ini. [MMLRegInf?]

; MMl registration information, 5 items can be configured at most

; service name ServiceName

=PPS

; node No. of MLP ServiceModule = 144 ; process No. or thread No. of MLP ServicePno

= 310

; Whether to forward login and logout messages: 1 – forward, others – not forward, and the default value is 0. LogTrsmt

=0

; Whether it is sensitive to long segment of messages: 1  – sensitive, others  – not sensitive and the default value is 1. LengthSensitive = 1

All Rights reserved, No Spreading abroad without Permission of ZTE

Page 11 of 22

ZXIN10 SACP IMP Interface Integration Guide

Internal Use Only▲

4. Configuration description of service357.ini. Note: After the configuration items are changed, use imptrace.exe to send 1023 message to this interface thread to let it read out automatically once. [general] ; limitation of request number per second msgLimit

= 100

; DB type: 0 - MS SQL, 1 – Sybase, 2 – oracle, the default value is 2. DBType = 1 ; service key adds 65536 ServiceKey = 65637 ; DB name DBName = zxdbg_101

; Platform version flag. 0-3.60 before,1-3.60 PlatformFlag=1 ; Whether it is necessary to register to MMLAP: 1 - register, others – not register, the default value is 0. RegToMMLAP

=0

; card prefix length, the default value is 9. CardPreLen

=9

; adjusting flag of byte order: 0 - not adj ust, 1 – adjust, the default value is 1. ByteAdjust

=1

; SCP node No. Separate with “,” if there re several SCPs. SCPModule

IsPrint

= 134,135

=1

CountryPre = 86 ; The number returned to BOSS of each package and it ranges [1-20], the default value is 10. PackageNum = 10 ; The maximum number allowed once when opening or closing accounts in batches, the default value is 100. MaxNum = 100 ; Which response is adopted when responding to package balance query (LIST PPS SCHEMEBAL): 0 – mode of regulative definition (GPRS=, SCHEMETYPE= ...), 1  ATTR/RESULT mode, and the default value is 0. ListPpsSchemeBalFlag = 0

2.5

Test Verification Purpose

All Rights reserved, No Spreading abroad without Permission of ZTE

Page 12 of 22

ZXIN10 SACP IMP Interface Integration Guide

Internal Use Only▲

To use the command to verify whether the connection between IPM and the network elements to be interconnected is established successfully Personnel SACP IMP interface integration engineers Prerequisites IPM and the network elements to be interconnected have already configured the data for each other. Procedure Description  According to Figure 2.5-1, test the connectivity between IMP and the network elements to be interconnected. Log on to the machine where IMP is installed as user zxin10 and execute the command zxtool2  –c. Ensure there are message interaction of  sendc and recec between each network element and IMP.

Figure 2.5-1 Verification of the Connection between IMP and SMP

All Rights reserved, No Spreading abroad without Permission of ZTE

Page 13 of 22

ZXIN10 SACP IMP Interface Integration Guide

Chapter 3 3.1

Internal Use Only▲

Debugging Diameter Interface

Overview This chapter presents the integration step and method of Diameter interface. Section 3.2 introduces the procedure of integration. Section 3.3 presents the configuration of service data. Section 3.4 introduces test verification.

3.2

Installation Procedure

3.2.1

Flow Chart The integration procedure between IMP and SCP of SACP is shown in Figure 3.2-1.

Start

Upload Diameter  Version

Deploy Diameter  Version

End

Figure 3.2-1 Integration Flow Chart b etween IMP and SCP of SACP

3.2.2

Procedure Description Purpose To complete the debugging between IMP and SMP, as well as IMP and BOSS To complete the debugging of SACP basic internal interface Personnel SACP IMP interface integration engineers

All Rights reserved, No Spreading abroad without Permission of ZTE

Page 14 of 22

ZXIN10 SACP IMP Interface Integration Guide

Internal Use Only▲

Prerequisites Such relevant data as SCP and OCS have been prepared. Procedure Description 1.

Configure relevant data of SMP on IMP. Configure such relevant data as SMP of SACP service on IMP.

2.

Confirm SMP is configured with IMP data. Configure relevant IMP data in SMP to ensure the triggering procedure of  basic service is normal.

3.

Confirm BOSS is configured with IMP data. Configure IP address and port of IMP in BOSS to ensure the normal visit.

4.

Perform SACP service test. Perform basic test of SACP service to ensure there is no problem with the interface.

3.3

Uploading Diameter Version Purpose To load Diameter Service interface and configure data to enable the message interaction of OCS Personnel SACP IMP interface integration engineers Procedure Description Upload service357.dll as user  zxin10 via FTP in bin mode to the directory /home/zxin10/lib of IMP server and upload service357.ini via FTP in ASCII mode to the directory /home/zxin10/etc. The way to get the version file is shown in Figure 3.3-1.

All Rights reserved, No Spreading abroad without Permission of ZTE

Page 15 of 22

ZXIN10 SACP IMP Interface Integration Guide

Internal Use Only▲

Figure 3.3-1 Diameter Version File

3.4

Deploying Diameter Version Purpose To load Diameter Service interface and configure data to enable the message interaction of OCS Personnel SACP IMP interface integration engineers Procedure Description 1. Modify the configuration in imp.ini. [general] alarm

; alarm module enabling flag: 1 – enable, 2 – enable the

=2

virtual node alarm at the same time, others – not enable comm

; communication module enabling flag: 1  – enable,

= 0

others – not enable ; new communication module enabling flag: 1 – enable,

activeNewComm = 1

others – not enable, the default is 1 dbconn

=0

logfilenum = 30

; number of database connections: idf1, idf2 ... ; number of IMP log files, 500 at most

interfacecount = N+1

ftpcnt

=1

cdrconvertcnt = 0

number of IMP: interface1, interface2…

; number of FTP thread: ftpap1, ftpap2… ; number of cdrconvert dll, cdrconvert1, cdrconvert2...,

the largest is 10 monitor

= 0

; Monitor auto switchover enabling flag (only valid on

Windows): 1 – enable, others – not enable ;log storage position, default is c:\zxin10\log logfilepath = c:\zxin10\log All Rights reserved, No Spreading abroad without Permission of ZTE

Page 16 of 22

ZXIN10 SACP IMP Interface Integration Guide

Internal Use Only▲

; add 378 thread configuration in imp.ini: [interfaceN+1] dllflag

=1

mainpno

= 378

slavepno stacksize

= = 256

2. Add server terminal to the client of SMP in itcom.ini. [general] module

; node No.

= 186

postoffice = 16 areacode

; office ID

= 21

; area code ; the IP address of the host

myipaddress = 10.40.56.24

alarmmodule = 133 servercnt clientcnt

= N+1 = N+1

; alarm node No. ; number of server terminal configured ; number of client configured

Support WINNTTCP connection to use non-5000 port (5000 port connection is always WINNTTCP connection) 1 – support (peermodule configured of the client is valid al l the time. To make it ordinary connection, peermodule must be 0). It is defaulted as 0 (to make it internal connection, the port No. should be 5000). noLimitPort = 0

; configuration of the client: [client1] mainpno

; the binding thread No. (invalid for internal

= 378

connection) myipaddress = 10.40.56.24

; the IP address of the host

peermodule = 133

; the module No. or node No., and can be valid

when peer end is IN system. peeripaddress = 10.40.155.139 port

= 5000

; IP address of peer end SMP ; port No. of peer end

socketnum

=1

; connection number 

longconn

=1

; whether it is long connection; 1 - long

connection commpno

= 100

; the assigned communication thread

3. Configuration in dmtcfg.ini. [general] ; time of time-out response, unit: second. This configuration must be > 0. RspTimeOut=10 All Rights reserved, No Spreading abroad without Permission of ZTE

Page 17 of 22

ZXIN10 SACP IMP Interface Integration Guide

Internal Use Only▲

; check hash table node number when ti ming out. CheckHashNodeNum=1000 ; link check time, used for DWR and DWA messages. LinkCheckTime=30 ; host flag OriginHost= imp001.chinatelecom.com ; host realm OriginRealm= chinatelecom.com ; SCP service number, 10×5 at most, corresponding to SCPSrv1, SCPSrv2... SCPSrvNum

=1

; OCS number, 10 at most, corresponding to SOCS1, OCS2... OCSNum

=1

; Application-ID of message produced by IMP and message sent from SLP to IMP should take this configuration.  ApplicationID = 0 ; version No. DmtVersion = 1 ; print statistic interval, maximum value: 255. 0: not print statistic message; print statistic time==RspTimeOut*PrnStatInterval PrnStatInterval = 3 ;CER Auth-Application-Id AVP Value ; If Auth-Application-Id taken with CER message is set to be 65536, then it will not take this AVP.  Auth-Application-Id = 4 ; If Acct-Application-Id taken with CER message is set to be 65536, then it will not take this AVP.  Acct-Application-Id= 3 ; vendor id avp value of this node VendorId = 12 ; ; product name avp value of t his node ProductName = aaa ; the size of the hidden configuration hash table is defaulted as 32000. MaxHashNode=32000 ; hidden configuration. This configuration is added for Guangdong Branch, China Unicom and the default value is 0, which means not to send the wrong CCA to SCP when the link is disconnected or there is no response. 1 configured for Guangdong Branch, China Unicom requires sending the wrong CCA to SCP when the link is disconnected or there is no response. RetErrorCCA=0 ; the CCA time-out alarm message number sent in a period and the messages are not sent if the number is more than this value. This configuration can be hidden. TimeOutAlarmNUM=5 ; time-out alarm time interval and the unit is minute TimeOutAlarmInterval=3 All Rights reserved, No Spreading abroad without Permission of ZTE

Page 18 of 22

ZXIN10 SACP IMP Interface Integration Guide

Internal Use Only▲

; whether sessionid is generated in the way of China Mobile mode (scpno; dlgid; 0). ; 1- yes (scpno is determined by OriginHost of [SCPSrv?], and OriginHost should be configured to be scp No. xxx) ; 0 – no, and OriginHost is the host name o f scp. ; and the default value is 0 SessionidMode = 0

; This Item determines whether automatic inform to SCP that update has been finished, 1 means inform 0 means not. ;hide ;remember to delete  AutoInformSCP=1

[SCPSrv1] ; it should be noticed that the configuration should be the same with that of SCP of  Client in itcom.ini. Module peerpost

= 133 = 16

; SCP flag OriginHost= scp001.chinatelecom.com ;when SessionidMode=1, OriginHost=three intergers, e.g., 000 IPAddr

= 10.40.56.106

ServiceKey = 131123 terminal

=3

The route type of service message: 0: polli ng distribution, 1: sending by code and [SendByCode] is effective but the function of sending by code is discarded. RouteType = 0 ; polling distribution configuration OCSHost = ocs001.chinatelecom.com;ocs002.chinatelecom.com

; sending message by code. It is discarded. [SendByCode] ; defaulted ocs Default=ocs001.chinatelecom.com ; code number configured Num=3 ; map relation of code: ocs. Map1=12345678:ocs001.chinatelecom.com Map2=12345678:ocs002.chinatelecom.com Map3=12345678:ocs003.chinatelecom.com

[OCS1] IP address and port No. of charging. It should be noticed that this configuration is All Rights reserved, No Spreading abroad without Permission of ZTE

Page 19 of 22

ZXIN10 SACP IMP Interface Integration Guide

Internal Use Only▲

the same with the configuration of certain item of Client in itcom.ini. ; OCS flag OriginHost= ocs001.chinatelecom.com OriginRealm = zte.com.cn IPAddr

= 10.40.57.140

Port

= 6000

FailOverOCS=ocs002.chinatelecom.com [OCS2] IP address and port No. of charging center. It should be noticed that this configuration is the same with the configuration of certain item of Client i n itcom.ini. ; OCS flag OriginHost= ocs002.chinatelecom.com OriginRealm = chinatelecom.com IPAddr

= 10.40.57.6

Port

= 3868

FailOverOCS=ocs002.chinatelecom.com

The configuration of Supported-Vendor-Id supported in CEA. 20 can be configured at most. [SupportedVendorId] num = 1 avpvalue1 = 1234

; capability configuration of this node [Capability] ; whether to perform CER capability check, 1 – check, 0 – not check Check = 0 Inband-Security-Id = 0 capnum = 6 ; format: authid(acctid)|application-id|command-code ; separate with semicolon for command-code, each line ends with semicolon and can support 20 command codes at most ;commid:Diameter general message,

authid: authentication message,

acctid:

charging message cap1 = commid|0|257;258;274;280;282;272; cap2 = authid|1|257;258;274;280;282;272; cap3 = acctid|4|272;275; cap4 = cap5 = authid| cap6 = acctid|1|123

; the routing table can support 20 records at most. The route is not needed All Rights reserved, No Spreading abroad without Permission of ZTE

Page 20 of 22

ZXIN10 SACP IMP Interface Integration Guide

Internal Use Only▲

temporarily. [Routing Table] ; format RX = realm name;application identifier;action;server identifier  R1=chinatelecom.com;3;local;ocs001.chinatelecom.com R2=chinatelecom.com;3;local;ocs002.chinatelecom.com R3=chinatelecom.com;3;local;ocs003.chinatelecom.com

; some configuration information relating to log [Log] LogLevel = 4

[HopByHop] HopByHop = 0

3.5

Test Verification Purpose To execute the command to verify whether the connection between IPM and OCS network elements is established successfully or not Personnel SACP IMP interface integration engineers Prerequisites IPM and OCS network elements have already configured the data for each other. Procedure Description  According to Figure 3.5-1, test the connectivity between IMP and the network elements to be interconnected. Log on to the machine where IMP is installed, and run the command zxtool2 –c as user  zxin10. Ensure there are message interaction of  sendc and recec between each network element and IMP.

All Rights reserved, No Spreading abroad without Permission of ZTE

Page 21 of 22

ZXIN10 SACP IMP Interface Integration Guide

Internal Use Only▲

Figure 3.5-1 Verifying the Connection between IMP and SMP

All Rights reserved, No Spreading abroad without Permission of ZTE

Page 22 of 22