FUJ00171956
FUJ00171956
Fujitsu Services CNIM Low Level Design Ref: RS/LLD/004
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Document Title: CNIM Low Level Design
Document Type: Low Level Design
Release: S92
Abstract: CNIM is an NT service that runs on an outlet’s gateway PC. It
controls the parameters used by the Eicon card, if present, and
provides call logging and diagnostic information.
CNIM also includes an interface DLL which is used by the Counter
Call Scheduler to extract network status information.
CNIM 3 at S60 has been expanded to monitor the ADSL
connection via Connection Manager and ADSL _ Diagnostic
Monitor.
CNIM 4 at S92 for BNR will include backup connections over
ISDN and GSM.
Document Status: APPROVED
Originator & Dept: Nick Johnson, Cryptography & Networking Team, POA.
Contributors:
Internal For Originator to distribute following approval
CryPtography & Networking Development Team, BRAO1
i
Magdatory Review Authorities (see 0.2)
t
r
i
b
u
t
i
°
n
External For Document Management to distribute following approval
D
i
s
© 2006 Fujitsu Services Company in Confidence Page: 1
Fujitsu
Services
CNIM Low Level Design
COMPANY IN CONFIDENCE
FUJ00171956
FUJ00171956
Ref: RS/LLD/004
Version: 4.0
Date: 8/05/2006
Approval Authorities
“Bpottcota
Name
Position
Signature
Date
Roy
Birkinshaw
Development Manager
© 2006 Fujitsu Services
Company in Confidence
Page 2
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
0 DOCUMENT CONTROL
0.1. Document History
Version Date Reason for Issue Associated
No. CP/PinICL,
No.
0.1 2"! December 2002 For review. CP3423
0.2 14" February 2003 For review. CP3423
0.3 28" March 2003 For review. CP3423
1.0 17" April 2003 For approval - withdrawn from CP3423
approval cycle.
11 3™ July 2003 For review CP3423
2.0 30" July 2003 For approval CP3423
21 13" November 2003 For review CP3468
2.2 10" February 2004 Not Circulated for Review CP3594
23 10" June 2004 For review CP3594
3.0 9" July 2004 For approval CP3594
3.1 5" January 2005 For review PC0093488
3.2 18" April 2005 For review CP3898
3.3 25" July 2005 For review CP3898
3.4 4" August 2005 For review CP3898
3.5 4" November 2005 For review CP4097
CP4103
3.6 12" April 2006 For review PCO132421
4.0 8" May 2006 For approval CP3986
0.2 Review Details
Review Comments by :
Review Comments to : Nick Johnson, BRAOL
Mandatory Review Authority Name
Development Team Leader Peter Ambrose*
Design Authority Mark Jarosz*
SSC Mik Peach*
Optional Review / Issued for Information
Development Manager Roy Birkinshaw
CS Security Manager Brian Pinder
CS Data Centre & Ops Service Manager I Peter Thompson
© 2006 Fujitsu Services Company in Confidence Page 3
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Test Manager Peter Dreweatt
DU RV Manager Sheila Bamber
DeLT Manager Denise Morris
Software Distribution Team Manager Karen Morley
Design Authority Dave Tanner
Design Authority Colin Mills
Developer Mike Coon
Tester John Rogers
Tester Derek Elliott
Tester Michael J. Welch
(*) = Reviewers that returned comments
0.3. Associated Documents
Reference Version Date Title Source
[Ref 1] [DOC_TPL] ICL Pathway Document Template PA/TEM/001
[Ref 2] [HLD_CNIM] 0.42 Counter Network Infrastructure Manager (CNIM) I TD/SDS/002
[Ref3] [NB_SOD] 0.23 20/4/2002] Network Banking - Outlet Network Quality of I SY/SOD/007
Service Reporting.
[Ref 4] [CAS_PIS] 1 31/10/2002 I CAS Network Quality of Service Product DE/IFS/003
Interface Specification
[Ref 5] [HLD_NBA] High Level Design Specification For Network AD/DES/065
Banking Agents.
[Ref6] [CCS_NB] Counter Call Scheduler Changes for Network AD/DES/068
Banking
[Ref 7] [HLD_CAS] LI 31/10/2002 I CAS Network QOS HLD DE/HLD/001
[Ref 8] _[HLD_ACF] 03 20/04/2002 I Autoconfig HLD TD/DES/157
[Ref9] [HLD_VPN] 2.0 26/11/01 VPN High Level Design RS/DES/046
[Ref 10} [IDI] IDLISDN Driver Interface Eicon
[Ref 11] [DIAPI] Diapi ISDN interface for Windows NT Eicon
[Ref 12] [TRACE] Network Banking - Trace and Diagnostics LLD. I NB/LLD/025
[Ref 13] [UTP] 0.1 09/05/2003 I CNIM Unit Test Plan RS/UTP/OO1
[Ref 14] [SMS] Ll 20/06/2003] ADSL Service Management System Outline SY/SOD/O18
Design
[Ref 15] [CMN] 04 4/08/2003 I Connection Manager Detailed Design RS/DES/091
[Ref 16] [HLD_ADSL_1] 09 4/08/2003 I ADSL High Level Design (S52) ‘TD/SDS/004
[Ref 17] [HLD_ADSL_2] 0.2 5/09/2003 I ADSL High Level Design (S55) TD/SDS/005
[Ref 18] [ADSL_DIAG_MON] I 2.2 14/04/2004 I ADSL Diagnostic Monitor Detailed Design RS/LLD/005
[Ref 19] [DP_BNR] 02 18/03/2005 I Design Proposal for Resilient Network AS/DPR/021
© 2006 Fujitsu Services
Company in Confidence
Page 4
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
[Ref 20] [SM_BNR] 01 4/08/2005 I Branch Network Resilience Service management I SY/DES/037
Reporting Outline design
[Ref 21] [EP_BNR] om 10/08/2005 I High Level Design - Branch Network Resilience I EP/HLD/002
= Engineer’s Counter Application
Unless a specific version is referred to above, reference should be made to the current
approved versions of the documents.
0.4 Abbreviations/Definitions
Abbreviation Definition
ADSL Asymmetric Digital Subscriber Line
ADM ADSL Diagnostic Monitor (Service to monitor ADSL connection state)
API Application Programming Interface
CPL CNIM Programming Language
CDF Communications Data File (may also be known as a CNIM Data File). Contains
values to be set into the Eicon ISDN card by the CNIM (for Access numbers to the
Data Centre Routers over the Energis voice and Data Networks) and by
EiconConfig for CHAP usernames and network options.
A CDF is installed during outlet ISDN G/W PC installation and replacement/swap-
out. They form part of the mechanism for the delivery of OBC changes to a live
outlet following relocation (with ISDN number change), conversion to/from
Mobile outlet (although conversion to/from mobile outlet is only supported by the
"end-to-end" system before the outlet goes live) and for network changes (by
Energis.)
CHAP Challenge Handshake Authentication Protocol
CNIM. Counter Network Infrastructure Manager
BNR Branch Network Resilience
Blackhole Failure
A type of network failure that will not be detected by Connection Manager. CNIM.
pings will fail.
DLL
Dynamic Link Library
Data Network
Note that the Data network is the name for the non-ISDN or satellite network and
may also apply to the FRIACO network.
FRIACO Fixed Rate Internet Access Call Origination
FE FRIACO Establish
FF FRIACO Fixed
FCIP FRIACO Primary (Geographical Area 1)
FCIS FRIACO Secondary (Geographical Area 1)
FC2P FRIACO Primary (Geographical Area2)
FC2S FRIACO Secondary (Geographical Area 2)
DIAPI Diapi ISDN interface for Windows NT
DP Dial Around Primary
DS Dial Around Secondary
© 2006 Fujitsu Services
Company in Confidence Page 5
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
IP Internet Protocol
ISDN Integrated Service Digital Network
IDI Eicon ISDN Driver Interface
KMS Key Management System
LAN Local Area Network
MOD Metered on Demand
MODG Metered on Demand with GSM backup
MF Metered Fixed.
MFG Metered Fixed with GSM backup
MP Metered Primary
MS. Metered Secondary
NST Network Service Type (Voice, Bronze, Satellite etc.)
PC Permanent Connection
RAS. Remote Access Service
RA RAS ADSL
RG RAS GSM
RAG RAS ADSL/GSM
RAIG RAS ADSL/ISDN/GSM
RIT RAS ISDN for Test
RID RAS at IDLE
RSS Received Signal Strength Indicator
SCM Service Control Manager
UID User ID
UTC Universal Coordinated Time, same as GMT
VOD Voice on Demand
VODG Voice on Demand with GSM backup
VPN Virtual Private Network
vP Voice Primary
vs Voice Secondary
VT Voice Tertiary
WAN Wide Area Network
0.5 Changes in this Version
Version Changes
0.3 CNIM Test Sequence
CNIM Programming Language
11 Test Sequence - Permanent Connection
© 2006 Fujitsu Services Company in Confidence
Page 6
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Table 35 - NST 11 Connection Type per Mode.
Table 9 - Wait Times for Call Closure
2.0 5.12.1 Clarify detail.
5.13.1.a Updated - Fail values not required in CNIM 2.
5.13.1.b - CNIMConfig used.
8.4 Number of Events generated
21 5.9.4.b Dial Back test plan modified for PinICL PC0094556
CNIM behaviour modified when going to FRIACO Fixed and not in Mode
1 - PinICL PC0093827
Changes required for use with ADSL at S60
2.2 Updates to:
GetStatus for ADSL
Monitor File Format for ADSL
Note: Not circulated for review.
23 Updates to:
Test Plan operations.
QOS Result codes.
Engineers screen - availability of network state.
3.0 Comments added
3.1 PC0093488 — Correction to decimal values in Cause Code table in
appendix.
3.2 2.2.4 — Branch Resilient Network — and links within that section
2.2.5 - Table 9 Network Service Types including Branch Resilient
Network Types
3.3 1. Updates to section 5.11 concerning Branch Resilient Network.
2. Section 4.1.3.b and 4.1.3.c, interfaces for Connection Modes and
Service Types
Updates to 5.13 Test Sequences for BNR
Appendix A2 Call Plan for BNR
Further updates to section 5.11 concerning Branch Resilient Network.
Further updates to 5.13 Test Sequences for BNR
Further updates to Appendix A2 Call Plan for BNR
3.5 CP 4097 - Connection Manager reset every 20 minutes
CP 4103 - GSM Signal Strength Indicator
34
en =[a oe
2.2.9.c Bandwidth logging with a maximum value (PC0106937)
2.2.17 CNIM to send reset to Connection Manager every 20
minutes.
2.2.18 GSM Network gives Received Signal Strength Information
© 2006 Fujitsu Services Company in Confidence Page 7
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
2.2.19 Event Logging of Network Switching for BNR and linked
sections
5.24 Received Signal Strength Indicator
Changing call result codes to 8 characters as shown in appendices:
Appendix A4, Appendix A5, Appendix A6, Appendix A7, Appendix A&
3.6 2.2.9.a Monitor record generation — PC0132421
0.6 Changes Expected
Changes
Further updates for Branch Network Resilience.
0.7 Table Of Contents
0 DOCUMENT CONTROL...
0.1 DocuMENT HISTORY. 2
02 REVIEW DETAILS ...coonnnnnnnnnnnnnnnnnnnnnn osname senso 2
0.3 ASSOCIATED DOCUMENTS. 3
0.4 ABBREVIATIONS/DEFINITIONS, 4
0.5 CHANGES IN THIS VERSION......ocoo:nonnnnnnnnnninnnnnnnsnnnnninnstninnnninininnnsnnnsnsnnsnuinnsnsnnsnnsnnnnsnnsnnsase 3
0.6 CHANGES EXPECTED... spsnntennnnennnienennnnnennnnsennnnnenennnese sovninnennenennneceennees TD
0.7 TABLE OF CONTENTS. . . 7
0.8 TABLE OF FIGURES. 13
0.9 TABLE OF TABLES.....00::ccsnnsneiininnninininninnnnnenisns sesntnnnninnnnninininnnninnnnininninninnnnnsnaesiiee 13
1 INTRODUCTION.
1 BACKGROUND. 18
2 60) 19
13 DOCUMENTATION OUTLINE sosssnsnnnnsnnnnnnnnnnnnn nnn 20
4 SUMMARY. 20
2 REQUIREMENTS...
21 REQUIREMENT OVERVIEW.
2.2 DETAILED REQUIREMENTS.
2.2.1 CNIM Service Requirements
2.2.2. Interface to ADSL Card.
2.2.3 Interface to Connection Managei
2.2.4 Branch Resilient Netwo
224.0 Connection Switching,
2.2.4.a.1 Automatic Failover to ISDN.
2.2.4.b Connection Manager Interface...
2.2.4. Engineers Button Interface.
2.2.4.c.1 Initiate Connection.
2.2.4.c.2 Test Connection.
2.2.4.3 Drop Connection...
4.c4 Reporting Connection Status.
2.2.44 Counter Call Scheduler Interfac
2.2.4.e QOS Interface.
2.2.4.£ Eicon Card Interface. cesemeene
224.9 Testing of the Backup Network.
224h ADSL to GSM On Demand (Standard and Strategic Site)... co eceeeeeeeeseeneeeneeeeeen seseseneeseneeeees dO
2.2.4. Standard ISDN to GSM On Demand...
22441 Manual Operation of Failover. 3
2.2.4.i.1.1 Connection Manager and CNIM. 31
© 2006 Fujitsu Services Company in Confidence Page 8
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
2.2.4.i.1.2 I Manual Operation.
ISDN - GSM Switch Proces:
Event Reporting for BNR Switching.
Eicon Card Configuration...
Eicon Parameters - Numerical Value
Version 2 Run Mode. .
2.2.7.0 Network Service Types - Including ADSL.
2.2.7.¢ Call Plan...
2.2.7.1 Call Plan Input
2.2.7.2 Call Plan Data Output....
2.2.7.¢.3 Call Plan Connection Configuration,
2.2.7.c.4 Call Plan File. z .
2.2.7.5 — Randomisation of Connection and Disconnection... 1.37
2.2.7..5.1 ADSL Offsets.
2.2.7.d Line Test Overview.
2.2.7.d.1 Determination of Communication Failure.......
2.2.7.d.1.1 Cause Code Description.
2.2.7.6.1.2 Ping Failure... .
2.2.7.d.1.3_ Changes for ADSL.
2.2.7.d.2. Run Mode Description.
2.2.7.3 Failure Mode Description.
2.2.7.4 — Test Requirements...
2.2.7.d.4.1 Wait Times for Call Closure.
2.2.7.4.4.2 Behaviour on Failure - Version
2.2.7.4.4.3 Testing During Establish Period
2.2.7.4.4.4 Testing During Fixed Periods
2.2.7.4.4.5 Testing During Dialled Periods... . .
2274.6 Test Sequence -VSAT - Permanent Connection . 45
2.2.7.d.4.7 Test Sequence - ADSL. = . .
2.2.7..4.8 _ Failure Flag State.
22.70 Line Connectivity...
2.2.8 CDF Data Storage Requirement...
2.2.8. CDF Content
2.2.8.b CDF - Network Configuration (for CNIM access numbers).
2.2.8. Phone Number Mapping.
2.2.9 Call Logging Requirement
a Monitor Record.
2.9.a.1 Record Format and Description.
2.2.9.a.1.1 Monitor Record Format - CNIM Version 2.
2.2.9.a.1.2 Monitor Record Format - CNIM Version 3...
2.2.9.a.2 Initial Record Format
Final Record Format.
Changes for Version 2.
Monitor Record Format for ADSL.
Monitor Record Format for ISDN and GSM over RAS.
File Name Format...
Monitor File Creation and Renaming
Call Monitoring for Satellite connected Outlets.
Call Monitoring for ADSL connected Outlets.
Summary Record. .
Summary Files for ADSL...
Summary File Name Format
Bandwidth Logging for ADSL.
Dial Back Requirement
Keep Alive Requirement.
2.2.11.a Ping Sequence.
2.2.11.a.1 Methodolog;
2.2.12 Time Format Requirement.
2.2.13 GetStatus Query Requirement......
.13.a GetStatus Query Requirement for ADSL.
2.2.13.b GetStatus Flag Settings for ADSL with ISDN and GSM Backup
© 2006 Fujitsu Services Company in Confidence Page 9
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
2.2.14 Satellite Requirements.
2.2.15 Tracing Requirement
2.2.16 Static Test Requiremen
2.2.16.a CNIM Test — Implementation.
2.2.16.a.1 Implementation Test at $60......
2.2.16.b — CNIM Test - normal running
2.2.16.b.1 Normal Test at S60...
2.2.17 BNR - CP4097 CNIM to send reset to Connec!
2.2.17. Service Type 13 - ADSL only Outlets.
2.217.b Service Type 14 - ADSL Outlets with ISDN Backup............
2.2.18 BNR - CP4103 GSM Network gives Received Signal Strength Information..
2.2.19 Event Logging of Network Switching for BNR...
3 ARCHITECTURE..........004
3.1 SYSTEM DIAGRAM 70
3.2 OPERATIONAL OVERVIEW. 7
4 EXTERNAL INTERFACEB........
on Manager every 20 minut
4.1 INTERFACES PROVIDED.
4.1.1 NT Service Interface...
4.1.2. GetStatus Interface to Counter Call Scheduler.
4.1.3 Operational Control Interface. .
a Call Plan Registry.
b Connection Mode y
4.13.b.1 FRIACO Establish Connection Types...........0+
4.1.3.b.2_ FRIACO Fixed Connection Types.
4.1.3.b.3 FRIACO Fixed With - Connection Types. 74
4.1.3.b.4 Metered Fixed Connection Types...
4.13.b.5 Metered Fixed with GSM Connection Types.
4.1.3.b.6 Metered On Demand Connection Types.
4.1.3.b.7 Metered On Demand with GSM Connection Types...
4.1.3.b.8 Voice Connection Types.
4.1.3.b.9 Voice with GSM Connection Types.
4.1.3.b.10 RAS ADSL Connection Types......
4.1,3.b.11 I RAS ADSL-GSM Connection Type:
4.1.3.b.12 I RAS ADSL-ISDN-GSM Connection Types.
4.1.3.b.13_ RAS ISDN Only Connection Types........
4.1.3.b.14 VSAT Connection Types
4.1.3.b.15 Frame Relay Establish Connection Types.
4.1.3.b.16 Frame Relay Fixed Connection Types.
4136 Service Mode Registry
Service Mode — FRIACO 1..
Service Mode — FRIACO 2..
Service Mode - Metered.
Service Mode - RAS..
Service Mode - Voice.
Service Mode - VSAT.
Service Mode — Frame Relay........:.s:ssssessesseseeeee
4.1.3.d Mapping Service Type to Service Mode.
Test Results Regi
i Times Registry...
j SubAddressing Registry
13k Trace Regist
4.13.1 TuneableTrace Re
4.13.m Service Event Regis
413m Service Dependeney Registry
4.13.0 Eicon Registry...
413p User Registry
© 2006 Fujitsu Services Company in Confidence Page 10
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
4.1.3.q Connection Manager Registry...
4.1.3.1 Interface with ADSL Diagnostic Monitor...
4.13.8 CNIM NST Groups.
4.1.3.1. CNIM Network Settings...
4.13.0 Bandwidth Configuration S:
4.2 INTERFACES USED.
5 DESIGN OVERVIEW...
5.1 SERVICE DEFINITION. se sen 96
5.2 CNIM SERVICE DESIGN OVERVIEW 96
5.2.1 Service Dependencies. .
5.3 EICON CARD CONFIGURATION DESIGN OVERVIEW 96
5.3.1 Card Parameter Storage...
53.La Phone Numbers and Network Service Type
5.3.1.b CHAP Passwords and User Ids. oo
53.L€ Shorthold, Minimum Call Duration and CHAP Interval Times 97
5.3.2. Card Parameter Application. seseees 97
5.4 NETWORK SERVICE TYPE DESIGN OVERVIEW. 97
5.5 CDF DATA STORAGE DESIGN OVERVIEW. 97
5.6 CALL PLAN DESIGN OVERVIEW. .csccsonsesnnnnnnnnnnnnnnnnnse ssssninnnsotonannnninnntnnenananneenee secmaennseeees LOO
5.7 QOS LOGGING DESIGN OVERVIEW. .ccscocsssoeserscennneennen sesso . sosneneeeesne LOO
5.7.1 Call Logging - ISDN.
5.7.La The IDI Interface.
5.7.1.b Call Activation and Closure.
5.7.2 Call Logging - VSA
5.7.3 Call Logging - ADS!
5.7.3.a ADSL Diagnostic Monitor Inter
5.7.3.6 Connection Manager Interface...
5.7.3. Bandwidth Calculation - ADSL Only
5.7.3.1 Bandwidth Pinging.
5.7.3.¢.2 Bandwidth Return Codes......:.:.cissssssisessisestineseienn
5.8 DIAL BACK DESIGN OVERVIEW.
5.9 BRANCH RESILIENT NETWORK ISDN/GSM SwITcH PROCESS. sonnniatnnnnennnnnennen
5.10 BRANCH RESILIENT NETWORK INTERFACE WITH CONNECTION MANAGER 0000ceernen PDL
5.10.1 RAS Connection Type Informatio}
5.11 DETERMINATION OF FAILURE CODE..
5.111 Cause Code Range:
S112 Eicon Cause Code: : .
5.12 ENGINEERS BUTTON, DESIGN OVERVIEW. 116
5121 BNR Static Data. .
5.12.2 Network Resilience State.
512.3 Network Resilience Mode
5.12.4 Network Resilience History.
512.5 Returning Network State.
5.12.6 ISDN/GSM Switch Proce:
5.13. Test STRATEGY, DESIGN OVERVIEW... snare snes osm
5.13.1 Run Mode — ISDN Outlet... : 126
5.13.1.a Pre Version 2.0.
5.13.1.b Version 2 Onward...
13.1.b.1 Service Type 11 at Metered Fixe 127
5.13.
1.b.2_ Service Type 11 at FRIACO Fixed 127
5.13.2 Ping Sequence. .
5.133 Test Strategy Design...
5.13.3.a Diversion Operations.
5.13.3.b Test Plan Details... sesseeeneenneee socsseesseeneenneennenneenennee
5.13.3.b.1 Test Plan - FRIACO Establish, : . 135
$.13.3.b.2_ Test Plan - FRIACO or Metered Fixed. . .
5.13.3.b.3. Test Plan - FRIACO Fixed at $92.
$.13.3.b.4__ Test Plan - Dialled (MOD)......
© 2006 Fujitsu Services Company in Confidence Page 11
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
sl Test Plan - Dialled (VOD)........-.. 141
5. Test Plan - Dial Back $60........ sooeeenseesesneeeneee sosesneee cooeeseseesenneeeneeessnneees 144
5.1 Test Plan - Satellite. 145
5. Test Plan - ADSL.. . 14S
5.1 Test Plans for R. 145
Test Plans - ADSL Onl. .. 146
Test Plan - ADSL with 148
Test Plan- RAS GSM Backup. 151
Test Plan - ADSL with ISDN and 152
5.13.3.b.9.5 Test Plan - ISDN Only.. sees 155
5.13.3.b.9.6 Test Plan - RAS at Idle. . seeeeee soe 156
5.13.4 Code Character for Test Ranges. ss .. 156
5.14 Keep ALIVE STRATEGY OVERVIEW, 157
5.15 TIME FORMAT OVERVIEW. 157
5.16 DESIGN OVERVIEW: GETSTATUS QUERY. 157
5.16.1 Connection Statu wl SD
5.16.2 Connection Type. wi lS9
5.16.3 TickNailedUp... 160
5.16.4 ickLastConnectionChange.
5.16.5 FailCode..
5.16.6 TickPermanent.
5.16.7 Timeout.
5.17 Sratic Test Mopes........ sos
5.17.1a NIM Test — Implementation,
5.17.1.b CNIM Test - normal running.
5.18 CNIM RESET...
5.19 SERVICE INSTALLATION AND CONFIGU
5.20. CNIM TRACE.
5.20.1 Default Trace Levels.
5.20.2 CNIM Log File.......
5.20.3 TuneableTrace F
5.20.4 Event Log....
5.20.5 Debugging Output.
5.21 TRACE LOGIC... esos
5.22. CALL LoGGING Locic..
5.23 CP4097 - 20 MINUTE RESET OF Cor EA HON MANAGER : : nn : 166
5.24 CP4103 - LOGGING OF GSM RECEIVED SIGNAL STRENGTH TO TUNEABLETRACE....0cccoonenennnnene 166
5.25 EVENT LOGGING OF NETWORK SWITCH....cooonsmssnnonnnnnnnnnnnannnnnnnnnnnnenn 168
6 IMPLEMENTATIO:
6.1 SERVICE......
6.1.1 — Threadin;
6.1.2 Service control notifications.
6.1.3 Service status notifications...
6.1.4 Inter-thread Communication.
6.1.5 — Service Events...
6.1.5. CCNIM.
6.1.5. CallManager - Test Thread.
6.1.5.¢ CEiconManager - Logging Thread.......
6.2 CLASSES.
6.2.1 Class Overview...
6.2.2 CService.
6.2.3 CServicelnstall.
6.2.4 CCNIM....
6.2.5 CEiconManager..
6.2.5.4 Protected Members.
6.2.6 CCallManager.
6.2.6.a Protected Members. 183
© 2006 Fujitsu Services Company in Confidence Page 12
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
6.2.7. CCallPlan.
6.2.8 CTestManager.
6.2.9 CIPAdaress..
6.2.10 CEventLog.
7 NON FUNCTIONAL REQUIREMENTS....
71 PERFORMANCE.
7.1.1 — Registry sizing.
7.1.2 Event logging.
7.2 RESILIENCE.
7.2.1 Corrupt Policy File.
7.2.2 Failure of the CNIM service...
7.3 SECURITY,
7.3.1 — Event Logging...
74 SYSTEMS MANAGEABILITY...
7.4.1 Installation/Removal..... . .
7.4.2 Startup and Shutdown procedures.......
7.4.3 Maintenance. wee
7.4.4 Software Distribution.
7.4.5. Year 2K compliance
7.4.6 — Finite Date Limits.
75 EXTENSIBILITY.
8 ERROR HANDLING AND EVENT LOGGING...
8.1 LOGGING REQUIREMENTS. 187
8.2 EVENT LOGGING....... erste ss . sesensnesn 187
8.3 AUDITING... z oonennennsee oe soos svtnntenennteneenen soe 187
84 EVENT LOGGING ESTIMATES.... - soon 187
9 TARGET ENVIRONMENT.....
10 TESTING REQUIREMENTB.....
11 DELIVERABLES...
1 SOFTWARE.
2 DOCUMENTATION. 190
12. ASSUMPTIONS AND RISK:
12.1 ASSUMPTIONS.
12.2 RISKS.
13. DESIGN CON
‘ORMANCE.....
APPENDIX Al. CALL PLAN - CNIM 1,2,3...ccssecsesseeseene ae 194
APPENDIX A2. CALL PLAN - CNIM 4 - S92 FOR B}
APPENDIX A3. EVENT LOG MESSAGEG.........00004
APPENDIX A4. CAUSE CODE DESCRIPTIONG.....
APPENDIX A5. RAS ERROR CODES..
APPENDIX A6. CONNECTION MANAGER CAUSE CODES...
APPENDIX A7._ FUJITSU DEFINED CAUSE CODEB...........
© 2006 Fujitsu Services Company in Confidence Page 13
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
APPENDIX A8. CNIM CAUSE CODES.
APPENDIX A9. — DIAPI INTERFACE...
APPENDIX A10. RAS ERROR CODES - PRE S92...
0.8 Table Of Figures
Figure I Document Hierarchy 20
Figure 2 ADSL-ISDN Switching Logic 27
Figure 3 Testing During FRIACO Establish 42
Figure 4 Testing During Fixed Periods 43
Figure 5 Testing During Dialled Period 44
Figure 6 Test Sequence - VSAT 45
Figure 7 Test Sequence - ADSL 46
Figure 8 Fail Flag State Mechanism 47
Figure 9 Ping Sequence (call to Data Centre) 62
Figure 10: System Diagram 70
Figure 11 Telephone number mapping from Registry 99
Figure 12 Call Reversal 110
Figure 13 Trace Logic 165
Figure 14 Call Logging Logic 166
Figure 15: Service threading 171
Figure 16 CNIM Class Overview 176
Figure 17 Eicon Interfaces 177
Figure 18 Logging Thread - IDI Interaction 178
Figure 19 Call Plan Conversion to Element List 181
Figure 20 CPL to Test Sequence Schematic 182
0.9 Table Of Tables
Table 1 Connection Types and Service Types 29
Table 2 Eicon Card Timer Parameters 33
Table 3 Eicon Card Timer Parameters - Version I 33
Table 4 Eicon Card Timer Parameters - Version 2 34
Table 5 Eicon Card Timer Parameters - Version 3 34
Table 6 Eicon Card CHAP Parameters 34
Table 7 Eicon Card Called Party Numbers - CNIM Ver. I 35
Table 8 Eicon Card Called Party Numbers - CNIM Ver. 2.0 35
Table 9 Network Service Types including Branch Resilient Network Types 36
Table 10 Call Plan Offsets — ISDN/Data/FRIACO 38
Table 11 Call Plan Offsets - ADSL 38
Table 12 Wait times for call closures 41
© 2006 Fujitsu Services Company in Confidence Page 14
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Table 13 Connection Types 49
Table 14 Number Types and Descriptions 50
Table 15 Monitor Record Format for ADSL 54
Table 16 Monitor Record Format for ISDN and GSM 55
Table 17 Format of Summary Record 56
Table 18 — Network Connection Status from CNIM 64
Table 19 — QOS Flags from CNIM 65
Table 20 QOS Flags for Connection Types 66
Table 21 Flag Settings for Resilient Network 67
Table 22 Flag Settings for Resilient Network 67
Table 23 Registry Entries - Call Plan 72
Table 24 CNIM and BNR Modes for Connection Types - FRIACO Establish 74
Table 25 CNIM and BNR Modes for Connection Types - FRIACO Fixed 74
Table 26 CNIM and BNR Modes for Connection Types - FRIACO Fixed with GSM 74
Table 27 CNIM and BNR Modes for Connection Types - Metered Fixed 75
Table 28 CNIM and BNR Modes for Connection Types - Metered Fixed with GSM 75
Table 29 CNIM and BNR Modes for Connection Types - Metered On Demand 75
Table 30 CNIM and BNR Modes for Connection Types — MOD with GSM 76
Table 31 CNIM and BNR Modes for Connection Types — Voice 76
Table 32 CNIM and BNR Modes for Connection Types - Voice with GSM 76
Table 33 CNIM and BNR Modes for Connection Types - ADSL only 77
Table 34 CNIM and BNR Modes for Connection Types - ADSL with GSM 77
Table 35 CNIM and BNR Modes for Connection Types - ADSL with ISDN and GSM 77
Table 36 CNIM and BNR Modes for Connection Types - ISDN Only 78
Table 37 CNIM and BNR Modes for Connection Types — VSAT 78
Table 38 CNIM and BNR Modes for Connection Types — Frame Relay Establish 78
Table 39 CNIM and BNR Modes for Connection Types — Frame Relay Fixed 79
Table 40 Service Mode — FRIACO 1 80
Table 41 Service Mode — FRIACO 2 80
Table 42 Service Mode - Metered 81
Table 43 Service Mode - RAS 81
Table 44 Service Mode - Voice 81
Table 45 Service Mode - VSAT 81
Table 46 Service Mode — Frame Relay 82
Table 47 Mapping Service Type to Service Mode 82
Table 48 Registry Entries - Live 85
Table 49 Registry Entries - Period 85
Table 50 Registry Entries - RPC 86
© 2006 Fujitsu Services Company in Confidence Page 15
Fujitsu CNIM Low Level Design
Services
COMPANY IN CONFIDENCE
FUJ00171956
FUJ00171956
Ref: RS/LLD/004
Version: 4.0
Date: 8/05/2006
Table 51 Registry Entries - Test Results
Table 52 Registry Entries - Times
Table 53 Registry Entries - Users
Table 54 Registry Entries - Sub Addressing
Table 55 Registry Entries - Tracing
Table 56 Registry Entries - TuneableTrace
Table 57 Registry Entries - CNIM TuneableTrace
Table 58 Registry Entries - Message Path
Table 59 Registry Entries - CNIM Service Dependency on RPC
Table 60 CDF Data Storage in Registry
Table 61 User Data Storage in Registry
Table 62 Connection Manager Registry
Table 63 ADSL Diagnostic Monitor Registry
Table 64 CNIM ADSL Diagnostic Monitor Data
Table 65 CNIM NST Groupings
Table 66 CNIM Network Settings
Table 67 Bandwidth Configuration Settings
Table 68 Bandwidth Result Codes
Table 69 IDI Parameter Description
Table 70 Connection Manager Switch Registry
Table 71 DialMode Description
Table 72 DialMode Strings in CNIM Registry
Table 73 Connection Manager Network Types
Table 74 Port Contents for Connection Types
Table 75 Connection Manager Phonebook Details
Table 76 Determination of Failure Code
Table 77 Cause Code Ranges
Table 78 Engineers Button Trigger Registry
Table 79 BNR Static Configuration Data
Table 80 Branch Network Resilience - State Information
Table 81 Mapping Mode to Connection Type
Table 82 Mapping History to Connection Type
Table 83 Engineers Button Options
Table 84 Resilient Network Status
Table 85 Network State Screen Information for BNR
Table 86 Called Party Numbers per Mode - Version I
Table 87 Called Party Numbers per Mode - Version 2
Table 88 CPL Operations
87
89
89
90
90
90
91
91
91
92
92
93
94
94
94
94
95
95
102
111
112
112
113
113
114
114
115
116
118
119
120
121
121
123
124
126
127
132
© 2006 Fujitsu Services Company in Confidence
Page 16
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Table 89 Diversion Operation Conditions 133
Table 90 E Range Test Elements - FRIACO Establish Period - S60 135
Table 91 F Range Test Elements - FRIACO Fixed Period - S60 136
Table 92 FRIACO Fixed Test Elements- S92 138
Table 93 D Range Test Elements - Dialled Period 140
Table 94 I Range Test Elements - Dialled Period - ISDN 143
Table 95 Dial Back 144
Table 96 Ping Result and Line Status 144
Table 97 P Range Test Elements - Permanent Connection (Satellite) - S60 145
Table 98 A Range Test Elements - ADSL - S60 - With Test On Line State Change 145
Table 99 RA Range Elements - S92 147
Table 100 RAG Range Elements - S92 150
Table 101 RG Range Elements - S92 151
Table 102 Test Plan - ADSL/ISDN/GSM 154
Table 103 RIT Range Test Elements - S92 155
Table 104 RID Range Test Elements - S92 156
Table 105 GetStatus Return Values 158
Table 106 Connection Status Values 159
Table 107 Connection Type - First Byte 159
Table 108 Connection Type - Second Byte 160
Table 109 Connection Type - Third Byte 160
Table 110 Implementation Test Flags 161
Table 111 Trace Flags 163
Table 112 Tracing Parameters 164
Table 113 Network Switch Event Requirements 168
Table 114 Events for Change of Connection Type 169
Table 115 Test Thread Events 174
Table 116 Eicon Manager Events 174
Table 117 Event Logging Estimates 187
Table 118 RAS Error Codes and CNIM Equivalents 224
Table 119 Connection Manager Cause Codes 225
Table 120 Fujitsu Defined Cause Codes 226
Table 121 CNIM Service State Codes 227
Table 122 DIAPI Functions 230
© 2006 Fujitsu Services Company in Confidence Page 17
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
1 INTRODUCTION
1.1 Background
The introduction of FRIACO network service at BI3 instigated a fundamental change in the way
the Post Office (PO) Outlets interface with the Data Centres. FRIACO provides a ‘fixed price’
connection for a specified period of time during the day and hence no call charges.
A number of the PO Outlets are ‘permanently’ connected via FRIACO, where the circuit is kept
active and hence a permanent connection after the number has been dialled.
Tn areas where the FRIACO service is not currently available, a metered call is kept active and
hence a permanent connection for the specified period of time during the day. These Outlets are
classified as ‘permanently’ connected via a metered call.
Other Outlets utilise ‘dial on demand’ (pay-as-you-go) and maintain the connection for the
duration of the transaction only incurring call charges for that duration.
The current proposed mix of ‘permanent’ against ‘metered’ is 12,000 ‘permanent’ at full
Network Banking implementation the rest on metered access.
The FRIACO service provides for ‘in-bound’ calls only (PO to Data Centre), thus a method for
software distribution has to be devised, and additionally we must retain a mechanism to access
an Outlet from the Data Centre for support access. Initially we will have 6000 daytime FRIACO
outlets, rising to 12,000 over 2 years.
At S52 the use of ADSL will commence at a number of pilot sites. The use of ADSL will then
spread across the entire estate.
Each gateway PC will be fitted with an ADSL modem card manufactured by Conexant. CNIM
will not be able to interface to the card via the Conexant API as this is being used by the ADSL
Diagnostic Monitor. Instead, CNIM will request low level connection state information from the
ADM service itself. CNIM will be notified of the state of the RAS connection via registry
information supplied by Connection Manager.
When running at ADSL, CNIM will provide only QOS data, including new bandwidth
information, and an interface for Counter Call Scheduler.
CP3898 is concerned with the development of a Branch Resilient Network, primarily to provide
a backup for ADSL outlets in that they may use either an ISDN or GSM connection in the event
of network failure. In addition ISDN outlets may use a GSM connection under the same
circumstances.
Note that this document version, 3.2, is not a complete specification for the Branch Resilient
Network operation of CNIM but is primarily concerned with the interface specifications
between CNIM and other applications. Further detail concerning modifications to the internal
operation of CNIM will be added in the next version.
Section 2.2.4 gives an overview of the interface changes and contains links to other sections
which contain further details of these changes.
1.2 Scope
This document specifies the detailed design of the Counter Network Infrastructure Manager
(CNIM). CNIM is run on an outlet’s gateway PC and its essential function is to control the
© 2006 Fujitsu Services Company in Confidence Page 18
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
numbers used by the Eicon card and to log all calls. In addition the use of an interface .DLL
(CNIM_APIdIl) allows further status information to be extracted from CNIM.
CNIM deliverables comprise the service executable, CNIM.exe and an interface .DLL,
CNIM_API.dll. A further executable, CNIMConfig.exe is also delivered which uses further
functionality within the .DLL to cause the CNIM service to carry out functions such as testing
all supplied phone numbers.
© 2006 Fujitsu Services Company in Confidence Page 19
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
1.3 Documentation Outline
The organisation of the relevant documentation is shown in Figure 1.
CAS Network QoS
CAS Network Quality of HLD
Service Product DE/HLD/001
Interface Specification
DE/IFS/003
Counter Call
Counter Network Scheduler Changes
AutoConfig High Level Infrastructure for Network Banking
Design for BI3 Manager HLD AD/DES/068
TD/DES/157 TD/SDS/002
Network Banking —
‘Trace and
Network Banking - Outlet . Diagnostics LLD.
network quality of service ‘Counter Network Infrastructure NB/LLD/O1S
reporting Manager LLD - This Document 4
SY/SOD/007 RS/LLD/004
Figure 1 Document Hierarchy
1.4 Summary
This document conforms to the current template for design documents:
Section 2 defines the requirements
Section 3 describes the architecture and highlights the external boundaries
Section 4 describes the external interfaces in detail
Section 5 presents a design overview
Section 6 shows the implementation details
Section 7 describes how the Non Functional Requirements have been addressed
Section 8 describes details of error handling and event logging
Section 9 specifies the target environment
Section 10 describes the unit and integration test requirements
Section 11 defines the content of the software deliverables
Section 12 looks at the assumptions and risks associated with the activity
Section 13 tracks conformance to requirements
© 2006 Fujitsu Services Company in Confidence Page 20
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
2 REQUIREMENTS
The requirements for the CNIM are derived from [HLD_CNIM] - see document [Ref 2].
The references given below for detailed requirements and design overview are internal
references within this document.
2.1 Requirement Overview
Tag I Ref Description
1 3.1 CNIM Service.
CNIM will function as a Service. Under WinNT.
Detailed Requirements: See Section 2.2.1
Design Overview: See Section 5.2
2 3 Eicon Card Configuration.
CNIM will configure the Eicon card in a manner which is consistent with
the mode of operation required.
Detailed Requirements: See Section 2.2.7
Design Overview: See Section 5.3
3 3 Network Service Type
CNIM configuration of the Eicon card and mode of operation will be
within the concept of a Network Service Type that is assigned to the
outlet.
Detailed Requirements: See Section 2.2.7.b
Design Overview: See Section 5.3.1
4 3.2.1 I CDF Data Retrieval and Usage
Outlet configuration data for phone numbers and Network Service Type
is delivered via a CDF. See [Ref 21]. CNIM is required to retrieve CDF
data from registry.
Detailed Requirements: See Section 2.2.8
Design Overview: See Section 5.5
5 3.2.3 I Call Plan
CNIM configuration of the Eicon card and mode of operation will be
within the concept of a Call Plan that is generic across all outlets.
Detailed Requirements: See Section 2.2.7.c¢
Architecture: See Section 5.5
6 45 Call Logging
CNIM will log each call to a Monitor file and produce a Summary file of
the calls for each day.
Detailed Requirements: See Section 2.2.9
Design Overview: See Section 5.7
7 45 Call Logging - ADSL
In addition to the Monitor and Summary files produced for normal
© 2006 Fujitsu Services Company in Confidence Page 21
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
logging CNIM will create a Bandwidth log as well.
Detailed Requirements: See Section 2.2.9
Design Overview: See Section 5.7
8 43 Dial Back
If CNIM detects that the Data Centre has attempted to contact the outlet
whilst the line is disconnected, it will go into KeepAlive mode to cause
the line to connect, see section 10.
Detailed Requirements: See Section 2.2.10
Design Overview: See Section 5.8
9 4.8.3 I Test Strategy
CNIM is required to determine whether comms have become unavailable
with as little loss of time as possible whilst minimising unnecessary line
usage. In the event of comms failure CNIM will attempt to reconfigure
the Eicon card such that comms are re-established.
CNIM is not required to reconfigure the network interface for ADSL or
Satellite outlets.
However CNIM is required to determine the ADSL network bandwidth
at regular intervals and to test that it can ping the Data Centre.
Detailed Requirements: See Section 2.2.7.4
Design Overview: See Section 5.12
10 I 4.4 Keep Alive Strategy
During certain periods of the day CNIM is required to maintain the line
connection to eliminate the call setup time.
CNIM may also be required to maintain line connection if a call from the
Data Centre to the outlet has been detected, see table entry 8.
The Keep Alive mechanism will include pinging one or more of the Data
Centres.
Detailed Requirements: See Section 2.2.11
Design Overview: See Section 5.14
aT 2.1.5 I Time Format
All times used by CNIM will be in UTC with the exception of times
specified within the Call Plan.
Call Plan times will be in local time so that the same Call Plan can be
used throughout the year.
Detailed Requirements: See Section 2.2.12
Design Overview: See Section 5.15
12 I 4.6 GetStatus Query
CNIM will accept a "GetStatus" query from an external source. CNIM
will return data related to the current connection type and status.
Detailed Requirements: See Section 2.2.13
© 2006 Fujitsu Services Company in Confidence Page 22
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Design Overview: See Section 5.16
13. I 4.10 I Static Test Modes
CNIM is required to supply two static test modes:
1) Implementation Test
2) Normal Test
Detailed Requirements: See Section 2.2.16
Design Overview: See Section 5.17
14 Branch Resilient Network (CP3898)
1. CNIM will provide an automatic failover facility between ADSL and
ISDN for Network Service Type 14 outlets. The ISDN connection
will be managed via RAS.
2. CNIM will test the ADSL failover to ISDN every Wednesday night
for NST 14 outlets.
3. CNIM will respond to an Engineers Application that will request a
change to a new network type, i.e. ADSL, ISDN, GSM or NDIS.
4. CNIM will generate an event stating that it is moving to a new
network type. The event will contain the name of the required
network type.
15 Connection Manager Reset (CP4097)
CNIM to send reset to Connection Manager every 20 minutes when
network problem detected
Currently CNIM on detection of a network failure sends a “reset”
request to Connection Manager , on receipt of this call, Connection
Manager drops the existing RAS connection, (whatever the status of the
call), and attempts to re-establish the connection. In some instances
Connection Manager re-establishes the connection and all appears ok,
however no data flows. In this scenario CNIM does not send another
“reset” request to Connection Manager, it remains in a “wait state” as it
has not seen any change in packets sent or received.
Under these circumstances the intention of this CP is that CNIM will
send the “reset” request to Connection Manager every 20 minutes, and
not just once as per current implementation. The sequence of events will
be:
(a) A CNIM “bandwidth” ping fails (bandwidth pings every 5 minutes)
(b) CNIM enters error recovery mode and pings all 4 VPN servers
(c) All 4 VPN pings fail
(d) CNIM sends “reset” request to Connection Manager
(c) CNIM starts two timers a 20 minute and a 15 minute timer
(f) CNIM continues with 5 minute pings
(g) If ping successful, cancel both 20 & 15 minute timers and exit error
recovery
© 2006 Fujitsu Services Company in Confidence Page 23
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
(h) After 15 minute timer “off-Line” Indicator set
(i) After 20 minute timer “reset” request sent to Connection Manager
Reset 20 minute timer
16 GSM Signal Strength Indicator (CP4103)
Backup Network GSM option provides Received Signal Strength
information.
In summary this change proposes making the GSM Received Signal
strength information available to both the Engineer installing the GSM
modem and within diagnostic logs on the Gateway PC. Additionally the
unique identification of the modem is also written to the diagnostics logs.
CNIM / Connection Manager
Immediately prior to initiating a connection* over the BNR GSM
modem, the following commands will be sent to the GSM modem;
AT+CSQ
Response is +CSQ:rssi,99 where rssi in range 0 through 99, note rssi is
the abbreviation for received signal strength indication
AT+CGSN
Response is imei, where imei has format nnnnnn—nn-nnnnnn-n, note
imei is the abbreviation for International Mobile Equipment Identity
The responses will be written to relevant diagnostic logs by CNIM and /
or Connection Manager as appropriate.
Additionally when triggered via registry items for supporting the user
interface, the AT+CSQ command will be sent to the GSM modem and.
the rssi response written to the registry.
* Including automated redials by Connection Manager.
User Interface
Confirm Connection Screen — add extra display field GSM Received
Signal strength. This is updated from an additional registry key
"GMSSignalStrength"
Confirm Connection Screen
If GSM is selected then on the Confirm dialogue, set a Registry flag
which causes CNIM to obtain rssi from modem. Display rssi on screen,
reset flag and poll for changes updating display as necessary. Continue
until confirm / cancel is selected
Note this is necessary since the engineer may be moving the modem
around / attaching an external antenna
2006
Fujitsu
ervice: Company in Confidence Page 24
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
2.2 Detailed Requirements
This section gives more details of the CNIM requirements.
2.2.1 CNIM Service Requirements.
Design Overview: See section 5.2
The CNIM shall run as an NT service under the LocalSystem account. The service shall start
automatically.
2.2.2 Interface to ADSL Card
Design Overview: See section 5.7.3
The connection to the ADSL Conexant card is shared with the ADSL Diagnostic Monitor
service. The Conexant API does not allow more than one concurrent connection and the ADM
service will be responsible for storing the connection state from the card, in registry.
CNIM will use the ADM registry to retrieve the connection state.
CNIM will set a flag in the ADM section of registry, indicating that it requires the current
connection state. CNIM will then wait for registry notification that ADM has updated registry
and will then retrieve the current connection state. After setting the new connection state ADM
will reset the flag. CNIM will check the flag state to ensure that it is reading the latest data.
The connection status data will be stored in the CNIM area of registry.
2.2.3. Interface to Connection Manager
Design Overview: See section 5.7.3
Connection Manager will store within registry, the ADSL connection state and the Day D
status.
CNIM will request registry notification of changes to both these state flags. This state data may
be the first indication to CNIM of a change in network state. When given this indication CNIM
will attempt to determine the cause of failure from the lowest level upwards in order to give the
greatest amount of diagnostic information
CNIM will use this state information to determine the name format of the QOS files to be
created.
2.2.4 Branch Resilient Network
Lack of reliability of the ADSL network has led to the requirement for a means of
ensuring communications are available via the ISDN network at selected sites. In
addition all ADSL sites will have backup available via a GSM modem.
The Branch Resilient Network operation is concerned with switching between different
types of connection where the connection type required, ADSL, ISDN or GSM, is
signalled by CNIM to Connection Manager.
2.2.4.a Connection Switching
The following design considerations for connection switching, are taken from the
Design Proposal, [DP_BRN], version 0.3.
© 2006 Fujitsu Services Company in Confidence Page 25
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
2.2.4.a.1 Automatic Failover to ISDN
Automatic failover between ADSL and ISDN is required for the Strategic Sites and the
logic flow for this process is shown in Figure 2
e Abackup ISDN connection would only be required during core hours.
e In order to ensure a robust backup policy, the ISDN connection will be maintained
until the end of core hours.
e The ADSL connection will be tested at the end of core hours and throughout the
night if the test continues to fail.
¢ The ISDN connection will be reconnected at the start of core hours if the ADSL
connection is unavailable.
CNIM Pings Target a
(every 5 mins)
Y
“ Ping Success Link okay Return to
YN Ping Process
VN
CNIM Pings Target
(10 minutes now
elapsed)
L . Y
Ping Success Link okay Return to
YIN Ping Process
N
Activate ISDN line for
— before start of working
Day
aN
Switch to ISDN and
keep ISDN active for Keep testing through I Y.
business working day night ADSL Works ? Use ADSL line
] aN z
J I
End of Business Day Y
Drop ISDN Line and > ADSL Works > Use ADSL line
test ADSL
Figure 2 ADSL-ISDN Switching Logic
© 2006 Fujitsu Services Company in Confidence Page 26
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
The backup connection will be dropped at 8.30pm to ensure that the end of day
messages have been uploaded to the Datacentre. End of day messages have a shut
off of 8.30pm.
After the connection has been dropped branches will be unable to connect to the
Datacentre and similarly the Datacentre would not be able to initiate a call out to a
branch.
2.2.4.6 Connection Manager Interface
Design Overview: See section 5.10
CNIM will be responsible for setting the required connection type within the
Connection Manager area of registry and then triggering a Connection Manager reset.
Connection Manager will then attempt to connect using the appropriate phonebook
entry for the connection type required.
CNIM will set a simple registry flag specifying the connection type required and
Connection Manager will respond by attempting a connection of that type. CNIM will
monitor the standard Connection Manager output to determine the success or
otherwise of the connection attempt.
2.2.4.c Engineers Button Interface
Design Overview: See section 5.12
A new set of engineer’s buttons will be used to directly control the connection type
currently in use and to test that connection.
The following requirements are taken from the design proposal.
e To Initiate/Test that ADSL is working
e To Initiate/Test and Drop the ISDN Backup connection for the Strategic Sites
e To Initiate/Test and Drop the GSM On Demand connection.
e A “one shot” password from the Helpdesk will be required to allow the initial
start of the Manual switch to ISDN
e Once the ISDN line has been dropped at the end of the business day then
CNIM will attempt to re-establish the ADSL connection.
e Ifthe ADSL line has been re-established then the button for the subpostmaster
or engineer should be disabled requiring a one off password again to allow
initiation
When the Backup Line is initiated or dropped as for the Automatic solution an NT
Event should be generated and passed to SYSMAN so people are aware of which
sites are running on the backup network.
The buttons must do one of three things, initiate a connection of a certain type, test
the connection and register a working connection.
A new screen will be provided to the Post Master and the Engineer. This will allow the
switch of connection type between ADSL, ISDN and GSM.
In order to switch to GSM the Post Master will require a one shot password. The
engineer will not require a one shot password specifically for this switch as he will
already be logged on using a one shot password.
© 2006 Fujitsu Services Company in Confidence Page 27
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
The one shot password provided to the Post Master will expire at an appropriate time
on or before midnight.
The screen will show the following buttons:
¢ Initiate Connection
e Test Connection
e Drop Connection
2.2.4.c.1 Initiate Connection
The Initiate Connection button will lead to a further screen offering a number of
options for the connection type to be initiated. These are tabulated below. Note that
all connections are managed using the RAS process except where NDIS is indicated.
Connection Type/ ADSL ISDN GSM VSAT
Network Service Type
1,4,7 (Switch requires I No Yes (NDIS) I Yes No
reboot)
2 No No No Yes
13 Yes No Yes No
14 Yes Yes Yes No
Table 1Connection Types and Service Types
Initiation of a connection will automatically lead to the connection being tested.
The Initiate Connection facility is not available if the Day D flag is set.
Initiation of a failover connection, i.e. ADSL to either ISDN or GSM or ISDN to GSM, if
done within the working day, will cause CNIM to remain on that connection type until
the end of the working day and then attempt to return to its primary connection type.
Manual initiation of a failover connection outside of the working day will cause CNIM
to maintain the chosen connection type until the start of the next working day.
2.2.4.c.2 Test Connection
The Test Connection button will initiate a set of CNIM test pings. CNIM will not
change connection type as a result of ping failure.
2.2.4.c.3 Drop Connection
The Drop Connection button will set the connection state to idle. The Post Master or
engineer is responsible for initiating a new connection.
2.2.4.c.4 Reporting Connection Status
CNIM will maintain connection status information within registry which will be
displayed either on the button screen or via a link from that screen.
A separate area of registry will be maintained for ADSL, ISDN and GSM connection
types.
© 2006 Fujitsu Services Company in Confidence Page 28
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Within each area a status string will show the date/time for the last connection of that
type, the call result in terms of success/failure codes and an interpretation of that
code if available. The phone number dialled will also be included.
2.2.4.d Counter Call Scheduler Interface
See section 2.2.13 which has been updated to include the new Branch Resilient
Network requirement.
2.2.4.e QOS Interface
The use of RAS to create ISDN and GSM connections requires that these be included
as new connection types within the monitor record file for each day.
See section 2.2.9 which has been updated to include the new Branch Resilient
Network requirement.
2.2.4.f Eicon Card Interface
The requirement to be able to switch between ISDN using the NDIS driver and GSM
over RAS will require the Eicon card to be disabled prior to a reboot.
Disabling of the Eicon card will be carried out by setting the “Start” value of the
TEDMULTI driver from Automatic (0x00000002) to Disabled (0x00000004) within the
registry key shown below:
[HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\Services\Diehl_DIVA_TEDMULTI
]
"Start"=dword:00000002
After rebooting the platform, the Eicon card will be disabled and this will ensure that
all WAN communications are via the GSM card.
2.2.4.9 Testing of the Backup Network
It is proposed that the ISDN backup network be tested once a week on a Wednesday
which is the day of the week when Software Distribution is not carried out. This
should be done on a random timer to avoid all sites trying to connect at once. This
parameter must be easily configurable as there may be a need to change the
date/time.
More detail on this is given in section 5.13.3.b.9.5
2.2.4.h ADSL to GSM On Demand (Standard and Strategic Site)
Deployments of the GSM On Demand solution will require the Postmasters to call the
Horizon Service Desk each morning that they have the solution deployed. They will
be issued a “One Shot” password that will allow manual initiation of the GSM
connection.
A GSM modem is connected via a Serial cable to the Specialix Serial card which is
installed in all Gateway PC’s. A dialled connection is established from the Gateway
PC and operates in a similar manner to a normal PSTN connection.
© 2006 Fujitsu Services Company in Confidence Page 29
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
This has been used in a form as a solution for Day D/J, but those solutions were more
about clearing transactions from a branch to the Correspondence servers if a branch
had been offline for a long period. It had no two way communications capabilities and
Online Transactions were not available in that scenario either.
2.2.4.1 Standard ISDN to GSM On Demand
There will be approximately 1000 sites still left on ISDN due to the inability to provide
ADSL to those locations. These ISDN connected branches use the NDIS driver to
control the Eicon ISDN card to deliver “dial on demand” capability.
Use of this NDIS driver means that there is a need to reboot the Gateway PC’s to
switch to the RAS drivers and unbind the IP address from the Eicon card. There are
three scenarios where a reboot may be required:
« When switching from the failed ISDN to use the GSM solution
¢ Switching back once the ISDN line has been repaired
e Any testing required to establish the ISDN line is repaired satisfactorily
2.2.4.1.1 Manual Operation of Failover
The process as described previously is just as relevant for the ISDN sites to use GSM
except for the expected need for a reboot when switching between modes of
operation. All reboots will be “attended” reboots requiring the Postmaster to be
present. There are some variances which are described in the Connection Manager
and CNIM description.
2.2.4.i1.1.1 Connection Manager and CNIM
Generally the operation of this service would be very similar to what has been
previously defined except for the following differences:
2.2.4.i.1.2 Manual Operation
At this point it assumes the manual establishment of the call has already been done
as per the descriptions earlier.
e At the end of Normal Business hours CNIM would check the Service type to
see if it is an “ISDN service type” (note: changes are occurring to usage of
ISDN service types and a check should be made prior to the LLD phase to
ensure the correct types are covered). \If the GSM Flag is set in the registry
then CNIM will inform Connection Manager to drop the GSM call.
« The Gateway PC will be left in such a state that it is ready for the Postmaster to
call the HSH the following morning and initiate the GSM connection on being
issued with a “one shot” password.
e The Gateway PC will not try to switch back to ISDN during the evening to test
the ISDN line, this adds unnecessary complication in terms of requiring an
Unattended Reboot which adds cost and complicates the overall solution. As a
call will already be open for the faulty ISDN line the need for a Reboot to
© 2006 Fujitsu Services Company in Confidence Page 30
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
switch back to ISDN can be managed by the HSH once it is confirmed that the
ISDN line has been fixed.
2.2.5 ISDN - GSM Switch Process
This process is specific to the ISDN sites running with the use of the NDIS driver.
About 1000 sites of this type will remain in operation.
This will be carried out between CNIM and an external switch process.
CNIM will intercept the button press requiring a switch either to or from GSM and will
ensure that no call is in progress before initiating a reboot via an external application.
2.2.6 Event Reporting for BNR Switching
The following details are taken from SY/DES/037
CNIM is responsible for controlling the switch between network types. On switch to a new
network type CNIM will raise an event. CNIM will include the following information
specifically within the event text:
e = The network type before the switch;
e The network type following the switch;
e The time and date the switch was attempted.
CNIM will raise an information event where the switch was successful and an error event
where the switch was not successful. A unique, to CNIM, event ID will be recorded against
the event allowing Tivoli to filter the events to be forwarded to the data centre.
The following additional information will be gleaned from the event itself:
© The time the event was raised and therefore the switch was complete, i.e. when the event
was written;
e The Gateway counter machine name, which includes the FAD code of the Branch.
CNIM is also responsible for testing the ISDN backup network connection at strategic
outlets once per week. The event raised to record a successful test will include the
information document above against the standard network type switch event plus the
following additional information / changes:
e The percentage of successful ping attempts made across the 10 minute test period.
A different event ID will be used to allow the event to be distinguished from events
relating to a switch required following a failure.
The events for this are shown in Appendix A3 - IDs 490 to 492
2.2.7 Eicon Card Configuration.
Design Overview: See section 5.3
CNIM is required to configure the Eicon card with the correct parameters, consistent with the
network type and connectivity required throughout the day. The network and connectivity
requirements are controlled by the Network Service Type for the outlet combined with a
generic Call Plan which is applicable to all outlets.
© 2006 Fujitsu Services Company in Confidence Page 31
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
The Eicon card is the network card connecting the Outlet Gateway to the Data Centres. The
network to which the card is connected may be either ISDN, Data or FRIACO. If ISDN it will
be a Dial on Demand connection and if Data it may be either a Dial on Demand or Fixed
connection. If the network type is FRIACO the connection type will be Fixed.
The Eicon card must be configured to suit the type of network to which it is connected and the
type of connectivity required.
The following Eicon card parameters will be configured by CNIM:
Parameter Description
Inbound Password CHAP Password expected from calling node.
Inbound User ID UID expected from calling node.
CHAP Interval Interval, in seconds, between CHAP authentication's
Shorthold Timer Length of time, in seconds, after the last received data
packet for which the line will be held open.
MCDT Minimum Call Duration Time
CPNI Called Party Number 1
CPN2 Called Party Number 2
CPN3 Called Party Number 3
CPN4 Called Party Number 4
Table 2 Eicon Card Timer Parameters
The Eicon card will contain a list of Inbound User IDs prior to CNIM installation. When CNIM
is first run it will add the Inbound User ID for the Data network, to the list. Thereafter no
further configuration of this parameter is required.
The Inbound Password differs between the ISDN and Data/FRIACO networks. Therefore one
password applies to ISDN and one to Data/FRIACO.
CNIM will extract the Inbound Password from the card when the service is installed. This is
unique to cach outlet and is stored in registry to be reapplied to the card should it be
reconfigured to use ISDN again.
CHAP Interval differs between ISDN and Data/FRIACO. One value is applied whilst on ISDN
and another whilst on Data/FRIACO.
In CNIM version 1, Shorthold Timer and MCDT are independent of network type and vary only
with the type of connectivity required. That is different values are used whilst at Dial on
Demand or at Fixed.
Called Party Numbers 1 to 4 are used to determine which number is dialled by the card.
Although it is possible for the card to move to the next number in this list in the event of
network unavailability, in practise this facility is disabled. Therefore the card will only ever use
the number configured in CPN1.
2.2.7.a Eicon Parameters - Numerical Values
In version 1 of CNIM the Eicon parameters are the values shown below in Table 3
© 2006 Fujitsu Services Company in Confidence Page 32
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Type Minimum Data Time Idle Time Minimum
(MCDT) (Short Hold Timer) I Call Length
Dial On Demand 6 3 9
Fixed 10 40 50
Table 3 Eicon Card Timer Parameters - Version 1
In version 2 of CNIM the Eicon parameters will be modified to the values shown in Table 4,
below, and have a dependency on network type.
Type Minimum Data Time Idle Time Minimum
(MCDT) (Short Hold Timer) I Call Length
ISDN voice 20 5 25
Metered Dialled 0 5 5
Fixed 10 40 50
Table 4 Eicon Card Timer Parameters - Version 2
In version 3 of CNIM the Eicon parameters will be modified to the values shown in Table 4,
below, and have a dependency on network type.
Type Minimum Data Time Idle Time Minimum
(MCDT) (Short Hold Timer) I Call Length
ISDN voice 20 5 25
Metered Dialled 0 5 5
Fixed 10 60 50
Table 5 Eicon Card Timer Parameters - Version 3
The CHAP parameters values shown in Table 6 are used to optimise network connectivity
whilst keeping line costs to a minimum.
Parameter ISDN Data/FRIACO
CHAP Interval 10 0
Inbound Password Supplied in Registry Supplied in Registry
Inbound User ID N/A Supplied in Registry
Table 6 Eicon Card CHAP Parameters
Configuration of the Called Party Number entries on the Eicon card are displayed in Table 7.
Under normal operation CNIM will run in Mode I and will configure the card with the Mode 1
Primary number as CPN1. CPN2-CPN4 will not be used in any mode
For a description of Run Mode see section 5.13.1
Parameter Description Run Mode 1 I Run Mode 2 I Run Mode 3
CPNI Called Party Number I Mode I Mode 2 Mode 3
Primary or Primary or __I Primary
© 2006 Fujitsu Services Company in Confidence Page 33
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Secondary Secondary
CPN2 Called Party Number 2 Not Used Not Used Mode 3
Secondary
CPN3 Called Party Number 3 Not Used Not Used Mode 3
Tertiary
CPN4 Called Party Number 4 Not Used Not Used Mode 3
Primary
Table 7 Eicon Card Called Party Numbers - CNIM Ver. 1
2.2.7.a.1_ Version 2 Run Mode.
For Version 2 of CNIM the run mode table above is amended to that shown in Table 8. In each
case it may be seen that only one number is configured on the card at any time.
Parameter Description Run Mode 1 I Run Mode 2 I Run Mode 3
CPNI Called Party Number I Mode I Mode 2 Mode 3
Primary Primary Primary
CPN2 Called Party Number 2 Not Used Not Used Not Used
CPN3 Called Party Number 3 Not Used Not Used Not Used
CPN4 Called Party Number 4 Not Used Not Used Not Used
Table 8 Eicon Card Called Party Numbers - CNIM Ver. 2.0
2.2.7.6 Network Service Types - Including ADSL
Design Overview: See section 5.4
Each PO outlet is assigned one of thirteen Service Types, which, used in conjunction with the
Call Plan, defines its connection type for each period of the day.
Service Type
Description
[1] Voi
24 hour Voice-On-Demand (VOD) connection to ISDN.
[2] Satellite
24 hour permanent (PC) connection
[3] Frame Relay
Frame Relay Fixed Connection
[4] Bronze
24 hour Metered-On-Demand (MOD) connection to establish an ISDN connection when an online
transaction occurs.
[5] Silver Part Time A (Metered)
During a few defined hours, the ISDN line is kept open to a metered-fixed (MF) number. Outside these
times a Metered-On-Demand (MOD) service is used, to the same metered number. The call plan specifies
these times.
[6] Silver Part Time B (Metered)
‘AS above but using different time periods as specified in the call plan.
[7] FRIACO Silver Daytime CI
During daytime hours the ISDN Tine is kept connected and open to an unmetered FRIACO number
(FRIACO-Fixed (FF), FE=FRIACO Establish). Outside these times a Metered-On-Demand (MOD)
service is used, (Circuit 1 connected). The specific hours are defined in the call plan.
© 2006 Fujitsu Services
Company in Confidence Page 34
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
[8] FRIACO Silver Daytime C2] As above but to different telephone numbers.
[9] Non FRIACO Silver Daytime I The same as (7 & 8) but in a geographic area not covered by FRIACO, hence these will be metered calls,
MOD or MF for periods defined in the call plan.
[10] FRIACO 24H CL The ISDN line is kept open 24 hours per day, altemating between MF and FF
(cireuit 1 connected)
[11] FRIACO 24HR C2 ‘As above but cireuit 2 connected.
[12] Non FRIACO Silver 24HR__I The ISDN line is kept open 24 hours per day using MF but in a geographic area not covered by FRIACO.
[13] ADSL 24 hour ADSL connection.
[14] ADSL with GSM 24 hour ADSL connection with GSM backup
Table 9 Network Service Types including Branch Resilient Network Types
The Service Type selected for cach PO outlet is determined by the availability of connections
(due to geography) and quantity/frequency of information that will need to be passed to/from
the datacentre.
2.2.7.c Call Plan
Design Overview: See section 5.6
The Call Plan specifies the connection type required for each Network Service Type for a
particular time of day.
2.2.7.c.1. Call Plan Input
The Call Plan will be supplied as a simple text file containing one table for cach Network
Service Type. See Appendix A1 for an example.
Each table will contain a set of days which in turn contain a set of elements with one element
covering a certain period of the day. Each element contains the connection type required for
each time of day.
CNIM will give an error if the required element is not present.
2.2.7.c.2 Call Plan Data Output
CNIM will extract the required table from the Call Plan as specified by the outlet type. CNIM
will write this table to a separate file so that a data check may be made manually.
This file will be written to the CNIM directory and named CP_Out.txt.
2.2.7.c.3 Call Plan Connection Configuration
At the start of each Call Plan period CNIM will ensure that the Eicon card is configured with
the correct parameters for the current connection type.
2.2.7.c.4 Call Plan File
The network call plan file (Call Plan) is a generic file in that the same file is distributed to all
Outlets (see example in Appendix A). It has the following naming convention:
CALL_PLAN _<yyyymmdd>_<hh-mm>.new
With the issue of a new Call Plan the previous is renamed by CNIM with the extension .old
© 2006 Fujitsu Services Company in Confidence Page 35
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
The Call Plan defines the connection type for each Service Type, by listing the day and time
period for cach method of connection (i.e. Metered-Fixed, MF; Voice-On-Demand, VOD etc).
Each method of connection has a different cost associated to it. By having twelve different
Service Types to assign to the PO outlets, the allocation of connection resources is made cost-
effective.
The Call Plan lists these Service Types, specifying the method of connection, which will occur
for a particular day of the week and time period. In the example below the Service Type is [9]
Non FRIACO Silver Daytime and its Connection Type for Monday between 00:00 and 08:00 is
Metered-On-Demand (MOD):
19]
;Non FRIACO Silver Daytime
DefaultConnType = MOD
Day= Monday
Period= 00:00-08:00, 08:00-17:30, 17:30-24:00
ConnType= MOD, MF, MOD
Day= Tuesday
Period= 00:00-08:00, 08:00-17:30, 17:30-24:00
ConnType= MOD, MF, MOD
Note that as from BNR at S92 additional service types that will incorporate GSM backup, these will have the
names MFG, MODG etc.
2.2.7.¢.5 Randomisation of Connection and Disconnection
The initial connection time and shutdown of a connection specified in the Call Plan is not exact.
It has to be randomised over +15 minutes of the times listed to prevent the outlets from
attempting to connect or trying to drop connections to the data centre at once. The exact offset
to be used is set up in Registry : [HKEY_LOCAL_MACHINE\SOFTWARE\ICL\Pathway
Configuration\CNIM\Live]:
Name Offset Description
OFFSET_FE_FF "15" Maximum offset of boundary in minutes between
FRIACO-Establish and FRIACO-Fixed.
OFFSET_FE_MOD I "10" Maximum offset of boundary in minutes between
FRIACO-Establish and Metered-On-Demand.
In version 2 this has been reduced to 10
minutes from 15 minutes.
OFFSET_FF_MF "1s" Maximum offset of boundary in minutes between
FRIACO-Fixed and Metered-Fixed.
OFFSET_FF_MOD I "10" Maximum offset of boundary in minutes between
FRIACO-Fixed and Metered-On-Demand.
In version 2 this has been reduced to 10
minutes from 15 minutes.
OFFSET_MF_FF "15" Maximum offset of boundary in minutes between
Metered-Fixed and FRIACO-Fixed.
OFFSET_MF_MOD I "10" Maximum offset of boundary in minutes between
Metered-Fixed and Metered-On-Demand.
© 2006 Fujitsu Services Company in Confidence Page 36
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
In version 2 this has been reduced to 10
minutes from 15 minutes.
OFFSET_MOD_FE I "15" Maximum offset of boundary in minutes between
Metered-Fixed and FRIACO-Fixed.
OFFSET_MOD_MF I "-15" Maximum offset of boundary in minutes between
Metered-On-Demand and Metered-Fixed.
Table 10 Call Plan Offsets — ISDN/Data/FRIACO
The offset values above are then used within CCallPlan class for each type of connection change
to calculate the random point at which the connection will change. For example when changing
from Metered-On-Demand to Metered-Fixed, the appropriate Registry item, in this case
OFFSET_MOD_MF, is read which is “-15”. The function GlobGetRandomVal takes 0 as it minimum
value and —15 as the maximum value and generates a random number between the two. The
number is then added to the change-over time defined in the Call Plan.
°.5.1 ADSL Offsets
Name Offset Description
OFFSET_AE_AF "10" Maximum offset of boundary in minutes between
ADSL-Establish and ADSL-Fixed.
OFFSET_AF_AE "lo" Maximum offset of boundary in minutes between
ADSL-Fixed and ADSL-Establish.
OFFSET_RIT "160" Maximum offset of boundary in minutes between
ADSL-Establish and RIT (RAS ISDN Test)
Table 11 Call Plan Offsets - ADSL.
2.2.7.d Line Test Overview
Design Overview: See section 5.12
In the event of line failure a balance must be struck between attempting to recover the situation
quickly whilst not overloading the network with call attempts.
The test strategy required of CNIM needs to incorporate the following factors:
1) Method for Determining comms failure
2) Method of recovering from a network failure
3) Minimisation of call attempts during network testing and provision of a "back-off" facility in
which CNIM will reduce the frequency of line testing under conditions of persistent line
failure.
4) Provision of a default fail state if communication cannot be re-established immediately.
5) Provision of a "Failure Mode" status value which can be returned to the Counter Call
Scheduler.
2.2.7.d.1 Determination of Communication Failure
The following methods will be used to determine if a network failure has occurred.
1) ISDN/Data Network: Examination of the Cause Code returned by the network following
call closure.
© 2006 Fujitsu Services Company in Confidence Page 37
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
2) ADSL Network: Examination of the network status written to registry by Connection
Manager.
3) All Networks: Attempt to ping any well known Data Centre node (VPN Server or
Correspondence Server) with which the outlet is configured to communicate.
2.2.7.d.1.1 Cause Code Description
Cause Codes are returned to the Eicon card, by the network, on call closure and are a numeric
indication of the reason for the call closure. CNIM may interrogate the card to determine the
last cause code received from the network.
A reference table of possible cause codes is shown in Appendix A4.
Certain cause codes are used to indicate a successful call whilst others indicate that the call
closed due to a network problem.
See 5.9 for a design overview of failure code handling.
2.2.7.d.1.2 Ping Failure
Each outlet is configured to communicate with four Correspondence Servers via eight VPN
servers located at either of the Data Centres. The IP addresses of the VPN servers are specified
in the SGVPN.INI file found in the WinNT directory of the Gateway PC.
A complete description of the VPN solution may be found in [Ref 9].
CNIM is required to ping a configurable sequence of servers in order to determine whether it
has comms to the data centre. If no server returns the ping then comms are assumed to have
failed
Pings should be spaced such as to allow the greatest chance of success and the time between
pings will be configurable. The ping sequence and number of times the sequence is traversed
will be configurable. Only when the full sequence has been traversed the appropriate number of
times with no reply, will the test be taken as having failed.
2.2.7.d.1.3 Changes for ADSL
For ADSL the method of diagnosing network failure will switch from querying the Eicon card
for a CauseCode, to using the network status values returned by Connection Manager. CNIM
will retain the option to query ADSL Diagnostic Monitor for more low level status information
from the Conexant ADSL modem.
2.2.7.d.2_ Run Mode Description
For the purposes of comms testing CNIM is considered to run in one of three modes, namely
Modes 1, 2 or 3. These modes are used to logically link the degree of communication failure
with the phone numbers available to CNIM. For a detailed description of Run Mode see section
5.13.1.
2.2.7.d.3. Failure Mode Description
Failure mode is also known as the Connection Status and will vary from Connected/
Disconnected to First Failure, Temporary Failure and Permanent Failure.
For a detailed description of Failure Mode see Table 106.
© 2006 Fujitsu Services Company in Confidence Page 38
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
2.2.7.d.4 Test Requirements
1) On service startup CNIM will attempt to configure the Eicon Card with a working number.
2) During Nailed Up periods CNIM will use each Keep Alive ping reply to determine that
comms are available.
3) During non Nailed Up periods CNIM may, depending on connection type, do a Line Test
each time the line is brought up by an external means such as Riposte sending data.
4) Should CNIM detect that any ping test has failed it will enter a test mode as described in the
test sequence diagrams below. See section 2.2.7.d.4.2
2.2.7.d.4.1 Wait Times for Call Closure
During line testing or at the start of a new call plan period, CNIM will be required to
reconfigure the Eicon card. If the line is active at this point then CNIM is required to wait for a
specified period. If the line becomes inactive during that time then CNIM will be notified and
will reconfigure the card. At the end of that time period CNIM will reconfigure the card in any
event. The wait time is dependent on the connection type that was in use when the call started
and there are three types of connection to consider.
1) Establish period for silver nominated Outlets, prior to fixed period.
2) Fixed period for silver nominated Outlets, where the Outlet maintains connection with the
Data Centre for the specified time period (as per Call Plan).
3) Dialled period for Silver and Bronze Outlets during “Dial on Demand”.
If a call is in progress there is a wait of ‘n’ seconds for the call to close, as per Table 12. If the
call is still in progress after the specified period, then the call is dropped. On the dialled period
entry in the table, a period of 2 hours is specified to allow for any software distribution that may
be in progress.
Connection Type Mode 3 Mode 1, Mode 2
MOD, VOD 60 seconds 2 hours
FF, MF 120 seconds I 60 seconds
FE 120 Seconds I 60 seconds
Table 12 Wait times for call closures
2.2.7.d.4.2: Behaviour on Failure - Version 2
CNIM has three sets of telephone numbers, it uses; Primary, Secondary, and Tertiary Numbers.
In Primary and Secondary Network banking is allowed, whereas in Tertiary it is not. Primary
mode is normal running, secondary mode is fall back telephone phone number, and is
temporary. If in secondary mode after a period of time, CNIM will retry the primary mode.
The behaviour is detailed in the three flowcharts, where
Figure 3 — FRIACO Establish Period
Figure 4 — Fixed Period
Figure 5 — Dialled Period
© 2006 Fujitsu Services Company in Confidence Page 39
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
CNIM will require test sequences for Voice on Demand (ISDN) outlets and Satellite outlets. In
addition sequences will be required for Dial Back periods and for doing the "Normal" test. In
effect every step of the CNIM test behaviour is controlled. Because of this every permutation of
test sequence must be designed and tested.
Test - Ping the VPN servers using the number currently set in the Eicon card.
Call Okay - No ISDN failure code and “ping” process okay.
Call Fail - An ISDN failure code or “ping” process failure
All the parameters are held in Registry, so they can be modified if necessary at a later date.
On the “Period” flow diagrams each box is numbered, i.e. on the “Establish Period” diagram the
boxes are numbered E1 to E13, “Fixed Period” diagram F1 to F13, and on the “Dialled Period”
diagram D1 to D15. Tracing will be used to monitor the paths through the routines by capturing
these box number sequences. This will be of particular importance during the testing phase
where routes will be defined (via expected box sequence numbers), through the routines, thus
ensuring all paths are exercised and proven. In addition the trace file will contain which “ping”
in the sequence has worked, in order to give some indication as to the quality of the network at
the time. An extra field will be added to the monitor record, which records the time taken for
the ping. This will give us an indication as to which ping reached the destination, i.e. if the
Energis CVX switched from the primary LNS to the associated secondary LNS router, this will
have taken longer.
It should be noted that additional detail is required, over and above that shown in the following
diagrams. The additional steps are given in the section describing the CNIM Programming
Language (CPL) operations for each test sequence, later in this document. These diagrams will
be updated to reflect the additional step.
© 2006 Fujitsu Services Company in Confidence Page 40
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
2.2.7.d.4.3 Testing During Establish Periods
Figure 3 shows the test sequence required on entry to a FRIACO Establish period.
Establish Periods
Entry Point From All Periods
—— >I Wait 0 to 15 Minutes Randomised
eek Start / Clean State
Set Primary (No Test)
¥
£22 Primary Call Held Open
Call Ok
Call Fail
a Ee
Set and Test Primary Wait 5 to 15 Minutes Randomised
10 Minute Randomise on Close
No Calls / All
Otay Non CNIM
Call Fails
ER [Secondary set)
Non CNIM Call Ok
Wait 10 to 40 Minutes randomised
Cat Fait
E16 Set and Test Secondary
Call Ok
EIT
Wait 7.5 to 22.5 Minute randomised
Non CNIM Call Ok
No Call / All Failed
HS Set and Test Primary
Call Ok
Call Fail
FI? Set Tertiary (No Test)
Wait 15 Minutes
#2) Set and Test Secondary
Call Ok
Set Tertiary (No Test)
Wait 15 Minutes Date: 28-01-2003,
T version 2.0
© 2006 Fujitsu Services
Company in Confidence Page 41
Fujitsu
Services
FUJ00171956
FUJ00171956
CNIM Low Level Design Ref: RS/LLD/004
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
2.2.7.d.4.4. Testing During Fixed Periods
Figure 4 shows the test sequence required on entry to a FRIACO Fixed or Metered Fixed
period.
Fixed Periods Fu Start / Clean State
————— Set Primary (No Test)
Enity Point from All Other Periods ———%I Wait 0 to 15 Minutes Randomised
¥v
Entry Point From Establish State E2 [Fa ‘
n Primary Call Held Open I_
10 Minute Randomised on close
Call Ok
Call Ok
Call Fail Call Fail
Set and Test Primary
Call Okay
Call Fails
22 [Secondary set]
Hold Call Open for 5 to 15 Minut
randomised
16 Set and Test Secondary
No Call / All Failed
¥I8 Set and Test Primary
Call Ok
Call Fait
FI? Set Tertiary (No Test)
Wait 15 Minutes
°° Set and Test Secondary
Call Ok
Pl Set Tertiary (No Test)
Wait 15 Minutes Date: 28-01-2003
T version 2.0
Figure 4 Testing During Fixed Periods
© 2006 Fujitsu Services Company in Confidence Page 42
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
2.2.7.d.4.5 Testing During Dialled Periods
The following diagram applies to Metered Dialled, DialAround and Voice on Demand periods.
Dialled Periods
Re Start ~<———— Entry Point from All other Period:
Set Primary (No Test) “ :
Clean State
oe {Leave Primary Set} D4 Set and Test Primary
Wait 5 to 15 Minutes Randomised
Call Ok
No Call / All Failed Call Fail
P25 Set Secondary (No Test)
Call Ok
P20 [Secondary Okay / Primary Failed] IqI
Wait 30 to 90 Minutes Randomised
Call Failed
DIS Set Primary (No Test)
‘Wait 7.5 to 22.5 Minute randomised
Non CNIM Call wk. No Calls
All Failed
Set and Test Secondary
No Calls / All Ok}
Non CNIM Call Fail
Pa [Leave Secondary Set]
Wait 5 to 15 Minutes Randomised
Non CNIM Call xX >
No Call / All Failed
2 Set and Test Primary
Call Ok
Dis
PIT Set Tertiary (No Test)
Wait 15 Minutes
DIS Set and Test Primary
Call Of
Call Fail
P23 Set Secondary (No Test)
Wait 7.5 to 22.5 Minute randomised
Set Tertiary (No Test) No Calls Cw CNIM Call Ok
Wait 15 Minutes
Date: 28-01-2003
All Calls Failed. I srsion 2.0
Figure 5 Testing During Dialled Period
DD
Measurement of call success differs between dialled data calls and dialled voice calls.
© 2006 Fujitsu Services Company in Confidence Page 43
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
During the quiescent states, such as D3, a phone number is set on the Eicon card but not
proactively tested. When the line is activated by some external application such as Riposte then
CNIM must determine if the call succeeded. In the case of a metered or dialaround call this is
done by pinging one or more VPN servers and waiting for a response. In the case of an ISDN
call the cause code returned at call closure is used as the measure of call success.
2.2.7.4.4.6 Test Sequence -VSAT - Permanent Connection
The Permanent Connection type applies only to Satellite outlets. CNIM will do a test ping every
15 minutes. The response to the test ping determines whether a call is considered to be open or
closed.
If the PASS/FAIL flag is set to fail then the current call is recorded as closed with a FAIL
closure marker. CNIM will continue to ping at 15 minute intervals. If a ping succeeds and the
current call state is closed then a monitor record is opened to indicate the start of a new call.
Y
Pot
Do a Test Ping y
Set PASS/FAIL Flag Po2
Await Test Timer
POS
Set 15 minute Test Timer
Figure 6 Test Sequence - VSAT
2.2.7.d.4.7 Test Sequence - ADSL
The ADSL Establish and ADSL Fixed connection types are tested using the same test sequence,
shown below.
Test failure occurs when all the pings in the test ping sequence fail to produce a response.
If ping failure occurs during bandwidth testing then CNIM will move to a test ping sequence
which will initiate the permanent failure timer should all pings fail.
© 2006 Fujitsu Services Company in Confidence Page 44
Fujitsu
Services
CNIM Low Level Design
COMPANY IN CONFIDENCE
FUJ00171956
FUJ00171956
Ref: RS/LLD/004
Version: 4.0
Date: 8/05/2006
Att
Do a Test Ping
Set PASSIFAIL Flag
A12
Do Bandwidth Ping
A13 © Ping Pass No
Await Test Time . 7
I AIS
Yes Do Test Ping
A14
Set N minute Test Timer <
Figure 7 Test Sequence - ADSL.
© 2006 Fujitsu Services Company in Confidence
Page 45
Fujitsu CNIM Low Level Design
Services
COMPANY IN CONFIDENCE
FUJ00171956
FUJ00171956
Ref: RS/LLD/004
Version: 4.0
Date: 8/05/2006
2.2.7.4.1.8 Failure Flag State
In addition to the “Period” flow diagrams there are triggers, which initiate the processes, this is
best illustrated by Figure 8, where the “Fail Flag” is indicating OK, Temporary Fail or
Permanent Fail, dependent on where it is within the cycle. The process is triggered by Timer
Events. As a function of the failure flag state mechanism CNIM updates the Counter Call
Scheduler (CCS) on transition between states. The CCS update refreshes the cause code
information with the latest returned from the Eicon card. In the absence of an Eicon cause code,
CNIM will substitute its own defined code (i.e. ping failure).
Event:
Reset
Call OK
Call OK
Permanent
Fail
Temp Fail
Call Failed
or Ping process fails
Note:
=== Set Timer (reset) ote:
such pings fail
fees Clear Timer
Call OK:
= ISDN call to primary or Secondary
number succeeds and Ping process
succeeds
Event:
Timer Fires Call Failed:
ISDN call to primary or Secondary failed
or call Dropped in progress (during fixed period)
The Ping process will attempt multiple pings to
more than one IP address. It will Fail only if all
Date: 25-01-2003
version 1.0
Figure 8 Fail Flag State Mechanism
© 2006 Fujitsu Services Company in Confidence
Page 46
Fujitsu
Services
CNIM Low Level Design
COMPANY IN CONFIDENCE
FUJ00171956
FUJ00171956
Ref: RS/LLD/004
Version: 4.0
Date:
8/05/2006
2.2.7.e Line Connectivity
Under present (Pre BI3) operation the ISDN connection between the outlet Gateway and the
Data Centre will drop, once data has ceased to flow, due to timeouts configured within the
Eicon card on the Gateway PC.
Post BI3, Pathway is required to satisfy the service level agreements required for Network
Banking. In particular the speed at which banking transactions can be processed is of
importance. Therefore at certain times of day and for certain outlets, CNIM must eliminate the
call setup time for each transaction and this will be done by keeping the line active.
Not all outlets require this degree of connectivity and so each outlet will be assigned a Network
Service Type (NST). The NST defines the overall level of connectivity for the outlet and is held
as one of a number of Tables within the generic Call Plan. The Call Plan, which is supplied to all
outlets, defines the types of connectivity required for all Service Types throughout the day.
The types of connectivity to be made available by CNIM are defined in Table 13.
Name Short Name Network Type Connection Type
Permanent Connection I PC Satellite Continuous
Voice On Demand VOD ISDN Discontinuous
Voice On Demand I VODG ISDN with GSM I Discontinuous
(GSM) backup
Metered On Demand MOD Data Discontinuous
Metered On Demand I MODG Data with GSM I Discontinuous
(GSM) backup
Metered Fixed MF Data Continuous
Metered Fixed MFG Data with GSM I Continuous
backup
FRIACO Establish FE FRIACO Continuous if possible
FRIACO Fixed FF FRIACO Continuous
FRIACO Fixed(GSM) I FFG FRIACO — with I Continuous
GSM backup
ADSL Establish RA ADSL Continuous
ADSL Fixed(GSM) RAG ADSL with I Continuous
GSM backup
ADSL Fixed(ISDN +] RAIG ADSL with I Continuous
GSM) ISDN and GSM
backup
ISDN Test RIT Test of ISDN I Continuous
backup
Frame Relay FRE Frame Relay I Continuous
Establish
Frame Relay FRF Frame Relay I Continuous
Fixed
© 2006 Fujitsu Services
Company in Confidence
Page 47
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Table 13 Connection Types
2.2.8 CDF Data Storage Requirement
Design Overview: See section 5.5
CDF requirements are explained in [Ref 8] and repeated below:
2.2.8.a CDF Content
The CDF (CommsData File) is produced for ISDN Gateway PCs only. The primary content is
to deliver the ISDN access numbers to the CNIM and additionally deliver the CHAP usernames
and optional ISDN line parameters for installation by EiconConfig. Its content is as follows:
Pathway CDP
2 PAD: <fad_id>
: Node <>
: Date: Aug 5 1999 11:29AM.
SACDB: <xyz>
[Version]
Signature="$Windows NTS"
[Defaultinstall]
AddReg=NCiz
[FileFormat]
Type=CDE
[NCE]
HKLM,%NI%,VP.,<primary_isdn_rtr_phone_no>
HKLM,%NI secondary_ isdn_rtr_phone_no>
HKLM,%NI%,VT,,<tertiary_ isdn_rtr_phone_no>
HKLM,%NI%,FCIP,,<C1_Primary Friaco_no >
HKLM,%NI%,FC2P,,<C2_Primary Friaco_no>
HKLM,%NI%,FCIS,,<C1_SecondaryFriaco_no>
HKLM, %NI%,FC2S,,<C2_Secondary Friaco_no>
HKLM,%NI%,MP,,<Primary Metered_no>
HKLM,%NI%,MS,,<Secondary Metered_no>
HKLM,%NI%,DP,,<Primary Metered Dial-around_no>
HKLM,%NI%,DS,,<Secondary Metered Dial-around_no>
[EICON_config]
UID1%","%U1D2%","%UID3%"
‘own_isdn_chap_name>
Optional
Optional
DSAlist= Optional
SUB= Optional
[Strings]
NIFSOFTWARE\ICL\Pathway Configuration\Eicon
rimary_rtr_chap_name >
‘ondary_rtr_chap_name>
(ertiary_rtr_chap_name>
Note that the registry key pathname for the storage of the data values is set to:
© 2006 Fujitsu Services Company in Confidence Page 48
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
2.2.8.6 CDF - Network Configuration (for CNIM access numbers)
The Network Configuration section [Ncfg] above, is set up to meet the delivery requirements
for the Data Centre Router Access numbers to be dialled by the Eicon ISDN card under the
control of the CNIM.
For Mobile outlets, all Data Network numbers (FP”, FS, MP, MS, DP and DS) will be null.
The Primary, Secondary and Tertiary numbers will be no different from the values used prior to
BI3. Hull outlets use 0800 backup numbers over the Voice network.
Number Type Description
VP Voice Primary
vs Voice Secondary
VT Voice Tertiary
MP Metered Primary
MS Metered Secondary
DP Dial Around Primary
DS Dial Around Secondary
FCIP FRIACO Primary (Geographical Area 1)
FCIS FRIACO Secondary (Geographical Area 1)
FC2P FRIACO Primary (Geographical Area2)
FC2S FRIACO Secondary (Geographical Area 2)
Table 14 Number Types and Descriptions
2.2.8.¢ Phone Number Mapping
Phone numbers from the table above are mapped onto the Eicon card depending on the
connection type required.
For a detailed description see section 5.13.1.
2.2.9 Call Logging Requirement
Design Overview: See section 5.7
2.2.9.a Monitor Record
The CNIM Call Monitor record is specified in [NB_SOD] - see [Ref 3], which defines the
Quality of Service reporting requirements. The CNIM Call Monitor receives information from
the Eicon ISDN Driver Interface (IDI) when an event occurs. The events that are monitored are
defined in the CNIM initialisation process. The events monitored relate to calls to and from the
Data Centres and the status of these events. Information relating to each call initiated at the
Outlet or received from the Data Centre is recorded in either ‘In-Files’ or ‘Out-Files’. These
daily files are generated for each connection type that the Outlet may invoke. Thus if an Outlet
is deemed to be a silver Outlet, files will be generated for the FRIACO telephone number, the
Dial-around telephone number, (metered call number). Within these files each individual record
relates to a single call whether received or sent. Each record when complete provides the
© 2006 Fujitsu Services Company in Confidence Page 49
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
history of that call. New files are created each day, with the extension of .new and files from the
previous day are renamed with an extension of .old
Note that CNIM will only generate monitor files for the current day, regardless of the call state
on service startup.
2.2.9.a.1 Record Format and Description
The monitor record will include the following information:
Date of call
Start time of call
End time of call
Length of call
Direction of call (IN/ OUT)
Phone number dialed
Network Service Type
Call status (SUCCESS/ FAIL/ OPEN/ UNKNOWN)
Ping Roundtrip Time
Failure code
2.2.9.a.1.1 Monitor Record Format - CNIM Version 2
The information held in the monitor record is designed to capture call information at ISDN
based outlets. There are around 250 Satellite outlets that must also be included within network
quality of service reporting. The low volume of outlets does not justify developing a separate
record structure; therefore information gathered at Satellite outlets will be massaged into the
above structure. The CNIM will write a monitor record if it determines a Satellite connection
has failed. This record will record the call as having failed and will include a failure code specific
to satellite outlets, ie. not one of the cause codes that can be returned by a network supplier.
In the situation where a ‘call’ can be permanently connected, for example at satellite and 24 hour
outlets, the CNIM will write a closure record shortly after midnight, ensuring a record of all
calls made within a day are included in reports returned to data centre within a reasonable
timeframe.
2.2.9.a.1.2 Monitor Record Format - CNIM Version 3
Details of the change in Monitor File format are given in section 2.2.9.a.5.
2.2.9.a.2 Initial Record Format
When a record is first created certain data will be unavailable such as call duration and the Call
Status value. A record of the format shown below will be created.
28/10/2002, 15:24:55:853, 00:00:00:000, 0000000000, OUT, 01344868735, 07, DP, OPEN, 0000
It may be seen that the end time and duration are set to null whilst the Call Status is set to
OPEN. The cause code is set to our own code of 0000.
2.2.9.a.3 Final Record Format
© 2006 Fujitsu Services Company in Confidence Page 50
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
When the call is closed a record of the format shown below, will be produced.
28/10/2002, 15:24:55:853, 15:24:59:853, 0000004000, OUT, 01344868735, 07, DP, SUCCESS, 00
The end time, duration and Success/Fail details are added.
However it is possible that CNIM will not receive an indication that the call has closed, either
due to a failure of the IDI interface or if the CNIM service is stopped and restarted. In these
cases it is important that any OPEN record is changed to have the success code UNKNOWN
(Code 0x0100, appearing in the monitor record as 0100). This will allow the CASNetworkQOS
application to correctly parse the file.
If CNIM crashes during a call and is not restarted until the next day then that last call will be left
as OPEN. Ifa call is left as OPEN over midnight then there should be a corresponding record in
the next days monitor file when the call was closed. If this corresponding record in the next file
does not exist, then the call must have failed and must be changed to UNKNOWN in the
previous file. The next day’s record will not be written until the previous days file has been
renamed. At service startup if a file exists as new from a previous day, then none of its records
should be OPEN. Any OPEN records should be changed to UNKNOWN.
Also at service start up and assuming the service has previously been run that day, then looking
in today’s NEW file, none of its records should be OPEN either.
Therefore on service startup any .new monitor files should have any OPEN records changed to
UNKNOWN and the files then renamed to .old as appropriate.
2.2.9.a.4 Changes for Version 2
An extra field will be added to the monitor record, which records the time taken for the ping.
This will give us an indication as to which ping reached the destination, i.c. if the Energis CVX
switched from the primary LNS to the associated secondary LNS router, this will have taken
longer.
2.2.9.a.5 Monitor Record Format for ADSL
The following details are taken from [Ref 14]
1) There is no concept of an inbound call (call initiated from the data centre) with an ADSL
network; therefore all calls will be recorded as out-bound.
2) The length of the call measured in milliseconds — where a connection is not successful this
field will contain a zero value. Due to the naturally long calls expected at ADSL outlets the
length of call field will record only the time that the call was open on the day indicated in the
filename. Where a call crosses many days a record for the call will be included in each call
monitor file that the call was open for. In each record the length of call field will record just
the time the call was open within the day. Note this change will apply to all network service
types.
3) Dialled number will be the RAS phone book entry used for the call.
4) An error code indicating the reason why the call failed, or zero if the call was successful.
Within this code is should possible to identify those calls which failed to connect as opposed
to those calls where connection is successful however the call dropped at some point later.
Only those calls deliberately closed, closed due to gateway shutdown, or closed at midnight
will be recorded with a zero success code.
© 2006 Fujitsu Services Company in Confidence Page 51
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
5) CNIM will use its registry interface with Connection Manager to determine the connection
state and reason for failure.
6) At midnight when CNIM switches to a new monitor file it will not close a call record, rather
leave the last call record indicating the call is open, with the start date /time, and length of
call field set to record the milliseconds the call was open on that day. The I* entry in the
new summary file will be a copy of the last record in the file just closed (initially with the
length of call field blank, to be populated once the call is closed or at midnight) — this will
maintain the call start date / time. When the call does close the last file will have a complete
record of the call start / stop time. The duration will include the length of time the call was
open today.
7) At midnight when CNIM switches to a new monitor file it will not close a call record, rather
leave the last call record indicating the call is open, with the start date /time, and length of
call field set to record the milliseconds the call was open on that day. The I* entry in the
new monitor file will be a copy of the last record in the file just closed (initially with the
length of call field blank, to be populated once the call is closed or at midnight) — this will
maintain the call start date / time. When the call does close the last file will have a complete
record of the call start / stop time. The duration will include the length of time the call was
open today.
Field ADSL? Meaning
Date of call Yes
Start time of call Yes In normal circumstances this will be artificially set
to 00:00. ADSL call will normally be always
connected, in order to provide daily feedback on
the availability of the ADSL network CNIM will
close the call record at midnight and reopen a new
one.
End time of call Yes In normal circumstances this will be artificially set
to 00:00. ADSL call will normally be always
connected, in order to provide daily feedback on
the availability of the ADSL network CNIM will
close the call record at midnight and reopen a new
one.
Length of call Yes The length of the call in milliseconds for that day.
Where a call spans midnight each part of the call is
recorded in a record for that day.
Direction of call No There is no concept of an inbound call (call from
the data centre) with an ADSL network; therefore
all calls will be recorded as out-bound.
Called number Yes ADSL has no concept of a called number, however
it does have a data centre specific user/domain
name _used to login to the radius servers. The
© 2006 Fujitsu Services Company in Confidence Page 52
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
called number field will record the RAS phonebook
entry.
Network Service type Yes Set to the service type for ADSL which is 13 or 14.
Network connection type I Yes All ADSL calls will have a connection type of
ADSL.
Call status (success / fail / I Yes Reject calls are only applicable to inbound calls
reject) which are not possible on an ADSL network. The
call status will be either success or fail.
Failure code Yes An error code indicating the reason why the call
failed, or zero if the call was successful. Within this
code is should possible to identify those calls which
failed to connect as opposed to those calls where
connection is successful however the call dropped
at some point later. Only those calls deliberately
closed, closed due to gateway shutdown, or closed
at midnight will be recorded with a zero success
code.
Table 15 Monitor Record Format for ADSL
Note that the final field of "Ping Return Time", incorporated for CNIM 2, has been
removed from the monitor record.
2.2.9.a.6 Monitor Record Format for ISDN and GSM over RAS
The Branch Resilient Network requires that calls may be made over ISDN or GSM
during network failure. RAS ISDN calls may be made from an ADSL outlet whilst RAS
GSM calls may be made from an ADSL or ISDN outlet.
These calls would be made using RAS and the appropriate phonebook entry.
The table below shows the monitor file format for these calls.
Direction of call No Inbound calls will not be allowed when using RAS,
therefore all calls will be recorded as out-bound.
Called number Yes RAS has no concept of a called number, however it
does have a data centre specific user/domain name
used to login to the radius servers. The called number
field will record the phonebook entry.
Network Service type Yes Set to the service type for that outlet.
Network connection type I Yes All RAS ISDN calls will have a connection type of
ISDN.
All RAS GSM calls will have a connection type of
GSM
Table 16 Monitor Record Format for ISDN and GSM
© 2006 Fujitsu Services Company in Confidence Page 53
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
2.2.9.a.7 File Name Format
The file names have the following naming convention, where the <fad code> is the six digit
unique Outlet identifier, and <ct> is the connection type as defined in the CDF, which will be
one of the following VP, VS, VT, FCIP, FC2P, FC1S, FC2S, MP, MS, DP, or DS.
From CNIM 3 onwards, the connection type will include the types ADSL for normal ADSL
running and MODM when running using the PSTN modem at Day D. For more detail on DayD
operation see [Ref 15].
At CNIM 4 for Branch Resilient Network operation the connection types will include the types
ISDN for ISDN over RAS and GSM for GSM over RAS.
QOS_MON_I_<fad code>_<yyyymmdd>_<ct>.new — (In-bound files)
Or
QOS_MON_O_<fad code>_<yyyymmdd>_<ct>.new (Out-bound files)
2.2.9.a.8 Monitor File Creation and Renaming
A monitor file will be created when a connection of a particular type is first made. Thereafter
the same file will be used for all connections of that type, until midnight (GMT) when the file
will be renamed to <FILENAME>.old.
2.2.9.a.9 Call Monitoring for Satellite connected Outlets
In the case of satellite connected outlets, CNIM will still be in operation, however the
information in the file, will in the majority of cases, be a single record, unless the satellite
connection is lost for any reason. The reason for satellite connection fails is not easily
determined without analysis of the Personal Earth Station (PES), which is beyond the scope of
CNIM. If the satellite connection fails the current record closed with a fail entry in the Call
Status field. On the link being re-established a new record will be appended to the file. If at
Midnight the current record is still open then this will be closed as a successful record.
2.2.9.a.10 Call Monitoring for ADSL connected Outlets
On ADSL outlets CNIM will carry out regular bandwidth pings to determine current
bandwidth. Failure of the bandwidth ping will trigger a sequence of test pings which
may trigger use of the permanent failure timer if all pings fail.
CNIM will receive notification from Connection Manager as to changes in line state
and will use this information to update monitor records as appropriate.
2.2.9.6 Summary Record
This requirement is specified in [NB_SOD].
This record provides a summary of the network quality of service achieved during a defined
period of the day. The record will include the following information:
e Start date / time in UTC time of QOS period;
e Length of time covered in seconds;
© 2006 Fujitsu Services Company in Confidence Page 54
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
e The defined Service type for the outlet (one of those listed in TD/SOD/006);
e FRIACO seconds connected (zero for non FRIACO outlets);
e Metered seconds connected;
¢ Number of metered calls made;
The primary purpose of the QOS record is to, for FRIACO connected outlets, input into a
centrally generated report recording the levels of congestion the network is subject to. In
situations where FRIACO congestion exceeds a defined value on a particular day that’s days
service availability is removed from any penalty calculations. Only those hours within the core
POCL day should be included therefore the QOS record will include the hours of 8 am until
5:30 PM on weekdays and 8 am until 13:00 on Saturday. On Sunday no FRIACO network is
available therefore a zero value record will be written:
Start Date I Start I Total Defined FRIACO I Metered Metered
Time I Time Service Type Time Time Call Count
ddmm/yyyy I 24hr Seconds O1-12 Seconds Seconds I No. of metered
calls
Table 17 Format of Summary Record
Where:
Start Date - is the start date of the monitoring of the form dd/mm/yyyy
Start Time - is the start time of the monitoring of the form hh:mm:ss
Total Time - is the total FRIACO Fixed time if the Call Plan includes FRIACO Fixed for that
day. If no FRIACO Fixed is used that day then Metered Fixed time is used if available. If neither
Metered Fixed nor FRIACO Fixed is available then the total length of the day is given.
Defined Service Type - indicates the Network Service Type as per table.
© 2006 Fujitsu Services Company in Confidence Page 55
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Servic
Meaning
Voice (mobile)
Satellite
03 Frame Relay
I 04 I Bronze (Metered dial on demand)
05 Metered ‘nailed-up’ (Silver part time A)
06 Metered ‘nailed-up’ (Silver part time B)
07 FRIACO ‘nailed-up’ (Silver Daytime) (C1)
08 FRIACO ‘nailed-up’ (Silver Daytime) (C2)
09 Non-FRIACO (Metered) ‘nailed-up’ (Silver Daytime)
10 I FRIACO 24hour (Silver) (C1)
11 FRIACO 24hour (Silver) (C2)
12 Non-FRIACO (Metered) 24hour (Silver)
13 ADSL
14 I ADSL with ISDN automatic backup (S92 BNR)
FRIACO Time - is the total connected time in seconds during the ‘nailed up’ period for
FRIACO.
Metered Time - is the total connected time in seconds during the ‘nailed up’ period for Metered
access when the FRIACO service has failed for whatever reason, otherwise
zero.
Metered Call Count - is the number of metered calls made during the ‘nailed up’ period when
the FRIACO service has failed for whatever reason, otherwise zero.
For example:
24/10/2001, 14:23:56:382, 1523672, 7, 987654, 536018, 3
Notes:
e Fields are separated by ,space
¢ File are created with an extension of .new
e Riposte Nail Up occurs when the connection type is FRIACO Fixed, Metered Fixed,
Permanent Connection or ADSL Fixed and no ping failure has occurred.
File from previous day are renamed with an extension .old
The QOS record will also be written at outlets that do not make use of the FRIACO network.
Outlets which do not used the FRIACO network will write a QOS record to cover any period
where the ISDN line is nailed up, or in the case where there is no nail up period then the whole
© 2006 Fujitsu Services Company in Confidence Page 56
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
day will be recorded in the QOS record. Outlets that do not use the FRIACO network will
write a zero value in the FRIACO seconds connected field.
The Time Covered field will be the length of time of the FRIACO fixed or Metered-Fixed
Period. If no such period exists for that day then the whole day will be included in this time, i.e.
24 * 60 * 60 seconds.
For service types 10 and 11, which include MF and FF periods, the primary purpose of the
summary records is to record FRIACO congestion, therefore CNIM should only include FF
period for these records.
2.2.9.b.1 Summary Files for ADSL
These requirements are taken from [Ref 14]
The FRIACOSecs, MeteredSecs and MeteredCalls will not be included within the daily
summary record for an outlet with an ADSL connection type. New field types will be used
which will specify the time periods for which Riposte is expected to be nailed up:
1) Within the summary file on an ADSL outlet CNIM will just include details of the period to
be covered by today's summary record, in the form of Start Time and Total Connected time.
2) The filename of this file will follow the current summary file naming convention.
3) The record format within the file will follow the format used in the current call summary file;
fields not required will remain blank. Fields included are:
> Date
> Start Time
> End Time
» Service Type (13 in the case of ADSL)
4) Where the NST changes during the day CNIM will take no special action, rather attempt to
construct the record using the information available.
2.2.9.b.2 Summary File Name Format
Summary file names have the following naming convention, where the <fad code> is the six
digit unique Outlet identifier.
QOS_P_<fad code>_<yyyymmdd>.new
2.2.9.c Bandwidth Logging for ADSL
These requirements are taken from [Ref 14].
Detailed design is given in 5.7.3.c
Logging of connection bandwidth is only required for an ADSL connection.
1) A new file will be generated each day at midnight, with a new suffix. The old file will be
renamed with an .old suffix - CASQOS will process all .old files since the last time it
executed. CASQOS will be responsible for housekeeping old files.
2) Bandwidth information required only on ADSL outlets when it is using the ADSL
connection.
© 2006 Fujitsu Services Company in Confidence Page 57
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
3) Bandwidth information will be extracted every (n) seconds
4) A registry entry is required to specify frequency of logging.
5) Bandwidth report placed in Summary folder.
6) Format will be Date, Time, Bandwidth (in Bits/second) and Failure Code as comma
separated values. For instance: 24/10/03, 14:25:00:00, 200000, <failure code>
7) Bandwidth will be recorded as zero whenever the actual bandwidth cannot be determined
8) The last field in the record contains a fail code. indicating the reason for the failure
9) The following errors can occur:
1* ping fails
2™ ping fails
Both pings fail.
1% ping takes longer than 2" ping
Vv
vv
> Bandwidth value calculated to be higher than the maximum possible value of 512Kb/sec
10) The ping frequency and sizing information will be included as registry parameters. Also a
maximum threshhold will be included. See section 4.
11) Bandwidth is measured from Ping roundtrip time.
12) One bandwidth file will be created/day
13) The bandwidth file name will be determined by whether the outlet is using the PSTN
modem, in which case Connection Type will be MODM. Normally it will be ADSL.
14) The bandwidth file will have the filename:
QOS_BNDWDTH_<fad_code>_<yyyymmdd>_<Connection Type>.new
CNIM creates and maintains a new log file which will record the bandwidth available at the
outlet. The available bandwidth log will only be maintained for the new ADSL network type.
A registry item will declare the frequency this information is collected, it is anticipated it will be
collected multiple times per hour.
Record format
Each line in the log file will include two comma separated fields: the timestamp when the
bandwidth check was run and the available network bandwidth, in bits per second, from the
gateway counter to the data centre, as below:
<date>, <time>, <bandwidth>, <fail code>
All timestamps will be recorded in UTC time. An example record is shown below:
24/10/2003, 14:25:00:00, 0000033660, 00
Filename format
The filename format will include a prefix, indicating the file contents, the fad code of the outlet,
a date stamp and the network connection type (allowing for future extension) and a .new or .old
suffix, i.e.
QOS_BNDWDTH_<fad code>_<yyyymmdd>_<ADSL>.new
These files will be stored in the same directory as the call summary files.
© 2006 Fujitsu Services Company in Confidence Page 58
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
A new file will be generated each day at midnight, with a .new suffix. The old file will be
renamed with an .old suffix - CASQOS will process all .old files since the last time it executed.
CASQOS will be responsible for housekeeping old files.
2.2.10 Dial Back Requirement
Design Overview: See section 5.8
CNIM is required to cause the line to connect out from the outlet to the Data Centre, should it
detect an incoming call whilst the line is down. Usually this would occur during a Connection
Type of Metered on Demand (MOD) or Voice on Demand (VOD) - see Table 13 for a
description of Connection Types.
CNIM will switch on Keep Alive for a period of 2 minutes; - see section 2.2.11 for a more
detailed description of Keep Alive.
2.2.11 Keep Alive Requirement
Design Overview: See section 5.14
The Keep Alive requirement comprises two components:
1) Keep Alive during "Nailed Up" Periods.
2) Keep Alive during Dial Back - see 2.2.10
Nailed Up periods comprise those connection types for which the connection should be
continuous, e.g. FRIACO Fixed, Metered Fixed and ADSL Fixed. It also comprises any time of
day for a Satellite outlet.
In either case the mechanism of Keep Alive is to "ping" one or more of the VPN Servers [Ref
9], available to the outlet at either Data Centre.
The frequency of pinging will such as to maintain line connectivity whilst keeping network
traffic to a minimum.
The Eicon card Shorthold Timer and MCDT values will be modified as to reduce the ping
frequency required whilst not keeping the line open unduly in the event of CNIM Keep Alive
being terminated. See 2.2.7.a for the timer values used.
At the conclusion of Keep Alive the card will be reconfigured.
2.2.11.a Ping Sequence
This section is part of the requirements for version 2 of CNIM.
With the “ping” process employed to maintain a connection to the Data Centre, there are three
issues to be considered:
1. Ping failure — an allowance of a 1% failure rate to be made.
2. All pings can fail for 1 or 2 seconds under certain network conditions.
3. VPN session establishment can impact the ability of the ping to work.
To overcome the issues above, CNIM utilises a sequence of “pings”, “n” seconds apart in order
to ascertain whether or not the call had worked. As soon as a ping succeeds, then the call is
deemed to be a success and the rest of the sequence is not done. In addition, on an
ISDN/FRIACO outlet, if the Eicon card reports that the call had closed before a ping had
succeeded then the call is deemed to have failed. The remaining “pings” in the sequence are not
done, as they would cause additional calls to be made to the Data Centre. If all the “pings” in
the sequence are deemed to have failed, then the last “ping” will time-out after “n” seconds.
© 2006 Fujitsu Services Company in Confidence Page 59
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
2.2.11.a.1 Methodology
The time between “pings” is a Registry Entry and initially will be set to 4 seconds.
1. CNIM selects 4 out of the 8 VPN servers; The VPN servers selected are the first from each
of the 4 IP Subnets.
2. The order to use the 4 VPN servers is randomised on starting CNIM.
3. With each call, CNIM starts with the first VPN server on the list, “pings” the server and
waits for X seconds.
4. Ifno response from the “ping” and the call is still open, CNIM “pings” the next server on
the list.
5. This repeats until all 4 servers have been “pinged” or the call has been dropped.
If no reply, then the call is deemed to have failed.
7. On the next call, CNIM will commence with the VPN server that responded the previous
time, after the ping interval timer of Y seconds.
8. For “Fixed” connections, CNIM will “ping” the VPN server that responded the previous
time. If this fails, CNIM tries the other 3 VPN servers, in sequence, 4 seconds apart, prior to
declaring the call dead. As with other “pings”, it will check the call is up before doing each
“ping”.
9. This means that at most 4 “pings” are used to determine whether or not a call has failed. See
Figure 9.
10. Note that “X” and “Y” seconds differ between ISDN, VSAT and ADSL outlets. The values
used are set in registry in section 5.13.3.b
© 2006 Fujitsu Services Company in Confidence Page 60
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Ping ~ Call Data
Sequence Centre
Pp Start Ping
P_ Select 4 VPN servers out of
(@PNrsanérs selected - 1st out of each
sdtsutine )
Ratsiomise the orders of the 4 VPN.
aawereate sequence
ttst
P Set Last VPN Pinged = 1st in
P_ Ping VPN server Ping timer = X
P Select next VPN server in
First in List
Figure 9 Ping Sequence (call to Data Centre)
2.2.12 Time Format Requirement
Design Overview: See section 5.15
© 2006 Fujitsu Services Company in Confidence Page 61
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
CNIM will use U.T.C. throughout except in the case of the Call Plan file - see Appendix A1
where the start and end times given are considered to be in local time. This means the same Call
Plan can be used throughout the year provided no call plan period ends/starts between 2 a.m.
and 3 a.m. UTC on the days of the clock change. This is because 2:15 a.m. (say) local time does
not exist during the Spring switch to B.S.T whilst 2:15 a.m. local time occurs twice during the
Autumn switch to GMT (U.T.C.).
2.2.13 GetStatus Query Requirement
Design Overview: See section 5.16
The requirement for the GetStatus functionality is specified in [Ref 5] and [Ref 6] and is
repeated below.
CNIM provides a CNIM Client DLL for use by components on the Counter that require
information on the current network connection, if any. It provides a CNIM Get Status function,
whereby the Counter Call Scheduler (CCS) can poll for changes in the network connection.
There are three aspects that might change:
a The Network Connection Status. The possible values of this ‘CNIM Status’ are
given in Table 18.
=a = Anumber of QOS Flags. The QOS flags are given in Table 19.
== The Current Connection Type: One of Satellite, Metered, FRIACO, Voice,
ADSL, ISDN,GSM. CCS will not use the actual type, but will notice that the
type has changed and react accordingly.
The time (i.e. tick count) of the last ‘material change’ is returned by the function. Changes in
this time also count as a change and are to be reported by the function.
The function can also return the (static) Connection Type: FRIACO 24-hour (Silver), Metered
‘dial-in’ (Bronze), etc. However, CCS does not make use of this information.
Network Connection Status Description Time of last material
(from CNIM) change
OK_Connected Currently connected Start of current
connection
OK_Disconnected Not currently connected, last I End of last connection
call succeeded
Call Lost Connection in progress was End of last connection
dropped
First Failure First attempt to connect has Time of first failure
failed
© 2006 Fujitsu Services Company in Confidence Page 62
Fujitsu
Services
CNIM Low Level Design
COMPANY IN CONFIDENCE
FUJ00171956
FUJ00171956
Ref: RS/LLD/004
Version: 4.0
Date: 8/05/2006
Temporarily Unavailable
More than one attempt to
connect has failed.
The time when it is
anticipated that it will become
Permanently Unavailable is
also returned
Time of first failure
Permanently Unavailable
More than 15 minutes
(configurable in CNIM) since
First Failure; or CNIM has
deemed, by other means, that
the fault is permanent
Time of first failure
Unknown!”
Most likely cause is the
CNIM service has failed
Table 18 — Network Connection Status from CNIM
‘ The CNIM Client DLL will return Unknown when it cannot communicate with
CNIM, the most likely cause of which is that the CNIM service has failed. As Tivoli will
be monitoring and restarting CNIM, there is no requirement for CCS to raise an alert.
However. if the fault persists for a long time (maybe 1 hour), CCS will raise an alert
by writing an Error to the NT Event Log.
2 Other failures returned by this DLL will be treated in the same way.
© 2006 Fujitsu Services
Company in Confidence
Page 63
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
QOS Flag (from CNIM) Description Used by CCS
Network connection nailed up The time until when it is For scheduling
This applies during FRIACO
Fixed and Metered Fixed
periods.
This also applies during
ADSL Fixed
nailed up is also returned. I Riposte connections
Fixed connection
the connection. Only
relevant if the network
connection is nailed up.
(This applies to FRIACO
Fixed and Metered Fixed
network behaviours.)
This also applies during
ADSL Fixed and ADSL
Establish
Set during the periods For scheduling
when Riposte is to nail upI Riposte connections
Emergency connection
nature. (This applies to a
connection over a Voice
network)
This flag prevents Riposte
nailing up the line itself.
Set when the current For monitoring the
connection is of an emergency I Online Status
Contracted Silver
The Outlet is contracted to For monitoring the
receive Silver network Online Status, and
service. then only in
controlling the
message displayed to
the Clerk.
Table 19 —- QOS Flags from CNIM.
The Contracted Silver flag is used to indicate those outlets which have the silver service as
opposed to bronze. The reason being different messages can be displayed at a silver outlet in
the event that a different level of service is offered. The flag is set on service types 7 through to
12.
The table below shows Connection Type flags for certain connection types.
Period\ Connection Type Mode 1 Mode 2 Mode 3 GSM Day D Moder
FRIACO Establish Fixed=0 Fixed=0 Fixed=0 As Mode 1 As Mode 1
NailedUp=1 NailedUp=0 NailedUp=0
Emergency=0 Emergency=0 Emergency=1
FRIACO Fixed Fixed=1 Fixed=1 Fixed=1 As Mode 1 As Mode I
© 2006 Fujitsu Services
Company in Confidence
Page 64
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
NailedUp=1 NailedUp=1 NailedUp=0
Emergency=0 I Emergency=0 I Emergency=1
Metered Fixed Fixed=1 Fixed=1 Fixed=1 As Mode 1 As Mode I
NailedUp=1 NailedUp=1 NailedUp=0
Emergency=0 I Emergency=0 I Emergency=1
Metered on Demand Fixed=0 Fixed=0 Fixed=0 As Mode 1 As Mode 1
NailedUp=0 NailedUp=0 NailedUp=0
Emergency=0 I Emergency=0 I Emergency=1
Voice on Demand Fixed=0 Fixed=0 Fixed=0 As Mode 1 As Mode I
NailedUp=0 NailedUp=0 NailedUp=0
Emergency=0 I Emergency=0
Emergency=1
Table 20 QOS Flags for Connection Types
1) Other bits are ignored if Emergency set.
3) CNIM will only set the "Contracted Silver Outlet" flag for 24 hr silver outlets, not part-time
Silvers (NST 7).
4) The Emergency flag is only set when at voice (Mode 3) and the line is up.
2.2.13.a GetStatus Query Requirement for ADSL
The following details are taken from [Ref 14]
CNIM makes information available to the counter call scheduler on the availability of the outlet
to data centre network. This will continue, and will apply to the new ADSL network. Where
the network is permanently unavailable, information regarding the failure, in the form of an error
code, is passed to the Post Office clerk along with a request to raise a call with the Horizon
helpdesk. Permanent unavailability is defined as being unable to connect to the data centre for a
15 minute period. The current isdn network has certain constraints on the number of call
attempts across the whole network per second. CNIM is limited to making on average (across
all outlets) 1 call attempt per 15 minutes, hence the 15 minute period before declaring the
network as permanently unavailable, ensuring at least one additional call attempt is made
following the failure.
In the majority of cases the error code passed back will be the same as that recorded in the last
record in the call summary file. There is a failure state where the ADSL call remains intact
however IP communications is not possible to the data centre. This failure condition will be
detected by CNIM pinging data centre components whilst an ADSL connection is outstanding.
Where the ping continues to fail for greater than the period used to determine the network has
become permanently unavailable (currently set at 15 minutes), CNIM will mark the gateway
communications as permanently unavailable to the CCS, which in-turn will make this
information available to the Horizon online applications / online service indicator. This error
code will be overridden if at a later stage the call state does change.
2.2.13.b GetStatus Flag Settings for ADSL with ISDN and GSM Backup
Period\Connection Type ADSL ISDN (RAS) GSM
RA Fixed=0 Fixed=0 Fixed=0
NailedUp=0 NailedUp=0 NailedUp=0
© 2006 Fujitsu Services Company in Confidence Page 65
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Emergency=0 Emergency=0 Emergency=0
RAIG Fixed=1 Fixed=1 Fixed=1
NailedUp=1 NailedUp=1 NailedUp=1
Emergency=0 Emergency=0 Emergency=0
Table 21 Flag Settings for Resilient Network
2.2.13.¢ GetStatus Flag Settings for ADSL with GSM Backup
Period\Connection Type ADSL GSM
RA Fixed=0 Fixed=0
NailedUp=0 NailedUp=0
Emergency=0 Emergency=0
RAG Fixed=1 Fixed=1
NailedUp=1 NailedUp=1
Emergency=0 Emergency=0
Table 22 Flag Settings for Resilient Network
2.2.14 Satellite Requirements
The fundamental difference between a satellite gateway and any other, from the point of view of
CNIM, is the absence of the Eicon card. CNIM is unable to configure the means of
communication on the gateway and is used only to monitor and log calls and to return failure
information to the CCS via the GetStatus mechanism.
2.2.15 Tracing Requirements
Version 2 of CNIM will use the TuneableTrace mechanism. See NB/LLD/025
From version 2 onwards the trace file will contain which “ping” in the sequence has worked, in
order to give some indication as to the quality of the network at the time.
2.2.16 Static Test Requirements
There are two CNIM function calls that are test scenarios.
2.2.16.a CNIM Test — Implementation
When CNIM has been installed at an Outlet, it has to ascertain whether or not the metered
service is available. CNIM will only attempt to connect to the Data Centre via the metered
service as this is available 24 hours a day, seven days a week. If the metered call fails the
installation will be rolled back.
2.2.16.a.1_ Implementation Test at S60
From S60 the Implementation Test will merely comprise updating registry to say that
the process has been completed and that CNIM is installed.
© 2006 Fujitsu Services Company in Confidence Page 66
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
2.2.16.b CNIM Test — normal running
During normal running if the CNIM test function is invoked it will attempt Data Centre calls
through the primary number in Mode I and Mode 2. A file is generated within the CNIM folder
on the Gateway PC with the results of the Data Centre calls.
2.2.16.b.1_ Normal Test at S60
From S60 the Normal Test has been removed.
2.2.17 BNR - CP4097 CNIM to send reset to Connection Manager every 20 minutes.
Design Overview: See section 5.23
For ADSL connected outlets (NST13 and NST14) CNIM will issue a reset request to
Connection Manager at 20 minute intervals during periods of ADSL network failure.
The first reset will occur immediately following the first ping failure.
2.2.17.a Service Type 13 - ADSL only Outlets
On NST 13 outlets the connection type will remain as ADSL throughout the reset
cycle unless the user manually switches to GSM backup. In any event the reset cycle
will continue until network connectivity is restored.
On first ping failure CNIM will set the Connection Manager reset flag to be set to 1
and will start a 20 minute "Blackhole" timer which, on expiry, will alsocause the
Connection Manager reset flag to be set to 1. Connection Manager will then reset the
RAS connection each time the reset flag is set to 1.
If during the 20 minute wait period, CNIM detects a change of RAS connection state
by Connection Manager then the "Blackhole" timer will be reset and a new ping test
will be initiated. If the ping test fails then the timer will be reinitiated.
2.2.17.b Service Type 14 - ADSL Outlets with ISDN Backup
On NST 14 outlets during core hours the connection will switch to ISDN after 10
minutes in the event of network failure. This is done by CNIM requesting an ISDN
connection type from Connection Manager. The change of connection type will cause
CNIM to retest the connection and, if it succeeds, the "Blackhole" timer will be
terminated. If the test fails then CNIM will enter the 20 minute reset cycle as for an
ADSL connection.
2.2.18 BNR - CP4103 GSM Network gives Received Signal Strength Information
Design Overview: See section 5.24
CNIM will be required to log the received signal strength, obtained by Connection
Manager, to TuneableTrace. CNIM will monitor Connection Manager registry and log
each change of RSSI value.
2.2.19 Event Logging of Network Switching for BNR
Design Overview: See section 5.25
The following requirements are taken from [Ref 20].
© 2006 Fujitsu Services Company in Confidence Page 67
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
CNIM is responsible for controlling the switch between network types. On switch to a new
network type CNIM will raise an event. CNIM will include the following information
specifically within the event text:
e The network type before the switch;
© The network type following the switch;
© = The time and date the switch was attempted.
CNIM will raise an information event where the switch was successful and an error event
where the switch was not succ A unique, to CNIM, event ID will be recorded against the
event allowing Tivoli to filter the events to be forwarded to the data centre.
The following additional information will be gleaned from the event itself:
e The time the event was raised and therefore the switch was complete, i.e. when the event
was written;
e The Gateway counter machine name, which includes the FAD code of the Branch.
CNIM is also responsible for testing the ISDN backup network connection at strategic outlets
once per week. The event raised to record a successful test will include the information
document above against the standard network type switch event plus the following additional
information / changes:
e The percentage of successful ping attempts made across the 10 minute test period.
A different event ID will be used to allow the event to be distinguished from events
relating to a switch required following a failure.
© 2006 Fujitsu Services Company in Confidence Page 68
Fujitsu
Services
CNIM Low Level Design
COMPANY IN CONFIDENCE
FUJ00171956
FUJ00171956
Ref: RS/LLD/004
Version: 4.0
Date: 8/05/2006
3 ARCHITECTURE
3.1 System Diagram
The relationship of the CNIM to other system components is shown in Figure 10.
Riposte
I Tivoli I
ETS
Counter Call I I
Serecuice, fel CNIM_Config.exe
X I X x
CNIM_APLDLL
(canten Ce
—— )
/ File)
a CNIMexe fs (Summary)
J File
(ven .
Policy File —
Bandwidth’)
- )
: ~ File
+ I Reaisty
ADSL
5 Cannection Diagnostic
1 i Monitor
Ping State I
L
Eicon
Ethernet Card >
(Satellite) (ISDN/
FRIACO)
J
\
te ISDN/FRIACO
Satellite _ Network
Network
Figure 10: System Diagram
© 2006 Fujitsu Services Company in Confidence
Page 69
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
3.2 Operational Overview
One of the roles of CNIM is to manage the Eicon card if one is present and to provide call
logging and diagnostic information.
For a satellite or ADSL outlet no Eicon card is used. On VSAT outlets CNIM relies on ping
success/fail information, whilst on an ADSL outlet CNIM uses line status data from Connection
Manager.
Call logging takes place by providing a one-line record for each call made or received by the
outlet. Each record is placed in a "Monitor" file specific to that 24-hour period, i.e. each “UTC”
day. In addition a summary of the day’s calls will be placed in a "Period" file as a one line
record. The file names of the Monitor and Period files will be specific to the date for which that
file applies.
Current diagnostic information will be available via the CNIM_API.dll. This provides a
"GetStatus" function, which may be used to query the current connection type and whether a
line test is pending. The API also provides functionality to test all available numbers during
installation and to provide a reset mode such that updated registry input will be incorporated
into the existing run mode.
CNIM also incorporates a "Call Reversal (Dial Back)" facility such that on closure of in inbound
call to the outlet CNIM will initiate a connection to the data centre.
© 2006 Fujitsu Services Company in Confidence Page 70
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
4 EXTERNAL INTERFACES
4.1 Interfaces Provided
4.1.1 NT Service Interface
¢ CNIM provides the standard ServiceMain() and Handler() functions to support an NT
service.
e The CNIM starts automatically. Subsequent control is via the Control Service API
(OpenService(), StartService(), ControlService(). Start and stop controls are supported.
Pause and resume controls are not supported.
4.1.2 GetStatus Interface to Counter Call Scheduler
CNIM is required to provide network status information to Counter Call Scheduler
(CCS) on demand. CCS may request information immediately or request to be notified
of network changes within a certain period. At the end of that period CNIM will return
the current network state.
More detail for this is given in section 5.16.
4.1.3, Operational Control Interface
4.1.3.a Call Plan Registry
The NT registry key [HKEY_LOCAL_MACHINE\SOFTWARE\ICL\Pathway
Configuration\CNIM\CallPlan] is used to control the operational state of CNIM. The following key
values are defined:
Name Type Max Default Description
size value
Call_Plan_Dir Siring I 64 "CACNIM\" Call plan directory
Call_Plan_Prefix String 64 "CALL_PLAN_" Call Plan file prefix
Call_Plan_Output String I 64 "CP_Out.txt” Call Plan output file
Table 23 Registry Entries - Call Plan
4.1.3.6 Connection Modes Registry
The NT registry key:
{HKEY_LOCAL_MACHINE\SOFTWARE\ICL\Pathway Configuration\CNIM\Connection\ConnectionModes]
contains a set of subkeys, one for each connection type.
The value name is the CNIM mode and contains the connection type for that mode, the
corresponding Branch Resilient Network mode as input from the engineers buttons and the Test
Range. A BNR mode of 0 essentially means that that mode of connection cannot be initiated
from the "Connect" button on the engineers screen. In the case of "Idle" it would be initiated
from the "Drop" button.
Conventional CNIM using NDIS with the Eicon card would use CNIM modes 1,2 and 3. There
would be no mapping of CNIM modes 2 and 3 to the engineers buttons. Generally the buttons
map to RAS modes, which for an NDIS outlet would be CNIM mode 4 (BNR mode 2). On an
NDIS outlet then NDIS Primary would be BNR mode 1.
© 2006 Fujitsu Services Company in Confidence Page 71
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
The values used are described below:
© 2006 Fujitsu Services Company in Confidence Page 72
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
4.1.3.b.1 FRIACO Establish Connection Types
[HKLM\SOFTWARE\ICL Pathway Configuration\CNIM\Connection\ConnectionModes\NDIS_FE]
Name I Type I Max I Default I Contents Description
size value
0 String I 64 N/A IDLE_RAS,0,RID_Ra_ I Network Type "Idle", BNR Mode 0, RAS Idle
nge Test range
1 String I 64 N/A FP,1,F_Range FRIACO Primary, BNR Mode 1, NDIS Fixed
range
2 String I 64 N/A MS,9,F_Range Metered Secondary, BNR Mode 1
String I 64 V/A .9,F_Range Voice Primary, BNR Mode I
4 String I 64 N/A IDLE,0,RID_Range Idle, BNR Mode 2, RAS Idle Test range
Table 24 CNIM and BNR Modes for Connection Types - FRIACO Establish
4.1.3.b.2 FRIACO Fixed Connection Types
[HKLM\SOFTWARE\ICL\Pathway Configuration\CNIM\Connection\ConnectionModes\NDIS_FF]
Name I Type I Max I Default I Example Description
size value
0 String I 64 N/A IDLE_RAS,0,RID_Ra_ I Network Type "Idle", BNR Mode 0
nge
1 String I 64 N/A FP,1,F_Range FRIACO Primary, BNR Mode I
2 String I 64 NA MS,1,F_Range Metered Secondary, BNR Mode I
3 String I 64 N/A VP, 1,F_Range Voice Primary, BNR Mode I
4 String I 64 N/A IDLE_RAS,0,RID_Ra_I Idle, BNR Mode 2, RAS Idle Test range
nge
Table 25 CNIM and BNR Modes for Connection Types - FRIACO Fixed
4.1.3.b.3 FRIACO Fixed With GSM - Connection Types
[HKLM\SOFTWARE\ICL \Pathway Configuration\CNIM\Connection\ConnectionModes\NDIS_FFG]
Name I Type I Max I Default I Example Description
size value
0 String I 64 N/A IDLE_RAS,0,RG_Ran_ I Network Type "Idle", BNR Mode 0
ge
1 String I 64 N/A FP,1,F_Range FRIACO Primary, BNR Mode 1
2 String I 64 NA MS,1,F_Range Metered Secondary, BNR Mode I
3 String I 64 N/A VP,1,.F_Range Voice Primary, BNR Mode I
4 String I 64 N/A GSM,2,RG_Range GSM, BNR Mode 2, RAS GSM Test range
Table 26 CNIM and BNR Modes for Connection Types - FRIACO Fixed with GSM
4.1.3.b.4 Metered Fixed Connection Types
[HKLM\SOFTWARE\ICL\Pathway Configuration\CNIM\Connection\ConnectionModes\NDIS_MF]
Name I Type I Max _I Default ] Contents [ Description
© 2006 Fujitsu Services Company in Confidence Page 73
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
size value
0 String I 64 N/A IDLE_RAS,0,RID_R I Network Type "Idle", BNR Mode 0
ange
1 String I 64 N/A MP,1,F_Range Metered Primary, BNR Mode 1
2 String I 64 N/A MS,1,F_Range Metered Secondary, BNR Mode 1
3 Siring I 64 N/A VP. I.F_Range Voice Primary, BNR Mode 1
4 Siring I 64 N/A TDLE_RAS,0,RID_R I Idle, BNR Mode 0
ange
Table 27 CNIM and BNR Modes for Connection Types - Metered Fixed
4.1.3.b.5 Metered Fixed with GSM Connection Types
({HKLM\SOFTWARE\ICL \Pathway Configuration\CNIM\Connection\ConnectionModes\ NDIS_MFG]
Name I Type Max I Default I Contents Description
size value
0 String I 64 N/A IDLE_RAS,0,RG_Ra I Network Type "Idle", BNR Mode 0
nge
1 String I 64 N/A MP. 1.F_Range Metered Primary, BNR Mode I
2 String I 64 N/A MS,1,F_Range Metered Secondary, BNR Mode 1
3 String I 64 Ni. VP. 1,F_Range Voice Primary, BNR Mode I
4 String I 64 N/A GSM,2,RG_Range GSM, BNR Mode 2, RAS GSM range
4.1.3.b.6 Mete:
Table 28 CNIM and BNR
red On Deman
id Connection Types
Modes for Connection Types - Metered Fixed with GSM
[HKLM\SOFTWARE\ICL\Pathway Configuration\CNIM\Connection\ConnectionModes\NDIS_MOD]
Name I Type I Max I Default I Example Description
size I value
0 String I 64 N/A IDLE_RAS,0,RID_R I Network Type "Idle", BNR Mode 0
ange
1 String I 64 NA MP,1,D_Range Metered Primary, BNR Mode I
2 String I 64 N/A VP, 1,D_Range Voice Primary, BNR Mode 1
3 String I 64 N/A VS,1,D_Range Voice Secondary, BNR Mode 1
4 String I 64 N/A IDLE_RAS,0,RID_R I Idle, BNR Mode 0
ange
Table 29 CNIM and BNR Modes for Connection Types - Metered On Demand
4.1.3.b.7 Metered On Demand with GSM Connection Types
© 2006 Fujitsu Services
Company in Confidence Page 74
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
{HKLM\SOFTWARE\ICL \Pathway Configuration\CNIM\Connection\ConnectionModes\NDIS_MODG]
Name I Type Max I Default I Example Description
size value
0 String I 64 N/A IDLE_RAS,0,RG_Ra I} Network Type "Idle", BNR Mode 0
nge
1 String I 64 N/A MP,1,D_Range Metered Primary, BNR Mode I
2 String I 64 N/A VP,1,D_Range Voice Primary, BNR Mode 1
3 Sirmg I 64 NA VS,1,D_Range Voice Secondary, BNR Mode I
4 String I 64 NA GSM.2.RG_Range I GSM, BNR Mode 2, RAS GSM range
Table 30 CNIM and BNR Modes for Connection Types - MOD with GSM
4.1.3.b.8 Voice Connection Types
[HKLM\SOFTWARE\ICL Pathway Configuration\CNIM\Connection\ConnectionModes\NDIS_VOD]
Name I Type I Max I Default I Example Description
size I value
0 Sting [64 IN/A IDLE_RAS,0,RID_R I Network Type "Idle", BNR Mode 0
ange
1 String [64 I N/A VP. 1,1 Range Voice Primary, BNR Mode 1
2 Sting [64 IN/A Voice Secondary, BNR Mode 1
3 String [64 IN/A Voice Tertiary, BNR Mode 1
4 Suing I 64 IN/A TDLE_RAS,O,RID_R I Idle, BNR Mode 0
ange
Table 31 CNIM and BNR Modes for Connection Types — Voice
4.1.3.b.9 Voice with GSM Connection Types
{HKLM\SOFTWAREI\ICL\Pathway Configuration\CNIM\Connection\ConnectionModes\NDIS_VODG]
Name I Type I Max I Default I Example Description
size value
0 String I 64 N/A IDLE_RAS,0,RID_R_} Network Type "Idle", BNR Mode 0
ange
1 String I 64 N/A VP, 1,1_Range Voice Primary, BNR Mode 1
2 String I 64 N/A VS, 1I_Range Voice Secondary, BNR Mode I
3 String I 64 N/A VT,1,1_Range Voice Tertiary, BNR Mode 1
4 String I 64 NA GSM,2,RG_Range I GSM, BNR Mode 2
Table 32 CNIM and BNR Modes for Connection Types - Voice with GSM
4.1.3.b.10 I RAS ADSL Connection Types
© 2006 Fujitsu Services
Company in Confidence Page 75
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
({HKLM\SOFTWARE\ICL \Pathway Configuration\CNIM\Connection\ConnectionModes\RAS_A]
Name I Type Max Default I Contents Description
size value
0 String I 64 N/A TIDLE_RAS,0,RA_Ra I Network Type "Idle", BNR Mode 0
nge
1 String I 64 N/A ADSL,1,RA_Range ADSL, BNR Mode 1
2 String I 64 N/A IDLE_RAS.0,RA_RA I Idle, BNR Mode 0
NGE
3 String I 64 N/A IDLE_RAS,0,RA_RA I Idle, BNR Mode 0
NGE
4 String I 64 N/A IDLE_RAS,0,RA_RA I Idle, BNR Mode 0
NGE
Table 33 CNIM and BNR Modes for Connection Types - ADSL only
4.1.3.b.11. RAS ADSL-GSM Connection Types
({HKLM\SOFTWARE\ICL \Pathway Configuration\CNIM\Connection\ConnectionModes\RAS_AG]
Name I Type Max Default I Contents Description
size value
0 String I 64 N/A TIDLE_RAS,0,RAG_R I Network Type "Idle", BNR Mode 0
ange
1 String I 64 N/A ADSL,1,RAG Range I ADSL, BNR Mode 1
2 String I 64 N/A GSM,2,RAG_Range I GSM, BNR Mode 2
3 String I 64 N/A IDLE_RAS,0,RA_Ra_ I Idle, BNR Mode 0
nge
4 String I 64 N/A IDLE_RAS,0,RA_Ra I Idle, BNR Mode 0
nge
Table 34 CNIM and BNR Modes for Connection Types - ADSL with GSM
4.1.3.b.12 I RAS ADSL-ISDN-GSM Connection Types
({HKLM\SOFTWARE\ICL\Pathway Configuration\CNIM\Connection\ConnectionModes\RAS_AIG]
Name I Type Max Default I Example Description
size value
0 String I 64 N/A IDLE_RAS,0,RAIG_R_ I Network Type "Idle", BNR Mode 0
ange
1 String I 64 N/A ADSL,1,RAIG_Range I ADSL, BNR Mode I
2 String I 64 N/A ISDN,2,RAIG_Range ISDN, BNR Mode 2
3 String I 64 N/A GSM,3,RAIG_Range GSM, BNR Mode 3
4 String 64 NA IDLE_RAS,0,RA_Ran I Idle, BNR Mode 0
ge
Table 35 CNIM and BNR Modes for Connection Types - ADSL with ISDN and GSM
4.1.3.b.13 RAS ISDN Only Connection Types
[HKLM\SOFTWARE\ICL\Pathway Configuration\CNIM\Connection\ConnectionModes\RAS_IT]
Name I Type [Max __I Default [I Example [Description
© 2006 Fujitsu Services Company in Confidence Page 76
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
size value
0 String I 64 N/A IDLE_RAS,0,RIT__ I Network Type "Idle", BNR Mode 0
Range
1 String I 64 N/A ISDN,1,RIT_Range I ISDN, BNR Mode 1
2 String I 64 N/A IDLE_RAS,0,RIT__ I Network Type "Idle", BNR Mode 0
Range
3 String I 64 N/A IDLE_RAS.O,RIT__ I Network Type "Idle", BNR Mode 0
Range
4 String I 64 NA IDLE_RAS,O,RIT__ I Network Type "Idle", BNR Mode 0
Range
Table 36 CNIM and BNR Modes for Connection Types - ISDN Only
4.1.3.b.14 VSAT Connection Types
[{HKLM\SOFTWARE\ICL Pathway Configt
uration\CNIM\Connection\ConnectionModes\VSAT_PC]
Name I Type I Max Default] Example Description
size value
0 String I 64 N/A PC,0,P_Range Permanent Connection, BNR Mode 0.
1 String I 64 N/A PC,1,P_Range Permanent Connection, BNR Mode 1
2 String I 64 N/A PC,2,P_Range Permanent Connection, BNR Mode 2
3 String I 64 N/A PC,3,P_Range Permanent Connection, BNR Mode 3
4 String I 64 N/A PC,4,P_Range Permanent Connection, BNR Mode 4
Table 37 CNIM and BNR Modes for Connection Types —- VSAT
4.1.3.b.15 I Frame Relay Establish Connection Types
[HKLM\SOFTWARE\ICL\Pathway Config)
uration\CNIM\Connection\ConnectionModes\FR_FRE]
Name I Type Max Default I Example Description
size value
0 String I 64 N/A FRE,0,FR_Range Frame Relay Establish, BNR Mode 0
1 String I 64 N/A FRE,1,FR_Range Frame Relay Establish, BNR Mode 1
2 String I 64 NA Empiy Empty
3 String I 64 NA Empty Empty
4 String I 64 N/A Empty Empty
Table 38 CNIM and BNR Modes for Connection Types — Frame Relay Establish
4.1.3.b.16 I Frame Relay Fixed Connection Types
© 2006 Fujitsu Services
Company in Confidence Page 77
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
[HKLM\SOFTWARE\ICL\Pathway Configuration\CNIM\Connection\ConnectionModes\FR_FRF]
Name I Type Max Default I Example Description
size value
0 String I 64 N/A FRF,0,FR_Range Frame Relay Fixed, BNR Mode 0
1 String I 64 N/A FRF,1,FR_Range Frame Relay Fixed, BNR Mode 1
2 String I 64 N/A Empty Empty
3 String I 64 NA Empty Empty
4 String I 64 NA Empty Empty
Table 39 CNIM and BNR Modes for Connection Types — Frame Relay Fixed
© 2006 Fujitsu Services
Company in Confidence Page 78
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
4.1.3.¢ Service Mode Registry
The Service Mode registry is used to map Connection types to secondary names
which relate either to phone number names or RAS connection types.
For NDIS outlets these secondary names are stored in the Eicon section of registry as
described in section 4.1.3.0
4.1.3.c.1 Service Mode — FRIACO 1
{HKLM\SOFTWARE\ICL Pathway Configuration\CNIM\Connection\ServiceMode\FRIACO1]
Name Type I Max I Default] Example of Description of connection to use
size value Secondary Name
FP String I 64 N/A FCIP FRIACO 1 Primary
FS String I 64 N/A FCIS FRIACO I Secondary
MP String I 64 N/A DP Dialaround Primary
MS String I 64 N/A DS Dialaround Secondary
VP String I 64 N/A VP Voice Primary
VS Siring I 64 NA VS Voice Secondary
VT String I 64 N/A VT Voice Tertiary
GSM String I 64 N/A GSM GSM
IDLE String I 64 N/A IDLE Idle
Table 40 Service Mode —- FRIACO 1
4.1.3.¢.2 Service Mode — FRIACO 2
{HKLM\SOFTWARE\ICL \Pathway Configuration\CNIM\Connection\ServiceMode\FRIACO2]
Name Type I Max I Default I Example of Description of connection to use
size value Secondary Name
FP String I 64 N/A FC2P FRIACO 2 Primary
FS String I 64 N/A FC2S FRIACO 2 Secondary
MP Siring I 64 NA DP Dialaround Primary
MS String I 64 N/A DS Dialaround Secondary
VP String I 64 N/A VP Voice Primary
VS String I 64 N/A VS Voice Secondary
VT String I 64 N/A VT Voice Tertiary
GSM String I 64 N/A GSM GSM
IDLE String I 64 N/A IDLE Idle
Table 41 Service Mode — FRIACO 2
4.1.3.c.3 Service Mode - Metered
© 2006 Fujitsu Services Company in Confidence Page 79
Fujitsu
Services
CNIM Low Level Design
COMPANY IN CONFIDENCE
Version: 4.0
Date:
FUJ00171956
FUJ00171956
Ref: RS/LLD/004
8/05/2006
{HKLM\SOFTWARE\ICL \Pathway Configuration\CNIM\Connection\ServiceMode\Metered]
Name Type I Max I Default I Example of Description of connection to use
size value Secondary Name
MP String I 64 N/A DP Dialaround Primary
MS String I 64 N/A DS Dialaround Secondary
VP Siring I 64 NA VP Voice Primary
VS String I 64 NA VS Voice Secondary
VT String I 64 NA VT Voice Tertiary
GSM String I 64 N/A GSM GSM
IDLE String I 64 N/A IDLE Idle
4.1.3.c.4 Service Mode
- RAS
Table 42 Service Mode - Metered
({HKLM\SOFTWARE\ICL Path
hway Configuration\CNIM\Connection\ServiceMode\RAS]
Name Type I Max I Default I Example of Description of connection to use
size value Secondary Name
ADSL String I 64 N/A ADSL ADSL
ISDN String I 64 N/A ISDN ISDN
GSM String I 64 N/A GSM GSM
IDLE String I 64 N/A IDLE Idle
Table 43 Service Mode - RAS
4.1.3.c.5 Service Mode
- Voice
({HKLM\SOFTWARE\ICL Path
hway Configuration\CNIM\Connection\ServiceMode\ Voice]
Name Type [Max I Default I Example of Description of connection to use
size I value Secondary Nz
VP String I 64 N/A VP Voice Primary
VS String I 64 N/A VS Voice Secondary
VT String I 64 NA VT Voice Tertiary
GSM String I 64 N/A GSM GSM
IDLE String I 64 N/A IDLE Idle
4.1.3.¢.6 Service Mode
- VSAT
Table 44 Service Mode - Voice
({HKLM\SOFTWARE\ICL Path
hway Configuration\CNIM\Connection\ServiceMode\VSAT]
Name Type I Max
size
PC String I 64
Default I Example of
value Secondary Name
N/A PC
Description of connection to use
Permanent Connection
4.1.3.c.7 Service Mode
Table 45 Service Mode - VSAT
— Frame Relay
© 2006 Fujitsu Services
Company in Confidence
Page 80
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
({HKLM\SOFTWARE\ICL \Pathway Configuration\CNIM\Connection\ServiceMode\FrameRelayI
Name Type I Max I Default I Example of Description of connection to use
size value Secondary
FRE String I 64 N/A FRE Frame Relay Establish
FRF String I 64 N/A FRF Frame Relay Fixed
Table 46 Service Mode — Frame Relay
4.1.3.d Mapping Service Type to Service Mode
The following registry table is used to map standard service types to service modes.
{HKLM\SOFTWARE\ICL \Pathway Configuration\CNIM\Connection\NST_To_Mode]
Name Type Max Default I Contents Description of
size value connection to use
ST_ADSL String I 64 N/A RAS RAS Service Mode
ST_ADSL_ISDN String I 64 N/A RAS RAS Service Mode
ST_BRONZE String I 64 N/A Metered Metered Service Mode
ST_FRAME_RELAY String 64 N/A FrameRelay I Frame Relay Service
Mode
ST_FRIACO_SILVER_24HR_C1 String 64 N/A FRIACOL FRIACO 1 Service
Mode
ST_FRIACO_SILVER_24HR_C2 String 64 N/A FRIACO2 FRIACO 2 Service
Mode
ST_FRIACO_SILVER_DAYTIME_CI String I 64 NA FRIACO! I FRIACO I Service
Mode
ST_FRIACO_SILVER_DAYTIME_C2. String 64 N/A FRIACO2 FRIACO 2 Service
Mode
ST_NON_FRIACO_SILVER_24HR. String I 64 N/A Metered Metered Service Mode
ST_NON_FRIACO_SILVER_DAYTIME String 64 V/A Metered Metered Service Mode
ST_SATELLITE String 64 N/A VSAT Satellite Service Mode
ST_SILVER_PARTTIME_A String I 64 N/A Metered Metered Service Mode
ST_SILVER_PARTTIME_B String 64 N/A Metered Metered Service Mode
ST_VOICE String I 64 N/A Voice Voice Service
Mode
Table 47 Mapping Service Type to Service Mode
4.1.3.e Live Registry
The NT registry key [HKEY_LOCAL_MACHINE\SOFTWARE\ICL Pathway Configuration\CNIM\Live] is
used to control the operational state of CNIM. The following key values are defined:
Name Type Max I Default Description
size value
CAUSE_CODE String 64 N/A The last disconnection cause code.
CUR_DAY String 64 N/A "MON", "TUE", "WED", THU,
"FRI", "SAT", "SUN"
CUR_NET_TYPE String 64 N/A "VP", "VS", "VT", "FCIP",
© 2006 Fujitsu Services Company in Confidence Page 81
Fujitsu
Services
CNIM Low Level Design
COMPANY IN CONFIDENCE
FUJ00171956
FUJ00171956
Ref: RS/LLD/004
Version: 4.0
Date: 8/05/2006
CUR_NET_TYPE_INTERNAL
String
64 N/A
"FC2P", "FCIS", "FC2S", "MP",
"MS", "DP", or "DS"
"F" = FRIACO
"M" = Metered
"D" = Dialaround
"Pp" = Permanent
© 2006 Fujitsu Services
Company in Confidence
Page 82
Fujitsu
Services
CNIM Low Level Design
COMPANY IN CONFIDENCE
FUJ00171956
FUJ00171956
Ref: RS/LLD/004
Version: 4.0
Date: 8/05/2006
DFND_END_TIME
DFND_NET_TYPE
DFND_START_TIME
DIRECTORY_MONITOR_FILES
DIRECTORY_PERIOD_FILES
DIRECTORY_TEST_FILES
DISABLE_ON_TEMP_FAIL
Disabled_Channel
Eicon_Num_l
Eicon_Num_2
Eicon_Num_3
Eicon_Num_4
Eicon_Num_5
Eicon_Num_6
ErrorExtension
Est_End_Time
FAIL_NET_TIME
FRIACO_PRIME_NUMBER
FRIACO_SECONDARY_NUMBE
R
KEEP_ALIVE_STATE
METERED_PRIME_NUMBER
METERED_SECONDARY_NUM
BER
Migration_State
Monitor_Dial_Prefix
Monitor_Metd_Prefix
Monitor_Perm_Prefix
Monitor_Prefix
NET_DOWN
String I 64 N/A
String I 64 I N/A
String 64 I N/A
String 64 "C:\CNIM\MONI
TOR\"
String 64 "C:\CNIM\SUM
MARY\"
String 64 "C:A\CNIM\TEST\
DWORD I N/A 1
DWORD I N/A 2
String I 64 /A
String 64 N/A
String 64 N/A
String I 64 I N/A
String I 64 NA
String 64 N/A
String I 64 "ERR"
String 64 N/A
String I 64 NA
String I 64 NA
String I 64 I N/A
String 64 N/A
String I 64 I N/A
String I 64 NA
String I G4 “WITHIN_MIG
RATION"
String I 64 "QOS_MON_D_"
String I 64 "QOS_MON_M_
String 64 "QOS_MON_P_"
String 64 "QOS_MON_"
String ] 64 I N/A
Defined end time for the "Nailed
Up" period. Of the form -
Defined network type:
"OI" to "14"
Defined start time for the "Nailed
Up" period. Of the form -
"08:00:00"
Monitor files directory
Summary files directory
Test files directory
Comms channel not used
1* Eicon number
2™ Eicon number
3" Eicon number
4" Eicon number
5" Eicon number
6" Eicon number
Filename extension for Error files
Time at which CNIM will
terminate the "Nailed Up" period.
Time at which the network was
deemed to have permanently failed.
The primary FRIACO number for
this outlet.
The secondary FRIACO number
for this outlet.
Current Keep Alive State:
"UP" or "DOWN"
The primary metered number for
this outlet.
The secondary metered number for
this outlet.
EITHER
“WITHIN_MIGRATION" OR
"POST_MIGRATION"
Monitor File name prefix - dialled
Monitor File name prefix - metered
Monitor File name prefix -
permanent
Monitor File name prefix
Network Up/Down flag:
© 2006 Fujitsu Services
Company in Confidence
Page 83
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
"YES" or "NO"
NewFileExtension String 64 "NEW" Name of extension used at end of
the current call plan filename
OldFileExtension String 64 "OLD" Name of extension used at end of
older call plan filenames
Period_Prefix String 64 "QOS_P_" Period File name prefix
Ping_State_List_Length DWORD I N/A 10 Maximum number of ping states to
store
STATE_NET String 64 N/A Network state:
"SNET_UNKNOWN";
"SNET_FAILED" or
"SNET_OK";
Subordinated_CM_Codes String 64 ” Codes from Connection Manager
that are subordinate to the ADSL
Diagnostic Monitor code.
None currently used at S60.
Successfil_Cause_Codes String 64 Typical values, Cause codes that indicate a
these may vary: successful call closure.
"0x0000,0x0080,
0x0090"
Test_Prefix String I 64 "TEST_RESULT I Prefix for test result files.
TickLineChanged DWORD I N/A 0 Tick count when the line last
changed
TickNextTest DWORD I N/A I 0 Tick count when the next test will
be performed. Indicates permanent
failure.
USE_SINGLE_PING_FOR_KA DWORD I N/A 1
VOICE_PRIME_NUMBER String 64 N/A The primary ‘voice’ number for this
outlet.
VOICE_SECONDARY_NUMBE I String 64 N/A The secondary 'voice' number for
R this outlet.
VOICE_TERTIARY_NUMBER I String I 64 N/A The tertiary ‘voice’ number for this
outlet.
DN n String 64 N/A IP Address for the VPN Server
VPN_SERVER_PINGED being pinged.
VPNI_ADDR String 64 N/A IP Address of the 1* VPN server
listed in the policy file.
VPN2_ADDR String 64 N/A IP Address of the 2"! VPN server
listed in the policy file.
VPN3_ADDR String 64 N/A IP Address of the 3! VPN server
listed in the policy file.
VPN4_ADDR String 64 N/A IP Address of the 4" VPN server
listed in the policy file.
VPN5_ADDR String 64 N/A IP Address of the 5" VPN server
listed in the policy file.
VPN6_ADDR String 64 N/A IP Address of the 6" VPN server
listed in the policy file.
VPN7_ADDR String 64 N/A IP Address of the 7" VPN server
© 2006 Fujitsu Services Company in Confidence Page 84
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
listed in the policy file.
VPN8_ADDR String I 64 = I N/A IP Address of the 8 VPN server
listed in the policy file
Table 48 Registry Entries - Live
4.1.3. Period Registry
The NT registry key [HKEY_LOCAL_MACHINE\SOFTWARE\ICL\Pathway Configuration\CNIM\ Period]
is used to store data for the "Period" file. The following key values are defined:
Name Type Max I Default Description
size value
FRIACO_Time_Secs , N/A 0 Total number of FRIACO seconds in
DWORD ‘Nailed Up' period
Metered_Call_Count DWORD N/A 0 Total number of metered calls in 'Nailed
Up' period
Metered_Time_Secs DWORD N/A 0 Total number of metered seconds in
"Nailed Up! period
Start_Date String N/A N/A Date at which CNIM started monitoring
— format "11/09/2002"
Start_Time String N/A N/A Time at which CNIM started monitoring.
— format "14:26:36:986"
Total_Time_Secs DWORD N/A 0 Total number of FRIACO and metered.
seconds in 'Nailed Up' period
Table 49 Registry Entries - Period
4.1.3.g RPC Registry
The NT registry key [HKEY_LOCAL_MACHINE\SOFTWAREUCL\Pathway Configuration\ CNIM\RPC] is
used to set the maximum number of RPC connections that CNIM will accept. The following key
value is defined:
Name Type Max Default Description
size value
Max_Connections. DWORD I N/A 000000c8 Max number of threads
Table 50 Registry Entries - RPC
4.1.3.h Test Results Registry
The NT registry key
[HKEY_LOCAL_MACHINE\SOFTWARE\ICL\PathwayConfiguration\CNIM\TestResults] is used to store
the test results. The following key values are defined:
Name Type Max Default Description
size value
CNIM_Result_Path Siring oF “CATEMPICNIM_ RES O*HO8 OF CNIM Results
ul BAT"
dwimpTestResult DWORD I N/A 0 0= Fail
1 = Pass
ImpTestResult String 64 N/A Test result:
© 2006 Fujitsu Services Company in Confidence Page 85
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
"PASS" or "FAIL"
Number_1 String 64 N/A 1 Number tested
Number_1_dwResult DWORD I N/A 0 0 = Unknown
1 = Layer I Fail
2=Num. Not Tested
3 = Num. Fail
4=Num. OK
Number_1_Result String 64 N/A Test result for Number 1:
"UNKNOWN"
"LAYERI_FAIL"
"NUM_NOT_TESTED"
"NUM_FAIL"
"NUM_OK"
Number_2 String 64 N/A 2"! Number tested
Number_2_dwResult DWORD I N/A 0 As for 1 above.
Number_2_Result String 64 N/A As for I above.
Number_3 String 64 N/A 3" Number tested
Number_3_dwResult DWORD I N/A 0 As for 1 above.
Number_3_Result String 64 N/A As for I above.
Number_4 String 64 N/A 4" Number tested
Number_4_dwResult DWORD I N/A 0 As for I above.
Number_4_Result String 64 N/A As for I above.
Number_5 String 64 5" Number tested
Number_S_dwResult DWORD I N/A 0 As for I above.
Number_5_Result String 64 As for 1 above.
Number_6 String 64 6" Number tested
Number_6_dwResult DWORD I N/A 0 As for I above.
Number_6_Result String 64 As for I above.
RunnerTrigger_Path String 64 "C:\Autoconfig\Runn I Location of RunnerTrigger
erTrigger.exe" executable
Test_Date String 64 N/A Date of Test e.g. "2002/12/31"
Test_Time String 64 N/A Time of Test e.g. "13:40:50"
4.1.3.1 Times Registry
Table 51 Registry Entries - Test Results
The NT registry key IHKEY_LOCAL_MACHINE\SOFTWARE\ICL\Pathway Configuration\CNIM\ Times]
is used to control the operational state of CNIM. The following key values are defined:
Name Type Max Default value I Description
size (DWORD in
Hex)
OFFSET_RIT STRING 160 Offset in minutes
CM_Reset_Timeout DWORD 0000ea60 60000 milliseconds for
Connection Manager to
© 2006 Fujitsu Services
Company in Confidence
Page 86
Fujitsu
Services
CNIM Low Level Design
FUJ00171956
FUJ00171956
Ref: RS/LLD/004
COMPANY IN CONFIDENCE
Version: 4.0
Date: 8/05/2006
CM_Reread_Delay
Dial_Back_KA_Max
Actual_Overhang
CHAP _Interval_ISDN
CHAP _Interval_Non_ISDN
Dial_Back_Idle_Timeout
FRIACO_Metered_Time_Max
FRIACO_Metered_Time_Min
Line_Test_Timeout
Max_Overhang
Min_Overhang
Max_Tick_Deviation
MCDT Fixed
MCDT_MOD
MCDT_VOD
OFFSET_FE_FF
DWORD
DWORD
DWORD
DWORD
DWORD
DWORD
DWORD
DWORD
DWORD
DWORD
DWORD
DWORD
DWORD
DWORD
DWORD
String
N/A
N/A
N/A
N/A
N/A
N/A
NA
N/A
N/A
N/A
N/A
N/A
N/A
NA
000003e8
000000078
0
00000000a
000004b0
00000384
0000012c¢
78
0000003c
000003e8
00000000a
000000000
000000014
mse
respond
1000 milliseconds before
checking if Connection
Manager has updated registry
120 sec dial back max. time
Actual time in seconds beyond
the nominal call plan time at
which the connection type is
changed.
Challenge Handshake
Authentication Protocol
interval — in ISDN mode. The
interval in seconds, between
authentications.
Challenge Handshake
Authentication Protocol
interval — in non ISDN mode.
The interval in seconds,
between authentications.
Maximum time to wait for the
line to go idle before dialling
back.
Maximum time for Keep Alive
when FRIACO is at
Dialaround.(Sec.)
Minimum time for Keep Alive
when FRIACO is at
Dialaround. (Sec.)
Timeout (sec.) when doing an
implementation test.
Maximum time in seconds
beyond the nominal call plan
time at which the connection
type is changed.
Minimum time in seconds
beyond the nominal call plan
time at which the connection
type is changed.
Variation in tick count which
is ignored between GetStatus
calls.
Minimum Call Duration Time -
Fixed Period
Minimum Call Duration Time
— Dialled Period
Minimum Call Duration Time
— Voice on Demand
Maximum offset of boundary
in minutes between FRIACO-
Establish and FRIACO-Fixed.
© 2006 Fujitsu Services
Company in Confidence
Page 87
Fujitsu
Services
CNIM Low Level Design
COMPANY IN CONFIDENCE
FU.
Ref: RS/LLD/004
Version: 4.0
Date: 8/05/2006
FUJ00171956
}J00171956
OFFSET_FE_MOD
OFFSET_FF_MF
OFFSET_FF_MOD
OFFSET_MF_FF
OFFSET_MF_MOD
OFFSET_MOD_FE
OFFSET_MOD_MF
String 64 "10"
String 64 "1s"
String 64 "10"
String 64 "5"
String 64 "10"
String 64 "is"
String 64 "1s"
Maximum offset of boundary
in minutes between FRIACO-
Establish and Metered-On-
Demand.
Maximum offset of boundary
in minutes between FRIACO-
Fixed and FRIACO-Fixed.
Maximum offset of boundary
in minutes between FRIACO-
Fixed and Metered-On-
Demand.
Maximum offset of boundary
in minutes between Metered-
Fixed and FRIACO-Fixed.
Maximum offset of boundary
in minutes between Metered-
Fixed and Metered-On-
Demand.
Maximum offset of boundary
in minutes between Metered-
Fixed and FRIACO-Fixed.
Maximum offset of boundary
in minutes between Metered-
On-Demand and Metered-
Fixed.
Permanent_Fail_Counter
Permanent_Fail_Timer
Ping_Timeout_Seconds_Satellit
e
Ping_Timeout_Microseconds
Ping_Timeout_Seconds
Shorthold_Fixed
Shorthold_ MOD
Shorthold_VOD
Test_Thread_Shutdown_Timeou
t
Test_Timer_Max
Test_Timer_Min
DWORD N/A Oxfit
DWORD NA
DWORD N/A 28
DWORD
DWORD
DWORD
N/A
N/A
N/A
pus
Es
DWORD NA
wn
DWORD N/A 5
DWORD N/A 0000000f
DWORD N/A
DWORD N/A
Maximum number of failed
call attempts before permanent
fail flag is set
Effectively no longer used.
Afier trying to connect using
Mode I & 2 numbers for this
time period, Mode 3 numbers
are attempted.
Satellite Ping Timeout. (Sec.)
Ping microsecond Timeout
Ping Timeout. (Sec.)
Time that the line is held open
for — Fixed period
Time that the line is held open
for — Metered On Demand
Time that the line is held open
for — Voice On Demand
Maximum time to spend
waiting for test thread to stop.
(Sec.)
Maximum time between tests
(sec.).
Minimum time between tests
(sec.).
© 2006 Fujitsu Services
Company in Confidence
Page 88
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Table 52 Registry Entries - Times
The NT registry key [HKEY_LOCAL_MACHINE\SOFTWARE\ICL Pathway Configuration\ CNIM\Users]
is used to control the users ID’s and passwords to connect via data or ISDN (voice). The
following key values are defined:
Name Type Max Default Description
size value
Inbound_Stored DWORD N/A N/A
PW_Inbound_Data String 64 “BSJ3TSS" Password for data
PW_Inbound_ISDN String 64 N/A PASSWORD FOR ISDN
(VOICE)
UID_Inbound_Data String 64 "ENERGISCVX" User ID for data
UID_Inbound_ISDN String 64 N/A User ID for ISDN (voice)
Table 53 Registry Entries - Users
4.1.3.) SubAddressing Registry
The NT registry key
[HKEY_LOCAL_MACHINE\SOFTWARE\ICL\PathwayConfiguration\CNIM\SubAddressing] is used to
control incoming calls and prevent the call being accepted, thereby saving the cost of accepting
the call. This facility is not used at present.
Name Type Max Default Description
size value
MSN String N/A NA
Subaddress String N/A N/A
Table 54 Registry Entries - Sub Addressing
4.1.3.k Trace Registry
The NT registry key [HKEY_LOCAL_MACHINE\SOFTWARE\ICL\Pathway Configuration\ Trace\CNIM]
is used to control trace logging. The following key values are defined:
Name Type Max Default Description
size value
NumMaxLines DWORD I N/A 00000740 Maximum number of
lines in log file
TraceFile String I 64 "CACNIM\Trace\CNIM. log" Location of the trace
file
TraceLevel DWORD I N/A Oxi Trace level for normal
use.
WriteInterval DWORD I N/A 1 Number of lines to
cache between writes.
Table 55 Registry Entries - Tracing
© 2006 Fujitsu Services Company in Confidence Page 89
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
4.1.3.1 TuneableTrace Registry
The NT registry key [HKEY_LOCAL_MACHINE\SOFTWARE\ICL\Pathway Configuration\
CNIM\TuneableTrace] is used to control logging to TuneableTrace. The following key values are
defined:
Name Type Max Default Description
size value
ID String 64 "NULL" Top level ID
Namel String 64 "cnim" 1“ level name
Name2 String 64 "service" 2™ level name
Table 56 Registry Entries - TuneableTrace
A hierarchy of names is used to map onto the 'Namel, Name2, Instance’ structure of the client
table used by TuneableTrace. For VB clients the 'Instance name’ used should be NULL. The
Instance key has one mandatory value entry, 'TraceLevel’ the value of which is a 32 bit trace
level. Optionally, a value named 'Expiration' can be used which will prevent the unique set of
keys identifying a particular client being deleted once used. The 'TraceLevel' and 'Expiration'
value names are case sensitive. The value takes the format of a six digit date string in the
format YYMMDD.
The NT registry key [HKEY_LOCAL_MACHINE\SOFTWARE\ICL\Pathway — Configuration\
CNIM\TuneableTrace\cnim\service\null] is used to control logging to TuneableTrace. The following
key values are defined:
Name Type Max Default Description
size value
Expiration Sirmg I 64 "91231" Keep this trace level until the date shown
TraceLevel DWorD I N/A Ox2f08F Normal level of Tracing
Table 57 Registry Entries - CNIM TuneableTrace
4.1.3.m_ Service Event Registry
The NT registry key
[HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EventLog\Application\CNIM] is used to
specify the message path. The following key values are defined:
Name Type Max I Default Description
size I value
TypesSupported DWORD I N/A I7 Eventlog
EventMessageFile String I 64 "c:\cnim\cnim_msg.dil"__ I Event Message File location
Table 58 Registry Entries - Message Path
4.1.3.n Service Dependency Registry
The NT registry key [HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\CNIM] is used to
specify the dependency on the RPC service.
Name Type Max I Default Description
size I value
© 2006 Fujitsu Services Company in Confidence Page 90
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
DEPENDONSERVICE I HEX. [N/A J 52,70,63,53,73,00,00 RPC
DEPENDONGROUP I HEX) I N/A I 00
Table 59 Registry Entries - CNIM Service Dependency on RPC
41.3.0 Eicon Registry
The NT registry key [HKEY_LOCAL_MACHINE\SOFTWARE\ICL\Pathway Configuration\Eicon] is used
to control the input data to CNIM. The following key values are defined:
Name Type Max I Default Description
size value
DP String 64 N/A Dialaround Primary
DS String 64 N/A Dialaround Secondary
FCIP String 64 N/A FRIACO I Primary
FCIS String 64 N/A FRIACO 1 Secondary
FC2P String 64 N/A FRIACO 2 Primary
FC2S String 64 N/A FRIACO 2 Secondary
MP String 64 N/A Metered Primary
MS String 64 N/A Metered Secondary
SERVICETYPE String 64 N/A Service Type
VP String I 64 N/A Voice Primary
VS String 64 N/A Voice Secondary
VT String I 64 N/A Voice Tertiary
Table 60 CDF Data Storage in Registry
41.3.p User Registry
The NT registry key [HKEY_LOCAL_MACHINE\SOFTWARE\ICL\Pathway Configuration\CNIM\Users]
is used to control the input data to CNIM. The following key values are defined:
Name Type Max I Default Description
size value
PW Inbound ISDN I String 64 N/A Extracted from the Eicon card when CNIM.
~ ~ first installed, and stored in registry.
PW _ Inbound Data String 64 “£5j3ts5” Password expected to be received when using
— _ the Data network.
UID Inbound Data I String 64 “energiscvx” I User ID expected to be received when using
_ _ the Data network.
Inbound Stored dword N/A 00000000 Set to 1 on CNIM installation when the ISDN
~ Inbound password has been stored.
Table 61 User Data Storage in Registry
© 2006 Fujitsu Services Company in Confidence Page 91
Fujitsu
Services
FUJ00171956
FUJ00171956
CNIM Low Level Design Ref: RS/LLD/004
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
4.1.3.qg Connection Manager Registry
The NT registry key [HKLM\Software\Fujitsu\POA\ConnectionManager'State] is used to display service
and connection state information. The following key values are defined:
Name
Type
Max
size
Default
value
Description
DayD
DWOR
D
V/A
0
Set to 1 when Connection Manager enters DayD dialling mode, set fo 0 otherwise,
HeartBeat
DWOR
D
N/A
N/A
Unless the service is Idle or Suspended, this registry value is updated to the value of
GetTickCount at a rate determined by the ConnectionManager\HeartBeat value.
Status
String
N/A
N/A
Reports a change of dialling state, as a comma-separated set of fields.
Eaxample:
D,Data_Centre,210,01/12/2005 00:02:37.571
Suspended
String
N/A
N/A
This value is set to non-null if the Connection Manager service has entered a suspended
state. It is set back to null on entry to a non-suspended state or when the service stops.
Values defined are
N ‘The Network type is undefined or is not one of VSAT, ISDN or ADSL
x The network type is indeterminate following an incomplete switch operation
s The main Service configuration is invalid
D ‘The current Dial mode configuration is invalid
CurrentDialParams
String
N/A
N/A
This is a comma separated string holding:
Call ID, username, phone number, device type, device name and
Port
Example:
49, h2000610010100A,01344123456,isdn,ISDN,ADSL1
LastConnection
Siring
N/A
N/A
This is a comma separated string holding:
username, phone number, device type, device name, port,
phonebook entry name, call ID and timestamp.
Example:
h2000610010100A,01234 567890, isdn,ISDN,ADSL,Data
Centre,001,04/08/2005 06:31:01.001
LastDisconnection
String
N/A
N/A
This is a comma separated string holding the same data as Status
but remains unchanged until the next disconenction.
Example:
X,Data_Centre,209,01/12/2005 00:02:37.261,C,R
RASConnectionState
String
N/A
N/A
Holds entries like:
"Dialling"
"Authenticating"
"Connected"
"Disconnected"
Table 62 Connection Manager Registry
4.1.3... Interface with ADSL Diagnostic Monitor
The NT registry key [HKLM\Sofiware\Fujitsu\POA\ADSLDiagnosticMonitor] is used to request connection
state information. The following key value is defined:
© 2006 Fujitsu Services
Company in Confidence Page 92
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Name Type Max Default Description
size value
GetConnectionStatusF lag DWORD IN/A N/A Flag set to I by CNIM to request data and to
0 by ADM when data available
Table 63 ADSL Diagnostic Monitor Registry
The NT registry key [HKLM\Software\Pathway Configuration\ CNIM\ADSLDiagnosticMonitor] is used to
store connection state information. The following key values are defined:
Name Type Max I Default Description
size value
ConnectionState DWORD IN/A N/A Connection state as an integer value
StatusTickCount [DWORD IN/A I N/A Tick count when status data set
TimeOut DWORD IN/A I 5000 Timeout in milliseconds waiting for data from ADM
Table 64 CNIM ADSL Diagnostic Monitor Data
4.1.3.8 CNIM NST Groups
These values are used by CNIM to determine its mode of operation.
({HKEY_LOCAL_MACHINE\SOFTWARE\ICL\Pathway Configuration\ CNIM\ NST_Groups]
Value Type Entry Description
ADSL String I "13" ADSL Service type
FMRY String I "03" Frame Relay Service Type
ISDN String "01,04,05,06,07,08,09,10,11,12" ISDN/Data Service Types
VSAT String "02" VSAT Service Type
Table 65 CNIM NST Groupings
4.1.3.t_ CNIM Network Settings
These values are used by CNIM to display current network type
[HKEY_LOCAL_MACHINE\SOFTWARE\ICL\Pathway Configuration\ CNIM\ Network]
Value Type Entry Description
"Type" String I "ADSL" I"FMRY" I "ISDN" I "VSAT" Network Type
Table 66 CNIM Network Settings
4.1.3.u Bandwidth Configuration Settings
Detailed bandwidth design is shown in 5.7.3.c
The bandwidth configuration settings shown below are used to set the payload sizes for the
large and small pings. CNIM will use these values to set the payload for the two bandwidth
pings.
The overall difference in the ping size is also stored in registry and CNIM will use this value in
determining the bandwidth value.
{HKEY_LOCAL_MACHINE\SOFTWARE\ICL\Pathway Configuration\CNIM\Bandwidth]
© 2006 Fujitsu Services Company in Confidence Page 93
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Value Type Entry Description
LargePayload_Bytes DWORD 966 Payload in bytes for large ping
SmallPayload_Bytes DWORD 32 Payload in bytes for small ping
PingDifference_Bits DWORD 7680 Difference in ping size
MaxValue DWORD 512000 Cutoff value to prevent excessive
values being produced
Table 67 Bandwidth Configurat
Related result codes are shown below.
[HKEY_LOCAL_MACHINE\SOFTWARE\ICL\Pathway Configuration\CNIM\Bandwidth\ResultCodes}
tion Settings
Value Type Entry Description
P1<P2 DWORD 0 Ping 1 Round Trip Time(RTT) less
than that for Ping 2 - Success.
P1_Failed DWORD 1 Ping I failed
P2_Failed DWORD 2 Ping 2 failed
Pl_And_P2 Failed DWORD 3 Both pings failed
Max ValucExceeded DWORD 4 The calculated value exceeds the
maximum possible bandwidth.
P2<P1 DWORD 10 Ping 2 Round Trip Time(RTT) less
than that for Ping I - Fail.
Table 68 Bandwidth Result Codes
4.2 Interfaces Used
The following interfaces will be used:
The NT Service Control Manager, SCM, will control the service.
Win32 API is used to access NT resources, e.g. the NT registry.
Eicon IDI gives direct access to the Eicon driver and may be used to monitor line state and
to request indications of line events.
Eicon DIAPI is used to manage Eicon card parameters
Connection Manager registry data
© 2006 Fujitsu Services
Company in Confidence Page 94
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
5 DESIGN OVERVIEW
5.1 Service Definition
CNIM is an NT service with the following properties:
1) The service name is “CNIM’, and the display name is “CNIM”.
2) The service is self-configuring. That is it can be created and deleted using a command line
parameter, not a separate utility.
3) The service is run under the LocalSystem account on the outlet’s gateway PC.
4) The service reports any errors and significant activity using the NT event log. The event log
source name is “CNIM”.
5) The service will be configured to start automatically.
6) It can be stopped and started using Service Control API functions (OpenService(),
StartService(), ControlService()). It does not support pause and resume.
7) The service executable file will have an embedded version number resource to identify itself.
5.2. CNIM Service Design Overview
Requirement: See section 2.2.1
CNIM will be compiled as a single executable which will run as a service.
CNIM will link to the IDI interface using its own library comprising source code supplied by
Eicon.
CNIM will link to the DIAPI interface and the DIAPI DLL will be installed with the service.
CNIM will link to the TuneableTrace DLL which is installed as part of the BI3 upgrade
5.2.1 Service Dependencies
CNIM is dependent on the RPC service for communication with the CNIM_APLdll. CNIM is
also dependent on the VPN service in that WAN communication to the Data Centre is not
possible without VPN running. On start up CNIM will check the status of both services and will
not proceed until both are running.
CNIM is also dependent on the ADSL Diagnostic Monitor service and the Connection Manager
service, whilst running in ADSL mode, to supply diagnostic data. CNIM may continue to run
without these two services but will display a red error event.
5.3. Eicon Card Configuration Design Overview
Requirement: See section 2.2.7.
5.3.1 Card Parameter Storage
Eicon card parameters will be stored in registry. The parameters to be stored are explained in
section 2.2.7.
5.3.1.a Phone Numbers and Network Service Type
Phone numbers and the Network Service Type, are supplied to the outlet via a CDF file. The
file contents are processed by EiconConfig and placed in registry as shown in section 4.1.3.0.,
for use by CNIM.
© 2006 Fujitsu Services Company in Confidence Page 95
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
5.3.1.6 CHAP Passwords and User Ids
CHAP password and UID information is held in registry as shown in section 4.1.3.p.
The data network Inbound User ID and Password is configured into registry before CNIM is
installed. It is the responsibility of CNIM to extract the existing ISDN inbound password from
the card during installation. It is assumed at installation, that the card is configured to use the
ISDN network. CNIM will store this password in registry and set the registry flag
“Inbound_Stored” to I after storage.
CNIM will add the User ID stored in registry under “UID_Inbound_Data”, to the set of
inbound user Ids that the card will accept
5.3.1.¢ Shorthold, Minimum Call Duration and CHAP Interval Times
These parameters are shown in section 2.2.7.4. These are supplied to CNIM during installation
and CNIM uses them to modify the behaviour of the card, depending on the connection type
required.
5.3.2 Card Parameter Application
Eicon card parameters will be applied via the DIAPI interface. This is a set of functions
contained within the DIAPI DLL. CNIM will statically link to this DLL and so it must be
present on all gateway platforms including satellite gateways, even though it can perform no
function in the latter instance.
The Diapi ISDN interface for Windows NT allows a user to communicate with the ISDN
network through a set of language functions via the Eicon communications adapter.
More detail on this is given in Appendix A9.
5.4 Network Service Type Design Overview
Requirement: See section 2.2.7.b
The network service type (NST) is passed to the outlet as part of the CDF file and is stored in
registry. CNIM uses the NST to determine which table within the Call Plan applies to the outlet.
CNIM will run in one of three modes, ADSL, ISDN or VSAT. It will only react to those events
that are appropriate for its current mode.
CNIM will retrieve the mode of operation from the Network Service Type and the
NST_Groupings sections of registry.
When in ISDN mode CNIM will react to network events from those objects that receive
indications from the IDI. These are described below.
When in ADSL mode CNIM will listen for registry notification of network status updates from
Connection Manager.
In VSAT mode CNIM will simply rely on pinging the VPN Servers at regular intervals to
determine network status.
5.5 CDF Data Storage Design Overview
Requirement: See section 2.2.8.
CDF data in this context applies to phone numbers only. These are stored in the map shown on
the right (Phone Number from Registry) in the diagram below.
© 2006 Fujitsu Services Company in Confidence Page 96
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Four further maps are created for the four main service type groupings, namely FRIACO I and
2, Metered and Voice. These map the original numbers onto the FRIACO, metered and voice
numbers for a particular outlet. Finally three Connection Type maps are created which map the
Service Type maps to the Modes 1, 2 and 3 numbers required for each connection type.
CNIM will attempt to use the Mode I number at all times. Failing that it will move to Mode 2
temporarily. Should Mode 2 fail to work then the card will be configured with Mode 3 numbers
© 2006 Fujitsu Services Company in Confidence Page 97
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
which, in practise, will be ISDN numbers.
Figure 11 Telephone number mapping from Registry
Each connection type (FRIACO, Metered and Voice) has a maximum of six 7 telephone
numbers which it can try to establish a connection to the data centre. These numbers are
© 2006 Fujitsu Services Company in Confidence Page 98
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
grouped in order of priority into Mode I (MIP and MIS), the numbers to be tried first, Mode 2
(M2P and M2S), and Mode 3 (M3P, M3S and M3T) as is illustrated in the above diagram.
The above diagram is simplified in CNIM Version 2, in that only one number is applied per
mode. Therefore the concept of a primary and secondary number per mode is not used. This is
covered in section 5.13.1 and means that for the purposes of the above diagram only MIP, M2P
and M3P numbers will be used.
5.6 Call Plan Design Overview
Requirement: See section 2.2.7.¢
The Call Plan comprises a number of tables within a file, each table comprising one record for
each day of the week. Each record comprises a number of elements which give the connection
type required for a given period of the day. The time span of the element is given to the nearest
minute.
CNIM creates a set of linked lists where the top most list comprises a set of tables. Each table
comprises a list of days and each day contains a list of elements.
Call Plan management requires that for a given Network Service Type, date and time the
appropriate element can be retrieved and from that element the required connection type
determined. The Network Service Type is used as the index to the first list to determine the
table in question. The day of the week determines which record in the table is required and the
time of day is used to determine which element in the record is required.
Call Plan maps are created on service start up and when the Reset function is called.
The Call Plan file name contains a date and time as shown in section 2.2.7.c.4. CNIM is
capable of determining which is the newer file should more than one Call Plan file be present in
the directory. Older files will be renamed with the suffix “.OLD”
5.7. QOS Logging Design Overview
Requirement: See section 2.2.9
Call logging is required in order to ensure that SLA’s are met and to help diagnose problems on
the network.
5.7.1 Call Logging - ISDN
In order to create the call logs, CNIM must be aware of the state of the line at all times. For
ISDN/Data network, this is done via the IDI interface
5.7.1.a The IDI Interface
The IDI is kernel mode interface used by drivers to access the ISDN adapter cards. Within the
IDI several adapter cards of the same or different type can be registered at the same time.
On top of the IDI other drivers as NDIS, CAPI or ECBIOS can be loaded.
All communication between the application and the IDI is related to 8-bit Ids. The Ids identify
the entity within the ISDN protocol the application is using. When a new ID is assigned the
related entity is configured at the same time. The global ID defines what type of entity shall be
assigned.
Three global Ids are currently defined:
0x00 Signalling entity
© 2006 Fujitsu Services Company in Confidence Page 99
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
0x20 Network Layer entity
OxeO Management entity
A simple application using a network layer protocol on one B-channel typically assigns two Ids.
A signalling entity to control call establishment and release and a network layer entity for the
network layer protocol. The network layer entity is typically assigned as soon as a call is
established. As part of the configuration the network layer protocol is selected and the related
signalling entity is specified at this time.
CNIM is primarily concerned with using the IDI at the management level although future work
may involve the use of signalling entities
The management interface is used to access (read and write) internally available information by
a client registered with the IDI. Additionally, specific actions or commands can be executed.
The internally available information can be divided into the following categories:
¢ Version information about the driver
e Configuration information (Configured ISDN numbers, MAC addresses...)
¢ Statistics information (Number of packets sent/received, error counters, ...)
e Status information (State variables, number of active calls, ...)
¢ XLOG Trace information
Standard IDI mechanisms (REQUESTs, INDICATIONSs, Information Elements) are defined to
access the management information. Due to this IDI access mechanism, a generic tool can be
used to handle the management information structures. Within this tool, no knowledge of any
driver/protocol specifics is required.
The management information is structured like a directory tree. Each variable or node is
identified by its path and name. A path contains node names (separated by a backslash ‘\’),
followed by the specific variable or node name (similar to a file system). Each node can contain
further nodes or variables.
A node can be read and returns the next deeper level of the directory tree. A variable can be
read, written or marked as ‘Notify on change’ depending on its attribute. Actions or commands
appear as ‘Executable Variables’ without a value that can be started with a specific request.
CNIM uses the three parameters shown in Table 69 to monitor the line state. CNIM is able to
request notification of changes to Line State and Layer 2 State. CNIM must proactively request
the latest value of Cause Code and may request the latest value of any other parameter.
Parameter Change State Description
Notification
Possible
Line State Yes Unknown Line State is Unknown
Line State Yes Idle Line State is Idle
Line State Yes Connected Out I Line State is Connected Out
Line State Yes Connected In Line State is Connected In
Layer 2 State Yes Unknown Layer 2 State is Unknown
Layer 2 State Yes Idle Layer 2 is Idle
© 2006 Fujitsu Services Company in Confidence Page 100
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Layer 2 State Yes Up Layer 2 is Up
Cause Code No String Value Reason for Call Closure
Table 69 IDI Parameter Description
5.7.1.6 Call Activation and Closure
In order to determine that a call has been initiated CNIM requests notification of the Layer 2
State. Layer 2 State will always change on a call attempt, even if the network cable has been
disconnected from the Eicon card.
On receiving this notification CNIM stores the initial time of the call. It will then request the
Line State which will give the call direction. This information determines which monitor file will
be used to store this call record. If a monitor file of the correct type does not exist for that day,
CNIM will create one and store the initial record which will show the call as being "open". If the
required monitor file does exist CNIM will parse the file to check that a previous record has not
been left "open". If any record has been left open it will be changed to "unknown". This record
should be disregarded for the purposes of QOS analysis.
CNIM will use the notification of Line State going Idle to determine when the call is closed.
The call record in memory will be updated with the time of call closure, call duration and call
result. The relevant monitor file will be parsed to find the equivalent open record and the record
will be overwritten with the updated record.
In the event that the call has gone over midnight (UTC) then CNIM will record the call closure
in the Monitor file for the day of call closure. Therefore this file will contain a record for a call
that started on the previous day. The original open record in the previous days file will be left
unchanged. This means that a monitor file may only have one open record and, if present, it
must be the last record in the file.
CNIM will use the same mechanism to create and update the summary file for each day,
although each summary file will only contains data for the day of that file.
5.7.2 Call Logging - VSAT
In order to determine the connection state, CNIM is only able to ping the data centre.
Successful return of the ping indicates that the call is open, whilst ping failure
indicates that the call is closed.
5.7.3 Call Logging - ADSL
Call logging under ADSL primarily will use the same technique as VSAT of
periodically pinging the data centre to determine that comms are available. However
CNIM may also determine the connection state using the following interfaces:
1) ADSL Diagnostic Monitor Registry
2) Connection Manager Registry
These are described in the following sections
© 2006 Fujitsu Services Company in Confidence Page 101
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
§.7.3.a ADSL Diagnostic Monitor Interface
CNIM 3 will interface to the Conexant card via the ADSL Diagnostic Monitor service. This will
allow CNIM to extract low level diagnostic connection data from the card for QOS record
purposes.
In the event that CNIM receives notification from Connection Manager that the ADSL
connection has been dropped it will request the latest connection status information from the
ADM service. This will be done by setting a registry flag, in the ADM area of registry, that will
cause the ADM to place the latest low level connection state in the CNIM area of registry. After
setting the ADM "GetConnectionStatusFlag” to 1, CNIM will wait to receive notification that
the connection state has been updated. It will check that the "GetConnectionStatusFlag" has
been reset to 0 by ADM as a sign that the data has indeed been updated. CNIM will incorporate
a timeout in its wait loop in the event that the ADM does not respond to the request.
The registry areas used for this process are described in section 4.1.3.1
5.7.3.6 Connection Manager Interface
These details are taken from Connection Manager detailed design, [Ref 15]
Registry details are given in section 4.1.3.q
The State\DayD registry value is set to one on entry to Day D dialling mode, and to zero on exit
from that mode. This flag is intended to allow CNIM to distinguish normal connections from
modem recovery connections.
The State\Suspended registry value is updated whenever the service leaves or enters the
Suspended state. It indicates whether or not the service is suspended, and if so, the reason for
suspension.
The State\Status registry value is updated each time the connection state changes, allowing
CNIM to determine the connection state. Note that there is a configured "settling" delay
between RAS reporting "connected" and the Connection Manager reporting "connected".
Other components in the system need to know the current connection state. Connection
Manager writes status information to the Status value under the key
HKLM\SOFTWARE\Fujitsu\POA\ConnectionManager\State, which other applications can
monitor using the Win32 registry change notification API.
The status information is provided as a comma-separated list. The first field of the list identifies
a particular state and the remaining fields give extra information appropriate to the state. These
fields are described in detail below.
Where status information relates to a particular connection, the phonebook entry name is given.
Since it is likely that consecutive connection attempts will use the same phonebook entry, a
sequence number is associated with each connection attempt, and that number is included in the
state information. The sequence number is held in the registry, and is therefore persistent across
service instances. It is initialised to zero when Connection Manager is installed, and is
incremented before each dial attempt’.
The State key has three other values under it: a flag that indicates Day D dialling, a flag that
indicates suspension of the service, and a heartbeat value which is updated periodically. Note
* This value is a DWORD, so is unlikely to wrap in the lifetime of any particular
Gateway.
© 2006 Fujitsu Services Company in Confidence Page 102
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
that an application can only monitor a registry key and not individual values, so a change to any
of the values under the State key can cause a change notification. Monitoring applications may
need to keep previous values to determine what has changed. The heartbeat value allows an
application to notice if Connection Manager is not in its normal dialling cycle.
The Suspended flag can have one of the following string values:
Suspended Description
Value
null The service is not suspended
D The default dial mode configuration is invalid
N The Network Type is invalid or undefined
Ss The service configuration is invalid
xX The last network type switch has not completed
The first field of the Status value is a single letter, indicating a connection state, as shown in the
following table.
Connection Description
State
N Not connected. There is no additional information with this status.
Not Connected is set when:
- _ the service enters the idle state
- the service enters the suspended state at start-up because of an invalid or
indeterminate network type
- _ the service enters the suspended state on the first attempt to read the top-level
configuration data
- the dial mode configuration is invalid on the first entry to PrepareToDial and the
service is suspended
- no existing connection is adopted on the first entry to PrepareToDial
In other words, Not Connected is only set as an initial state. Once the Connection
Manager has attempted a connection, the status will not show Nof Connected until the
service is restarted, but will always be one of Dialling, Failed to connect, Connected or
Disconnected.
Example:
N
D Dialling.
The dialling state is set just before dialling starts. The second field names the
phonebook entry being dialled. The third field is a sequence number. The fourth field
is the UTC time that dialling started.
Example:
D,Data_Centre,397,04/08/03 15:28:37.292
Cc Connected.
The connected state is set after a RAS connection has been established for the
configured Settle time. The second field names the phonebook entry. The third field is
© 2006 Fujitsu Services Company in Confidence Page 103
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
the sequence number. The fourth field is the UTC time at which this state was reported
i.e. the end of the settle period.
Example:
C,Data_Centre,397,04/08/03 15:28:52.177
F Failed to connect.
The failed to connect is set if a dial attempt fails. The second field names the phonebook
entry. The third field is the sequence number. The fourth field is the UTC time that the
failure was detected. The fifth field may be R, indicating an error returned from
RasDial, or C, indicating that Connection Manager hung-up the connection.
If the fifth field is R, the sixth field gives the RAS error as an 8-digit hexadecimal
number.
If the fifth field is C, The sixth field can be one of
T = timed out
interrupted by Day D dial request
R = interrupted by a Reset request
S = interrupted by Service Stop request
B = interrupted by Black Hole error
Examples:
F,Data_Centre,502,12/08/2003 13:03:07.953,R,00000279
F,Data_Centre,503, 12/08/2003 13:05:43.288,C,S
x Disconnected.
The disconnected state is entered if an established connection becomes disconnected.
The second field names the phonebook entry. The third field is the sequence number.
The fourth field is the UTC time that the disconnection was detected. The fifth field may
be R, indicating an error returned from RAS via RasGetConnectStatus, or C, indicating
that Connection Manager hung-up the connection.
Ifthe fifth field is R, the sixth field gives the RAS error as an 8-digit hexadecimal
number. Ifno error is associated with the disconnection, this field will be 00000000.
If the fifth field is C, The sixth field can be one of
D = disconnected by Day D dial request
lisconnected by a Reset request
S = disconnected by Service Stop request
B = disconnected by Black Hole error
Examples:
X,Data_Centre,397,04/08/03 15:37:19.361,R,00000276 X,Data_Centre,398,04/08/03
§.7.3.c Bandwidth Calculation - ADSL Only
Bandwidth measure
Bandwidth will only be measured at ADSL connected outlets whilst there is an ADSL
connection to the data centre. This data will be used to ensure that sufficient bandwidth is
© 2006 Fujitsu Services Company in Confidence Page 104
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
available from the ADSL network for Post Office requirements and to determine if any
particular outlet has too little bandwidth available.
The standard ping command will be used by CNIM to determine the bandwidth available to the
data centre. In order to ensure meaningful results from the ping command, which by definition
has a small payload, a number of factors need to be considered within the calculation:
= Latency
The available bandwidth will be determined by measuring the responses times of two ping
commands, of different sizes, targeted at the data centre, submitted consecutively. As the
ping requests are submitted consecutively the latency element of the two response times will
be the same, allowing it to be removed from the final bandwidth calculation.
= Comms headers
A ping request is made up of the payload (as defined on the command line) and a number of
headers:
a ICMP
o IP
ao VPN
a VPN IP
a PPP frame
ao VCMUX
In order to calculate the available bandwidth CNIM will need to take these headers into
account, therefore along with the configuration information detailing the two ping payload
sizes (in bits) a further value will be supplied which will define the actual difference in ping
sizes in bits, again including headers.
= ATM cell mapping
The ping request will be split up into a number of ATM cells, 53 bytes in size. Of the 53
bytes, 5 bytes hold ATM header information, leaving 48 bytes to hold the payload, including
higher level protocol headers. It will be necessary to ensure that the ping payload size plus
comms headers, aligns as close as possible to an ATM cell boundary.
The frequency and sizing information will be included as registry parameters. The frequency of
the bandwidth test will randomised, so as to avoid all outlets checking the bandwidth at the
same time. The following table defines the ping sizes and frequency parameters that will be
included in the NT registry, see section 4.1.3.u
These need to be confirmed (they will change as they do not include all the overheads).
Small ping size 32 bytes
Large ping size 922 bytes
Difference in bits 7680 bits
Average time between 5 minutes
© 2006 Fujitsu Services Company in Confidence Page 105
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
bandwidth checks
Due to the very small ping round trip times being measured it will be necessary to use the NT
high resolution timer. The high resolution timer return 64 bit values therefore all calculations
will need to take this into account. The bandwidth can be calculated as follows:
© 2006 Fujitsu Services Company in Confidence Page 106
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Time difference in milliseconds
Ping size difference in bits X 1,000,000
Proof of formula:
Size(small) = VPN Header + IP Header + Size small ping + ATM Cell Overheads
Size(large) = VPN Header + IP Header + Size small ping + ATM Cell Overheads +
Extra Size for large (including ATM overhead)
Size(diff) = Size(large)-Size(small) = Extra Size for large
Elapsed(small) = Latency + Size(small)/Bandwidth
Elapsed(large) = Latency + Size(large)/Bandwidth
Elapsed(diff) = Elapsed(large)-Elapsed(small) = (Latency + Size(large)/Bandwidth) -
(Latency + Size(large)/Bandwidth)
Elapsed(diff) = (Size(large)-Size(small))/Bandwidth = Size(diff) / Bandwidth
Bandwidth = Elapsed(diff) / Size(diff)
5.7.1.a.1 Bandwidth Pinging
CNIM uses the test thread to create the test ping. This same thread will carry out the bandwidth
ping and the bandwidth calculation and pass the result to the logger thread.
The logger thread will be responsible for inputting that data into the bandwidth file.
5.7.1.a.2 Bandwidth Return Codes
CNIM is required to provide a set of codes as the last field in the bandwidth record.
These codes are defined in Table 68. Note that a success code of "0" will only be
given if the round trip time for ping 1 is less than that for ping 2 and the resultant
calculated bandwidth value does not exceed the threshold specified in registry. If the
threshold value is exceeded then CNIM will set the bandwidth to 0 and output the
appropriate code as specified in registry.
5.8 Dial Back Design Overview
Requirement: See section 2.2.10
If the call into CNIM is an external call, i.c. from the Data Centre (via the ISDN Eicon card),
the Eicon card is pre-configured to ‘Reject’ the call. The Eicon IDI interface will notify CNIM
that a call occurred. On receipt of this notification, CNIM logs the reject call information, and
initiates a call to the Data Centre, i.e. ‘pings’ to the VPN servers.
CNIM is unaware of who called the Outlet, (Riposte, Tivoli or Support), therefore it is the
responsibility of the calling function to ‘wait’ and ‘try again’. If the call from CNIM to the Data
Centre has been successful, a tunnel will have been established to the appropriate LNS router,
and the Summary router notified of the ‘route’ to the Outlet. The calling function on attempting
the call again, will utilise this route/ tunnel established by the in-bound call from the Eicon card.
A ‘Call Reversal’ will only be sent to PO Outlets that are currently not connected to the Data
Centre. This may include Outlets that are deemed to be on a permanent connection (FRIACO or
Metered) but where the connection is currently down for whatever reason. The CNIM
ascertains the outlets network service type by reading the appropriate Registry entry. The
© 2006 Fujitsu Services Company in Confidence Page 107
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
number to be dialled in order to establish a call to the Data Centre is dependent on the day of
the week, time of day, and what connection type should be invoked for the outlet at this time of
day.
If the call to the Data Centre is successful, and the defined network connection type, is defined
as a permanent connection for FRIACO or Metered access, then the ‘Current’ network
connection type [CNET2], will be set to ‘P’ (permanent connection). Whereas if the first two
FRIACO calls fail but the third call (DialI-Around), by the Eicon driver is successful or that the
Outlet is deemed to be Metered Outlet then [CNET2] is set to ‘M’ (metered connection).
CNIM will only update the Registry entries after the Eicon card has successfully established a
call or failed in the attempt. CNIM will ascertain the outcome of the attempted call, by the fact
that the IDI reports the status of the attempted call, i.e. the successful number ‘called’ or the
Error code on a failed call. See Figure 12:
© 2006 Fujitsu Services Company in Confidence Page 108
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Gal ‘Ryectat by Hoon cand
'
IDO.
‘Notification of Reet Call
Y
SetRegitry try
“CalRorsl’ [REY]
Update Registy Extry
“Reject Cou’ [REICNT]
RENT +1
Wieall Hon
STATScal sive
(CNM CALL DATA CENIRE
Rosa Regbty Fany
“Call Rowral’ [REV]
=
Nate:
CCallonly fromDasa Cert, to PO Oates that re
NOTearatly comected by FRIACO or RermteComst
‘This modkie‘sactivated when the Beon card chs a call
ficmthe DG rejects thecal notes CNM wich das
bck urlsng the FRIACO cr Meterad Data nstwork,
Figure 12 Call Reversal
© 2006 Fujitsu Services Company in Confidence Page 109
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
5.9 Branch Resilient Network ISDN/GSM Switch Process
The Switch Network Use command is invoked by CNIM when a change between
normal and fallback network use involves a reboot i.e. when the primary network type
is NDIS ISDN. Reconfiguration is necessary because the Gateway's IP address is the
same for both primary and fallback networks. When the primary network and fallback
network(s) are using RAS the remote server provides the IP address, so there is no
conflict. When NDIS ISDN is in use the IP address is set locally, and would conflict
with the fallback RAS connection if not changed. Changing the IP address on the
Eicon card requires a reboot.
The command syntax is
cmCmd SWITCH_NETWORK_USE TO= (NORMAL I FALLBACK)
It updates the platform configuration so that, on reboot, the platform uses either its
normal or fallback network, and then signals the Desktop application to initiate the
reboot.
Success or failure of the command, as for all the CLI functions, is indicated by
ERRORLEVEL. However, the command is designed to be called from CNIM, and part
of the command's functionality is to stop the CNIM service. The result is therefore
also recorded in the registry value SwitchNetworkUseResult for CNIM to check after
the reboot.
The table below shows Switch process parameters that are relevant to CNIM.
[HKEY_LOCAL MACHINE \SOFTWARE\Fujitsu\POA\ConnectionManager\Switch]
Value Type Contents
SwitchNetworkUseResult I DWORD I 0 = Success
999 = Failure
TpDummy String 0.0.0.0
IpLive String IP address set by SYSMAN or CNIM
EiconIpAddressRef String Registry key and value in which to set the IP
address for the Eicon card.
HKLM\SYSTEM\CurrentControlSet\Services\
Diehl_DINDIS7\Parameters\Tcpip,[PAddress
Table 70 Connection Manager Switch Registry
The failover process on an ISDN outlet (FRIACO, Metered or Voice) whereby the
gateway switches to GSM will be as follows:
1) CNIM will detect that the GSM command button has been pressed.
2) CNIM will determine that the outlet is an ISDN outlet.
3) CNIM will set a persistent flag in registry indicating that the switch to GSM is
required. This is done by setting the "Connection_Type_Required" flag to GSM
together with a timestamp.
© 2006 Fujitsu Services Company in Confidence Page 110
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
5.10 Branch Resilient Network Interface with Connection Manager
CNIM will set the required RAS connection type within Connection Manager registry using the
DialMode value:
[HKEY_LOCAL_MACHINE\SOFTWARE \Fyjitsu\POA\ConnectionManager]
DialMode = string
Where the value of DialMode is taken from the following table
DialMode Description
“Normal”
Connect using normal behaviour for the Network Type i.e.
dialling on ADSL and idling on NDIS
“Idle”
Stop dialling even when the Network Type is ADSL
“Fallback_ISDN”
Connect using ISDN over RAS
“Fallback_GSM”
Connect using GSM over RAS
These strings will be stored in CNIM registry under the following key and values:
Table 71 DialMode Description
[HKEY_LOCAL_MACHINE\SOFTWARE\CL\Pathway Configuration\CNIM\Connection]
Value Contents
RAS_ADSL "Normal"
RAS_ISDN "Fallback ISDN"
RAS _GSM "Fallback GSM"
RAS_DROP "Idle"
Table 72 DialMode Strings in CNIM Registry
Note that the heartbeat only runs when dialling or connected - it doesn't run in the idle state and
that changing the dial mode always hangs up any current connection.
Use of the Reset flag below will cause Connection Manager to attempt to connect with the
required connection type
[HKEY_LOCAL_MACHINE\SOFTWARE\Fujitsu\POA \ConnectionManager\Triggers]
Reset = dword 00000001
The underlying network type for Connection Manager, is set using the NetworkType value
below, this value will not change even in the event of a different connection type being required.
[HKLM\SOFTWARE\Fujitsu\POA\ConnectionManager]
NetworkType = string
Where the value of NetworkType is taken from the table below:
© 2006 Fujitsu Services Company in Confidence Page 111
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
NetworkType Description
“ADSL” ADSL Gateway.
“VSAT” VSAT Gateway.
“ISDN” ISDN Gateway.
“indeterminate” Gateway failed to switch correctly
Table 73 Connection Manager Network Types
Note that CNIM will be responsible to determining that any changes to network
connectivity as registered by Connection Manager, are indeed of the right connection
type as requested by CNIM. It will do this by determining that any change in
connectivity occurred after the new connectivity was requested by CNIM. At present
Connection Manager inputs the number of the phonebook entry in use, into registry.
Currently on ADSL outlets CNIM uses Connection Manager registry data as input to
the QOS records related to each call. However as far as Counter Call Scheduler is
concerned CNIM uses its current ping status of success or fail, to determine whether
comms are available or not. To this end CNIM will not request Connection Manager to
change connection type unless all test pings have failed.
5.10.1 RAS Connection Type Information
CNIM can determine the type of RAS connection in use currently, by Connection Manager, by
use of the registry value CurrentDialParams which is a comma separated string holding:
call id, username, device type, device name, and port.
CNIM can determine the last connected type using the registry value LastConnection which is
the same as CurrentDialParams but with a timestamp, phonebook entry name and phone
number, added.
These values are also described in Table 62 and examples are shown below:
CurrentDialParams=49,h2000610010100A,0000,isdn,ISDN,ADSL1,
LastConnection=h20006 10010100A,0000,isdn,ISDN,ADSL1 ,Data_Centre,48,04/08/03 15:28:37.292
Table 75 gives details of the phonebook entries to be used. In particular CNIM
requires the entry for the port value in order to determine the connection type in use.
The values these will be compared against will be stored in registry using the values
shown in Table 74.
CNIM will check whether the string for the port value from Connection Manager
contains one of the strings shown in Table 74.
[HKEY_LOCAL_MACHINE\SOFTWARE\ICL\Pathway
Configuration\CNIM\Connection]
Value Type Contents
Con_Man_Port_ADSL String ADSL1
Con_Man_Port_ISDN String ISDN2
Con_Man_Port_GSM String COM11
© 2006 Fujitsu Services Company in Confidence Page 112
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
I Con_Man_Port_PSTN I String I Com10
Table 74 Port Contents for Connection Types
Phonebook Entry Device Device Name Port UserName Phone Number as
Type issued
Bootle_Boot_ISDN isdn DIWAN ISDN2 hFAD0010199
Bootle_Boot_PSTN modem Courier COM10 hFAD0010199
V.Everything
External
Wigan_Boot_ISDN isdn DIWAN ISDN2 hFADO010199
Wigan_Boot_PSTN modem Courier COM10 hFADO010199
V.Everything
External
Bootle_Day_D modem Courier COM10 hFADO010100
V.Everything B
External
Bootle_GSM modem Standard 19200 COM11 hFADO010100
bps Modem B
Wigan_Day_D modem Courier COM10 hFADO010100
V.Everything B
External
Wigan_GSM modem Standard 19200 COM11 hFADO010100
bps Modem B
Data_Centre isdn ISDN ADSL1 hFAD0010100
A It
Bootle_Fallback_GS I modem T-ModemCOM COM11 hFADO010100 I tbs
M c
Bootle_Fallback_ISD I isdn DIWAN ISDN2 hFADO010100 I tbs
N Cc
Wigan_Fallback_GS I modem T-ModemCOM COM11 hFADO010100 I tbs
M c
Wigan_Fallback_ISD I isdn DIWAN ISDN2 hFADO010100 I tbs
N Cc
Table 75 Connection Manager Phonebook Details
5.11 Determination of Failure Code
A failure code will be associated with each failed call. This code will be output to the relevant
QOS record and to Counter Call Scheduler. When running in VSAT mode CNIM can only use
codes defined for ping failure. In ISDN mode CNIM will use network cause codes primarily and
will revert to Fujitsu defined codes of no error cause code is received.
When running as ADSL, CNIM will use error values from Connection Manager if any are
available. If Connection Manager indicates no error and CNIM will query ADSL Diagnostic
Monitor for an error value. If no error is found and the ping has failed CNIM will use the
Fujitsu error codes.
Mode Primary Source I Secondary Source I Tertiary Source
© 2006 Fujitsu Services Company in Confidence Page 113
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
VSAT I Fujitsu Defined None None
Error Codes
ISDN_ I Network Codes Fujitsu Defined None
Via Eicon API Error Codes
ADSL I Connection Conexant via Fujitsu Defined
Manager Registry I ADM Registry Error Codes
Table 76 Determination of Failure Code
ISDN cause codes are shown in Appendix A4, RAS codes in Appendix A5,
Connection Manager codes are given in Appendix A6, Fujitsu codes are given in
Appendix A7 and CNIM codes are given in Appendix A8
5.11.1 Cause Code Ranges
Interface Code Range Description
Eicon Ox00nn ISDN Cause Codes in 2 byte format. See Appendix A4
Defined Ox Inn Fujitsu defined codes.
RAS 0x02nn Codes mapped from the Win32 RAS API
Conexant 0x03nn Codes mapped from data returned by ADSL Diagnostic Monitor
Connection Manager_I 0x04nn Codes mapped from data returned by Connection Manager
CNIM Defined Ox0Snn_ CNIM State Codes
RAS Ox06nn. RAS specific error codes from Microsoft
5.11.2 Eicon Cause Codes
Cause Codes are returned to the Eicon card on call closure and are a numeric indication of the
reason for the call closure.
Table 77 Cause Code Ranges
ISDN cause codes 0x00, 0x80 and 0x90 are considered successful codes in that no communication
failure has occurred. These successful codes are stored in registry under the key and variable
shown below:
For CNIM version 3, single byte ISDN cause codes will be mapped to 2 byte codes for
consistency with other codes being output.
({HKEY_LOCAL_MACHINE\SOFTWARE\ICL\Pathway Configuration\CNIM\Live]
"Successful_Cause_Codes"="0000,0080,0090,0100,0200,0300,0400,04 12,0413,0422,0423,0500,0600"
Any other cause code value will cause CNIM to consider that the call has failed.
© 2006 Fujitsu Services
Company in Confidence
Page 114
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
5.12 Engineers Button, Design Overview
An Engineers screen will be available to both the Engineer and the Post Master. It will
contain three buttons as well as connection status information. The three buttons are
listed below:
1. Initiate Connection
2. Test Connection
3. Drop Connection
These buttons will map directly to three DWORD values within CNIM registry as
shown below:
[HKEY_LOCAL_MACHINE\SOFTWARE\Fujitsu\POA\DesktopApplication\NetworkResilience\Triggers]
Value Type Possible Description
Entries
Connection DWORD I 0,1, 2,3 Value is the mode number, 0 is idle.
Drop DWORD I 0,1 1 = Drop
Test DWORD I 0,1 1 = Test
RebootStatus DWORD II 0, 1,2,3,4,5,99 Values set by CNIM or the Engineers App,
see the following table.
RebootNow String Any "Y" = Reboot now
Table 78 Engineers Button Trigger Registry
The values Connection, Drop and Test are set by the Button App. and are transient in
that any change in value will be read by CNIM and the value reset to zero. The Test
button will be set to zero at the end of the test.
The "Initiate Connection" button will lead to further options allowing a choice of
network type by the user. The user may choose Primary, Secondary or Tertiary
modes and these will put the values 1, 2 or 3 in the Connection value.
If the user wishes to drop the connection then the value of DROP is set to 1.
The RebootStatus value is used in the following way.
1) The user requests a certain connection type.
2) If CNIM determines that a reboot would be required it will put the RebootStatus
value to 1
3) If the Engineers App. see the value 1 it offers the user the option to continue with
the reboot or to cancel the change of connection.
4) If the user chooses to continue with the reboot then RebootStatus is set to 3.
5) If the user cancels the reboot then RebootStatus is set to 4.
6) If RebootStatus goes to 3 CNIM will set it to 5 indicating that it is about to call the
Switch process.
© 2006 Fujitsu Services Company in Confidence Page 115
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
7) On reboot CNIM will check the value of RebootStatus to determine whether it last
requested a reboot. It will then set it to zero.
8) If CNIM calls the Switch package then the RebootNow flag is set to "Y" by the
Switch package to indicate that the Engineers App. should initiate a reboot.
© 2006 Fujitsu Services Company in Confidence Page 116
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
5.12.1 BNR Static Data
The following table is used to store Reboot Static data for interaction with the
Engineers App. and the parameters to be given to the Switch package when switching
between NDIS and GSM backup.
It also contains the path to the Network Resilience area of registry.
[[HKEY_LOCAL_MACHINE\SOFTWARE\ICLIPathway Configuration\CNIM\Branch_Network_Resilience]
Value Type Possible Entries Description
RebootRequired DWORD I 1 CNIM indicates that a reboot will
be required
RebootNotRequired DWORD I 2 CNIM indicates that a reboot will
not be required
RebootCancelled DWORD I 4 Engineers App indicates that the
change of connection has been
cancelled by user, (Cancel).
RebootAuthorised DWORD I 3 Engineers App indicates that the
change of connection has been
uathorised by user, (OK).
RebootingNow DWORD I 5 CNIM indicates that it is rebooting.
This is for CNIM internal use
RebootCleared DWORD I 0 Default value, no action
RebootError DWORD I 99 An error has been detected
following the reboot. Engineers
App may indicate this to the user.
Switch_Command String "C:\\PathwayNetwork\\Connec I Path to the Switch application.
tionManager\\CmCmd.exe"
Switch_To_ISDN_Paramet I String "SWITCH_NETWORK_USE Parameters to give to the Switch
ers TO=NORMAL" application to switch to ISDN
(NDIS).
Switch_To_GSM_Paramet I String "SWITCH_NETWORK_USE Parameters to give to the Switch
ers TO=FALLBACK" application to switch to
GSM(RAS).
ButtonAppRegRef String "SOFTWARE\\Fujitsu\\POA I Path to the first part of the registry
\\DesktopApplication\\Netw I Key name used by the Desktop.
orkResilience" This should contain the subkeys:
ConnectionState
History
Modes
State
Triggers.
Table 79 BNR Static Configuration Data
© 2006 Fujitsu Services Company in Confidence Page 117
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
5.12.2 Network Resilience State
In addition to the Trigger values the following State values are used by the Engineers
App.
The DWORD CurrentMode will be set to 0,1,2 or 3 by CNIM to indicate the current
mode. 0 means idle.
CNIM will check the time that the required mode was last set by a button press. In
general if it was before the current Call Plan period then CNIM will revert to the
default mode which would usually be ADSL. However this behaviour will vary for an
NDIS outlet which has rebooted to GSM.
[HKEY_LOCAL_MACHINE\SOFTWARE\Fujitsu\POA\DesktopApplication\NetworkResilience\State]
Value Type Possible Description
Entries
CurrentMode DWORD I 0,1,2,3 This is the current BNR mode of operation.
0=Idle
1 = Mode 1
2 = Mode 2
3 = Mode 3
Set by CNIM when the DialMode string for
Connection Manager is changed by CNIM
or after a successful reboot.
RequiredMode DWORD I 0,1,2,3 Set by CNIM when an InitiateConnection
button is pressed.
BootedNetworkType String NDIS I RAS Set by CNIM on start up to store the
network type on CNIM start based on
Eicon card IP address.
ModeChangeTime String 25/07/2005 UTC time for last change. Used by CNIM
09:00:24:039 to determine if the last button press is still
valid, i.e. within the current Call Plan
period.
GsmSignalStrength String Monitor inactive Displays GSM signal strength.
Other strings, see
Connection
Manager LLD
Table 80 Branch Network Resilience - State Information
© 2006 Fujitsu Services Company in Confidence Page 118
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
5.12.3 Network Resilience Modes
CNIM maintains the mode values for a particular outlet. The Engineers App. will use
the values stored here to determine which connection types are possible. These will
then be used to determine the content of the "Connect" page of the Engineers App.
[HKEY_LOCAL_MACHINE\SOFTWARE\Fujitsu\POA\DesktopApplication\NetworkResilience\Modes]
Value Type Possible Description
Entries
1 String "ADSL" This is set by CNIM for the particular
"ISDN" outlet,
"GSM" le for NST 14, Mode 1 would be ADSL
“NDIS"
"VSAT"
2 String "ADSL" This is set by CNIM for the particular
"ISDN" outlet,
"GSM" le for NST 14, Mode 2 would be ISDN
“NDIS"
"VSAT"
3 String "ADSL" This is set by CNIM for the particular
"ISDN" outlet,
"GSM" le for NST 14, Mode 3 would be GSM
“NDIS"
"VSAT"
Table 81 Mapping Mode to Connection Type
© 2006 Fujitsu Services Company in Confidence Page 119
Fujitsu
Services
CNIM Low Level Design
COMPANY IN CONFIDENCE
FUJ00171956
FUJ00171956
Ref: RS/LLD/004
Version: 4.0
Date: 8/05/2006
5.12.4 Network Resilience History
CNIM maintains the History values for a particular outlet. The Engineers App. may
incorporate the string held in these values, e.g. "ADSL" into the string used to open a
particular registry key for example:
[HKEY_LOCAL_MACHINE\SOFTWARE\Fujitsu\POA\DesktopApplication\NetworkResilience\ConnectionState\AD
Sl]
which would hold state information for the ADSL connection type.
[HKEY_LOCAL_MACHINE\SOF TWARE\Fujitsu\POA\DesktopApplication\NetworkResilience\History]
Value Type Possible Description
Entries
1 String "ADSL" This is set by CNIM for the particular
"ISDN" outlet,
"GSM" le for NST 14, Mode 1 would be ADSL
“NDIS"
"VSAT"
2 String "ADSL" This is set by CNIM for the particular
"ISDN" outlet,
"GSM" le for NST 14, Mode 2 would be ISDN
"NDIS" during core hours.
"VSAT"
3 String "ADSL" This is set by CNIM for the particular
"ISDN" outlet,
"GSM" le for NST 14, Mode 3 would be GSM
"NDIS" during core hours.
“VSAT"
Table 82 Mapping History to Connection Type
CNIM will only respond to the Drop and Test buttons where marked "yes" in the table
below. It will not be possible to test or drop the ISDN connection on an ISDN outlet.
Changing connection type on an ISDN outlet will lead to a visible warning that a
reboot will be required.
Service Type NST14,7,9=ISDN I NST2=VSAT I NST13=ADSL I NST14=ADSL+ISDN
NST3 = Frame
Relay
Current Connection ISDN* GSM_ I VSAT or ADSL I GSM I ADSL I ISDN* I GSM
Frame Relay
Test Button Available I No Yes No Yes Yes I Yes Yes Yes
Drop Button Available I No Yes No Yes Yes Yes Yes Yes
Initiate Connection of I GSN" ISDN’ I None ADSL [ADSL [ADSL I ADSL I ADSL
i GSM? GsM I Gsm I ISDN’ I ISDN’ I ISDN/
given Type Gsm IGsm_ I GSM
Table 83 Engineers Button Options
© 2006 Fujitsu Services
Company in Confidence
Page 120
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Note ‘ISDN under NDIS
Note ? Warn that a reboot will be required.
Note * ISDN under RAS
The "Initiate Connection" button should only offer the appropriate options for the
outlet service type. If the current connection type is selected when initiating a
connection then Connection Manager will reset the connection.
CNIM must be able to respond to any order of button pressing.
The following assumptions are made:
1) Initiation of a connection implies the dropping of an existing connection.
2) A test may be interrupted by the dropping of a connection or the initiation of a
new connection.
3) The test will comprise the normal CNIM pinging test of the data centre.
4) CNIM will return an error if an inappropriate command is given, i.e. attempting
to drop or test an ISDN connection over NDIS or attempting to initiate an ISDN
connection on an NST 13 outlet.
5) When a manual switch to a particular connection type is made, CNIM will not
switch automatically to any other connection type during that Call Plan period.
At the start of the next Call Plan period CNIM will initiate a new test sequence
which may cause the connection type to change.
© 2006 Fujitsu Services Company in Confidence Page 121
Fujitsu
Services
CNIM Low Level Design
COMPANY IN CONFIDENCE
FUJ00171956
FUJ00171956
Ref: RS/LLD/004
Version: 4.0
Date: 8/05/2006
5.12.5 Returning Network State
The Engineers App will be responsible for displaying status information concerning
each connection type, to the user. The three areas of registry, ADSL, ISDN and GSM,
shown below will be updated by CNIM as and when a connection of the appropriate
type is opened or closed.
As mentioned above the registry entry ButtonAppRegRef within the CNIM area of registry,
will store a reference to the area of registry to be used to store the Engineers Button App. data.
In the example below
ButtonAppRegRef = SOFTWARE\ICL\ButtonA pplication\ResilientNetwork
[HKEY_LOCAL_MACHINE\SOFTWARE\Fujitsu\POA\DesktopApplication\NetworkResilience\ConnectionState\
ADSL]
[HKEY_LOCAL_MACHINE\SOFTWARE\Fujitsu\POA\DesktopApplication\NetworkResilience\ConnectionState\l
SDN]
[HKEY_LOCAL_MACHINE\SOFTWARE\Fujitsu\POA\DesktopApplication\NetworkResilience\ConnectionState\
GSM]
[HKEY_LOCAL_MACHINE\SOFTWARE\Fujitsu\POA\DesktopApplication\NetworkResilience\ConnectionState\
NDIS]
[HKEY_LOCAL_MACHINE\SOFTWARE\Fujitsu\POA\DesktopApplication\NetworkResilience\ConnectionState\
VSAT]
Value Type Possible Format Example Description
Entries
TimeStamp String Date Time I "02/06/2005 14:10:00" I Date/Time stamp for last update
NetworkState String See ISee Following Table See Following Table
Following
ITable
PhoneNumber String Any G RO Phone number dialled.
CallCode String Any 8 Alphanumeric character code
CallCodeDescription String jAny "Ping Failed" Interpretation of Call Code. Limited
fo 40 characters.
PingState String Any "22,10" INumber of pings for this connection}
lype, Number of successful pings
EnableDrop DWORD (0,1 0 Enable the Drop button for this
onnection type.
EnableTest DWORD (0,1 0 Enable the Test button for this
onnection type.
TimeStamp String Any "24/01/2006 13:44:29" —ITime of last change
AllowConnect DWORD (0,1 (0 Allow a connection of this type.
Table 84 Resilient Network Status
The string descriptions to be used for Network State are shown in the table below.
The state display will show both line state and ping state.
Note that the Ping State reverts to Unknown when a call opens.
Line
State/Ping
State
Unknown
Ping Fail
Ping Success
© 2006 Fujitsu Services
Company in Confidence
Page 122
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Line "Call State "Call State "Call State
Unknown Unknown, Ping Unknown, Ping Unknown, Ping
State Unknown" I State Failed" State Passed"
Line Closed "Call State "Call State Closed, I "Call State Closed,
Closed, Ping Ping State Failed" I Ping State
State Unknown" Passed"
Line Opening I "Call State "Call State "Call State
Attempting, Ping I Attempting, Ping Attempting, Ping
State Unknown" State Failed" State Passed"
Line Open "Call State Open, I "Call State Open, I "Call State Open,
Ping State Ping State Failed" I Ping State
Unknown" Passed"
FUJ00171956
FUJ00171956
Table 85 Network State Screen Information for BNR
The Engineers App. is responsible for monitoring this area of registry and displaying
this information to the user.
5.12.6 ISDN/GSM Switch Process
The switch process between ISDN and GSM on an ISDN outlet is described below:
Engineers Button pressed to initiate GSM
Engineers App sets CONNECTION value in CNIM registry to 3.
CNIM notified of registry change
CNIM sets CONNECTION value in CNIM registry to 0.
CNIM sets Connection_Type_Required to "GSM" with timestamp.
CNIM checks the change required and sets its own flag REBOOT_REQUIRED, to
1.
7. The Engineers App is notified by registry that the REBOOT_REQUIRED flag is
set.
8. The Engineers App warns the user that a reboot is required and offers the choice
to continue or quit.
9. If the user chooses to continue the Engineers App updates the value of
REBOOT_REQUIRED to 3.
10. If the user chooses to cancel the Engineers App updates the value of
REBOOT_REQUIRED to 0.
11.CNIM is notified of the change and if the value is zero CNIM sets the
Connection_Type_Required to "DEFAULT" with timestamp.
12. If the value of REBOOT_REQUIRED is 3 CNIM sets the value to 5 and spawns a
new process which will run the switch command with the correct parameters to
switch to GSM.
Qarwon>
© 2006 Fujitsu Services Company in Confidence Page 123
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
13. Switch Package sets the SWITCH_RESULT flag to 1 in case of failure during
switch
14. Switch Package disables SYSMAN
15. Switch Package stops CNIM and Connection Manager
16. Switch Package disables ISDN channels.
17. Switch Package sets dummy IP address on Eicon card
18.Switch Package disables ISDN monitoring.
19. Switch Package initiates a reboot.
21.CNIM checks that the Connection_Type_Required was set during the current call
plan period.
22. If the Connection_Type_Required was set before the current call plan period it is
set to "DEFAULT"
23.CNIM notes Network Service Type and that Connection_Type_Required = GSM
24.CNIM checks that the SwitchNetworkUseResult is correct and that the Eicon card
has a dummy IP address applied.
25. The Engineers App. will check that the SwitchNetworkUseResult is correct and will
warn the user that the platform is in an indeterminate state if the
SwitchNetworkUseResult displays an error.
26. If no switch error CNIM requests GSM connection from Connection Manager
27.CNIM waits for connection to be established and then does a test ping.
28.CNIM reports ping result.
29.CNIM does not change the connection type until the end of the call plan period.
30. If a switch error has occured CNIM will go to idle mode.
31.At the end of the call plan period CNIM sets the Connection_Type_Required to
"DEFAULT"
32.CNIM moves to the default test plan sequence for the current call plan period.
5.13 Test Strategy, Design Overview
Requirement: See section 2.2.7.d
Line Failure is determined either by the receipt of an error cause code or by the fact that a ping
initiated by CNIM fails to elicit a reply from its target.
CNIM will initiate a ping under the following circumstances:
e Outbound call is opened by an external source leading to a line check.
e Inbound call is received leading to CNIM initiating dial back.
e CNIM is within a "fixed" period and is required to keep the line up.
¢ When carrying out a test sequence following line failure.
The line test is done at the start of the call and is only done once per call. It comprises sending a
ping to one or more of the four VPN servers with which the outlet is configured to test comms
and waiting for a timeout period for a reply
© 2006 Fujitsu Services Company in Confidence Page 124
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
CNIM will check the cause code each time the line goes idle to determine whether the call was
successful as far as the telephone network is concerned. The code returned by the Eicon card is
compared with a set of known good values.
If the line test should fail or the cause code is found to be an error code then the Test sequences
shown in section 2.2.7.d will be initiated.
Test activity will be initiated by the line monitoring function within CNIM. When a call is
opened an event will be sent to the test module which will decide if a line test is required. If a
test is required then a ping will be sent to one or more VPN servers, depending on whether a
reply was received from one of the VPN servers at the last ping attempt. Each ping attempt
incorporates a timeout applicable to the network being used. Two timeout values are used, one
for the satellite network and one for the ISDN/Data network.
When within test mode CNIM uses a set of timers to determine when the next test should take
place. In general, on an ISDN outlet, each individual test will comprise a configuration of the
Eicon card with the appropriate parameters followed by set of pings with a ping timeout period.
In the event that the individual test fails then a timer will be set by the test module and acted
upon by that module when the timer expires.
5.13.1 Run Mode — ISDN Outlet
5.13.1.a Pre Version 2.0
CNIM divides the phone numbers available to it into one of three modes, as shown in Table 86.
See Table 14 for a description of the number types used in this table.
Mode I is considered normal running in that whilst running in this mode the test timer will not
be set. Only one of the two available numbers is configured on the card at a time, in this mode.
Mode 2 is considered a failure mode in that both numbers in Mode I have failed. When in this
mode the test timer will be set. As with Mode I only one number is configured on the card at a
time.
Whilst in Mode 2 CNIM will not enter the Permanent Fail state as defined in Table 106.
Mode 3 is also considered a failure mode and if CNIM is unable to return to Mode I or 2 then it
will enter the Permanent Fail state 15 minutes after the line first failed. The test timer will be set
whilst in this mode.
Network\Mode Mode 1 Mode 2 Mode 3
(One Number Used I (One Number Used (All Numbers
at a Time) at a Time) Configured on Card)
ISDN VP, VS VT, VP VP, VS, VT, VP
Data MP, MS MP, MS VP, VS, VT, VP
FRIACO (1) FCIP, FCIS DP, DS VP, VS, VT, VP
FRIACO (2) FC2P, FC2S DP, DS VP, VS, VT, VP
Table 86 Called Party Numbers per Mode - Version 1
5.13.1.b Version 2 Onward
© 2006 Fujitsu Services Company in Confidence Page 125
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
The table below shows the revised mapping of phone numbers to Connection Type for CNIM
Version 2.
Network\Mode Type Mode 1 Mode 2 Mode 3
Primary Secondary Tertiary
ISDN voice (01) VP VS VT
Bronze (04) MP VP VS
Silver FRIACO (07) Fixed FP DS VP
Period
Silver FRIACO (07) Dialled DP vP VS
Period
Silver Metered (09) Fixed MP MS VP
period
Silver Metered (09) Dialled MP VP VS
Period
FRIACO 24 Hr (11) Metered DP DS VP
period
FRIACO 24 Hr (11) FRIACO_ I FP DS vP
Period
Table 87 Called Party Numbers per Mode - Version 2
Note that Mode 2 numbers are directed to the same campus as the Mode 1 number
for the outlet. This is because Energis will redirect a failed number on Mode 1 to the
alternative campus. Therefore if CNIM deems that number to have failed then, in
theory, a call to both campuses has been attempted.
5.13.1.a.1 Service Type 11 at Metered Fixed
For Network Service Type 11 during the metered period the connection type is Metered Fixed.
Metered Fixed is also used by NST 09 during its fixed period and so for the two types the
numbers used are:
Mode 1: NST 09 - MP, NST 11-DP
Mode 2: NST 09 - MS, NST 11-DS
Mode 3: NST 09 - VP, NST 11- VP
§.13.1.a.2 Service Type 11 at FRIACO Fixed
For Network Service Type 11 during the FRIACO period the connection type is FRIACO
Fixed. FRIACO Fixed is also used by NST 07 during its fixed period and so for the two types
the numbers used are:
Mode 1: NST 07 - FP, NST 11 - FP
Mode 2: NST 07 - DS, NST 11-DS
Mode 3: NST 07 - VP, NST 11 - VP
© 2006 Fujitsu Services Company in Confidence Page 126
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
5.13.2 Ping Sequence
With the “ping” process employed to maintain a connection to the Data Centre, there are three
issues to be considered:
1. Ping failure — an allowance of a 1% failure rate to be made.
2. All pings can fail for 1 or 2 seconds under certain network conditions.
3. VPN session establishment can impact the ability of the ping to work.
To overcome the issues above, CNIM utilises a sequence of “pings”, “n” seconds apart in order
to ascertain whether or not the call had worked. As soon as a ping succeeds, then the call is
deemed to be a success and the rest of the sequence is not done. In addition if the Eicon card
reports that the call had closed before a ping had succeeded then the call is deemed to have
failed. The remaining “pings” in the sequence are not done, as they would cause additional calls
to be made to the Data Centre. If all the “pings” in the sequence are deemed to have failed, then
the last “ping” will time-out after “n” seconds.
Methodology
The time between “pings” is a Registry Entry and initially will be set to 4 seconds.
CNIM selects 4 out of the 8 VPN servers. The VPN servers selected are the first from each of
the 4 IP Subnets.
A typical outlet Policy file is shown below:
[GENERAL]
Heartbeat-DEFERRED
HeartbeatResponseTime=60
HeartbeatDeferTime=900
EarlyAuthentication=1
KeyService=GSS
PacketEncapsulation=ESP
RequestDelay=60
KeylIdleTime=99999
LogDelay=1
AllowUserAccess=0
EncryptionSurvive=0
EncryptionOnStartup=1
UseCRYPTLogic=0
[ENCRYPTION]
EncryptionOnSend=USERI
KeyEncryptionl=USERI
[DROP]
Company in Confidence Page 127
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Ip4 IRRELEVANT
Ip5:
[PLAIN]
[CRYPT]
[TRY]
AcceptCryptAll=0
[CLUSTER]
L=P /CN=002001
\eeenneendRRELEVANT OO /L=C
[SIGNATURE]
78£2¢26 1 f5b5d3c635432ee9caad2048
In order to extract the VPN server IP addresses required the information in clusters 1 to 6 must
be parsed. One server from each of the two VPN LANs at each Data Centre will be selected as
a ping target. The LAN addresses are given below. Each outlet can connect to one or more
VPN server on each LAN.
© 2006 Fujitsu Services Company in Confidence Page 128
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
x.64.18.y
x.64.19.y
x.74.18.y
x.74.19.y
The file will be parsed so that one address from each LAN is chosen at random. In effect CNIM
will ensure that the 2/3" octet sequence is unique for each of the four VPN servers used as
ping targets during the test cycle.
The order in which the chosen VPN servers are pinged is randomised on starting CNIM.
With each call, CNIM starts with the first VPN server on the list, “pings” the server and waits
for 4 seconds.
If no response from the “ping” and the call is still open, CNIM “pings” the next server on the
list.
This repeats until all 4 servers have been “pinged” or the call has been dropped.
If no reply, then the call is deemed to have failed.
On the next call, CNIM will commence with the VPN server that responded the previous time.
For “Fixed” connections, CNIM will “ping” the VPN server that responded the previous time. If
this fails, CNIM tries the other 3 VPN servers, in sequence, 4 seconds apart, prior to declaring
the call dead. As with other “pings”, it will check the call is up before doing each “ping”.
This means that at most 4 “pings” are used to determine whether or not a call has failed.
5.13.3 Test Strategy Design
The requirements for line testing, within CNIM, are given in section 2.2.7.d. These specifically
refer to the requirements for CNIM version 2 onwards.
It may be seen that, within each test sequence, CNIM is required to move between certain states
in a predefined manner and that these states share common features.
In order to facilitate the use of these test sequences a simple language has been developed,
known as the CNIM Programming Language or CPL. The language is made up of a set of
operations which may be grouped into elements, these elements being numbered and shown on
the original test sequence diagrams.
Each operation is a discrete instruction or decision, for example:
Set Mode I number
Or
Determine next element on call failure.
Each element is stored in registry as a sequence of operation names and associated parameters.
Each element has a two character name and is held in registry as a Multi String.
Operation types are shown in Table 88.
Type No. Parameter Possible Description
Parameters Length Value
SET 1 1 1,20r3 Set Mode 1, 2 or 3
TTP 0 N/A N/A Test Ping
KAP. 0 N/A N/A KeepAlive Ping
© 2006 Fujitsu Services Company in Confidence Page 129
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
BDP 0 N/A N/A Bandwidth Ping
STT 2 lto4 0 to 9999 Set Test Timer Min/Max in seconds.
This will not affect the timer if it is
already running.
CTT 0 N/A N/A Cancel Test Timer
ATT 1 2 00 to 99 Next Element after Timeout
LPS 2 1to4 0 to 9999 Loop Start for Min/Max sec's
LPE 1 2 00 to 99 Element address at start of loop
PGP 1 2 00 to 99 Next Element on Ping Pass
PGF 1 2 00 to 99 Next Element on Ping Fail
CLP 1 2 00 to 99 Next Element on Call Succeeds
CLF 1 2 00 to 99 Next Element on Call Fails
ENC 1 2 00 to 99 Next Element on No Call
GTO 1 2 00 to 99 Next Element to Go To
ALO 1 2 00 to 99 Next Element after Line Opening
ALC 1 2 00 to 99 Next Element after Line Closing
BRK 0 N/A N/A Break and go to wait state
END 0 N/A N/A End of test sequence
STM 0 N/A N/A Store current mode
RSM 0 N/A N/A Restore last stored mode to use
EIC 2 2 00 to 99 Set Shorthold Timer and MCDT
Parameters on Eicon Card
ILD 1 2 00 to 99 Next Element if ISDN line down
ILI 1 2 00 to 99 Next Element if ISDN line is
connected in.
ILO 1 2 00 to 99 Next Element if ISDN line is
connected out.
BLU 1 1-4 0 - 9999 Break if the line is up (Before
changing number) with timeout.
NTL 1 2 00 to 99 Goto address if timed out or line
down
GES 0 N/A N/A Goto element start
SFF 1 1 Oorl Parameter 0 = Set fail flag to zero.
Parameter I = Increment fail count
INT 0 N/A N/A Initialise Tester Thread
SBT 2 lto4 0 to 9999 Set Bandwidth Timer Min/Max in
seconds. This will not affect the
timer if it is already running.
CBT 0 N/A N/A Cancel Bandwidth Timer
© 2006 Fujitsu Services Company in Confidence Page 130
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
BWT 1 2 00 to 99 Next Element after Bandwidth
Timeout
DRP Drop the connection
STE Signal Test (Manual) Ended
MNT Start a Manual Test
FNL 1 N/A 0 to 9999 Final Op, parameter is a mode
number to control the action taken.
MDI Go to Mode 1
MD2 Go to Mode 2
MD3 Go to Mode 3
ABT 1 2 00 to 99 Await bandwidth timer and branch
ABH 1 2 00 to 99 Await blackhole timer and branch
CBH 0 N/A N/A Cancel blackhole timer
SBH 1 lto4 0 to 9999 Set blackhole timer
SBT 1 lto4 0 to 9999 Set bandwidth timer
RCM 0 N/A N/A Reset Connection Manager
RCS 0 N/A N/A Reset Current Screen Statistics
SMI 2 lto4 0 to 9999 Set Mode 1 Timer
SM2 2 lto4 0 to 9999 Set Mode 2 Timer
CMI 0 N/A N/A Cancel Mode I Timer
CM2 0 N/A N/A Cancel Mode 2 Timer
GDD 0 N/A N/A Go to DayD Mode
LDD 0 N/A N/A Leave DayD Mode
CDD 0 N/A N/A Check if should be in DayD Mode
Table 88 CPL Operations
Test pings will be sent to N servers where N is stored in registry. KeepAlive pings will be sent
to just I server.
The LPS loop operation will set a timer and carry out the operations between LPS and LPE
until the timer expires.
Each element will parse its own registry entry and create a list of operations.
Following any BREAK operation the thread will wait and accept other events such as timer
events signalling the end of the call plan period or service shutdown events.
The element will contain two state variables to store the test call state (TCS) and non test call
state (NTCS). Initially both will be set to FALSE. If a ping succeeds the TCS is set to TRUE. If
anon test call goes through successfully the NTCS is set to TRUE. This will be based on a line
check following a Layer 2 Activated notification.
STM will store the current mode in a globally available variable. This would be done prior to
changing mode to a different value and allows the stored value to be restored later using RSM.
© 2006 Fujitsu Services Company in Confidence Page 131
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Each ping operation, whether TTP or KAP would normally be followed by a PGF operation to
determine the logical flow in the event of ping failure. It would not have to be followed by a
PGP if no special action is required on ping success. The operations TTP and KAP are
responsible for updating the failure state that would be returned to Counter Call Scheduler via
the GetStatus mechanism.
5.13.3.a Diversion Operations
Diversion operations are those that divert the logical command flow to a new element and are
described in more detail below.
In each case if the operation does not cause a diversion then control is passed to the next
operation in sequence.
Type Name Description Condition Flag Type
ATT Next Element I Check input operation type is I OperationType
after Timeout Test Timer
LNE Loop Not] Element address I Check if Loop Timer has gone I Timer Event
Ended at start of loop off. If not go to address which is
start of loop.
PGP Next Element on I Go to the address given if the I BOOL Pass/Fail
Ping Pass last ping passed.
PGF Next Element on I Go to the address given if the I BOOL Pass/Fail
Ping Fail last ping failed.
CLP Next Element on I Go to the address given if the I BOOL
Call Succeeds last call succeeded. Good/Bad
Cause code
CLF Next Element on I Go to the address given if the I BOOL
Call Fails last call failed. Good/Bad
Cause code
ENC Next Element on I No call has been made. BOOL Call
No Call Made/Not
Made.
GTO Next Element to I None N/A
Go To
ALO Next Element I Check input operation type is I OperationType
after Line I Line Event
Opening
ALC Next Element I Check input operation type is I OperationType
after Line Closing I Line Event
Table 89 Diversion Operation Conditions
Operations will be called continuously, each operation being responsible for retrieving the
address of the next operation, until a BRK element is reached.
Following a BRK, CNIM Call Manager class will pass in the name of the event that has cause
the operation test sequence to be restarted. This will have three possible values:
© 2006 Fujitsu Services Company in Confidence Page 132
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
1. OT_ATT - Test Timer has expired.
2. OT_ALO - The line has been opened.
3. OT_ALC - The line has been closed.
The next operation following the break, which will only be of the type ATT, ALO or ALC, will
run itself if it has received the right type of event. Otherwise it should retrieve the address of the
next operation in sequence.
© 2006 Fujitsu Services Company in Confidence Page 133
Fujitsu
Services
CNIM Low Level Design
COMPANY IN CONFIDENCE
FUJ00171956
FUJ00171956
Ref: RS/LLD/004
Version: 4.0
Date: 8/05/2006
5.13.3.b Test Plan Details
5.13.3.b.1_ Test Plan - FRIACO Establish
THKEY_LOCAL_MACHINE\SOFTWARE\CL Pathway Configuration\CNIM\Test_Elements\E_Range]
EI't Opt Op2 Op3 Op4 Ops Op6
00 ATi I Gloor
01 BRK ATT IT GES
7 BLU NILit cir STT 0900 GTO st
12 KAP PGF 13 GTO 35
i BLU NIL 13 SET2 GTO 14
14 CIT STP 210810 GTOST
15 BLU NIL 15 SETI TIP PGP 12 GTO 16
16 BLU NIL 16 SET2 TIP PGP 22 GTO 17
17 CIT STT 450 1350 GTO 32
18 BLU NIL 18 SETI TIP PGP 12 GTO19
19 BLU NIL 19 SET3 crt STT 900900 GTO 56
20 BLU NIL 20 SET2 TIP PGP 22 GTO21
21 BLU NIL 21 SET3 crt STT 900 900 GTO 57
22 CIT STT 600 2400 GT0 33
23 BLU NIL 23 SETI TIP PGP 12 GTO13
35 TTP PGP 22 GTOS1
aI TTP PGP 22 GTO 52
45 TIP PGF 14 GTO 53
T BRK ALO 35 ATT IS GES
32 BRK ALO4I ATT 18 GES
33 BRK ALO4S ATT 23 GES
34 BRK ATT 12
33 BRK ATT 12
36 BRK ATT 20
37 BRK ATT 18
Table 90 E Range Test Elements - FRIACO Establish Period - S60
© 2006 Fujitsu Services
Company in Confidence
Page 134
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
5.13.3.b.2 Test Plan - FRIACO or Metered Fixed
{HKEY_LOCAL_MACHINE\SOFTWAREUCL Pathway Configuration\CNIM\Test_Elements\F_Range}
EIt Opt ‘Op2 ‘Op3 ‘Op4 ‘Ops: ‘Ops
00 ATT I GTOOL
ol BRK ATT IL GES
TI BLU NIL it SETI ai SIT O10 GTO 53
12 KAP 4 PGF 30 CIT STT 32 32 GTO 54
13 BLU NIL 13 SET2 GTO 14
14 crt STT 210 810 GTOS1
15 BLU NIL 15 SET 1 TIP4 PGP 12 GTO 16
16 BLU NTL 16 SET2 TIP 4 PGP 22 GTO 17
7 cit STT 450 1350 G10 52
18 BLU NTL 18 SET 1 TIP4 PGP 12 GTO 19
19 BLU NIL 19 SETS cir STT 900 900 GTO 55
20 BLU NIT20 SET2 TIP4 PGP 22 GTO 21
2 BLU NIT ai SETS cir STT 900 900 G10 56
22 LPS 300 900 EIC 40 10 GTO 45
23 BLU NTL 23 SET1 TTP 4 PGP 12 GTO 13
30 TTP 4 PGP 12 GTO 13
31 TIP 4 PGP 22 GTOS51
41 TIP 4 PGP 22 GTO 52
45 KAP4 PGF 14 crt STT 3030 GTO 57
46 LNE 45 GTO 23
Si BRK ALO 31 ATT 15 GES
52 BRK ALO 41 ATT 18. GES
53 BRK ATT 12 GES
54 BRK ATT 12 GES
5S BRK ATT 20 GES
56 BRK ATT 18 GES
57 BRK ATT 46 GES
Table 91 F Range Test Elements - FRIACO Fixed Period - S60
FO1 uses a nominal randomisation time of 10 seconds, the requirement for a random 0-900
second delay being satisfied by the Call Plan modification that occurs at startup.
Element F35 sets the timer to 4 seconds because CNIM has set mode 2 Dialaround number and
the card parameters will be:
MCDT = 0
Shorthold Timer
5 seconds
© 2006 Fujitsu Services Company in Confidence Page 135
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
5.13.3.b.3 Test Plan - FRIACO Fixed at S92
IHKEY_LOCAL_MACHINE\SOFTWARE\ICL\Pathway Configuration\CNIM\Test_Elements\F_Range]
Et Opt Op2 Op3. ‘Op4 ‘Ops Ops
WL SIT I cop eo [ATT TT TOOT
01 BRK CDD J60 ATT 11 GES
1 BLU GDD J60 NTL SET1 cit STT010 GT0 53
START
12 I KPa POF 30 cir Sir 32 I Gloss
32
% I Bw DD Je I NTL SET? I GTO
START
14 cit STT = 210 I GTO51
810
15 BLU GDD J60 NTL ‘SET 1 TIP4 PGP 12 GTO 16
‘START
16 BLU GDD J60 NTL SET 2 TIP4 PGP 22 GTO 17
START
17 cir STT 450 I GTO52
1350
78 [Buu SDD Ie I NTL SeIt__IT1P4_I PoP i2 I GTote
‘START
19 BLU GDD J60 NTL SET 3 cit STT 900 I GTO 55
‘START 900
20 BLU GDD J60 NTL SET 2 TIP4 PGP 22 GTO 21
START
2 BLU GDD J60 NTL SET3 cir STT 900 I GTO 56
START 900
© 2006 Fujitsu Services
Company in Confidence
Page 136
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
2_[ 1PS300900 I EIC4010 I GTOaS
23 BLU GDD J60 NTL SET1 TIP4 PGP 12 GTO 13
‘START
30 TIP 4 PGP 12 GTO 13
Ei TIP 4 PGP 22 GTO 51
a [ve 4 PGP 22 GTO 82
45 KAP 4 PGF 14 cit STT 30] GTO57
30
I INES GTO
St BRK ATT 15 GDD 60 ALO 31 GES
52_I BRK ATT 18 copeo I ALoa I Ges
53 BRK ATT 12 GDD 60 GES
54 BRK ATT 12 GDD 60 GES
55 BRK ATT 20 GDD 60 GES
56 BRK ATT 18 GDD 60 GES
57_I BRK ATT a Gop60 _I GES
60 cir STT 3030
61 BRK ATT G62 ALO G62 ALC G62 I ABH PGP G71 PGF cDD TIP5 I GTO.
G72 G70 START 00
62 cit STT 3030 TTP 10 RIN
70 I SBH 1200 I RIN
1200
nN BH RIN
72 RCM RIN
Table 92 FRIACO Fixed Test Elements- S92
5.13.3.b.4 Test Plan - Dialled (MOD)
[HKEY_LOCAL_MACHINE\SOFTWARE\ICLIPathway Configuration\CNIM\Test_Elements\D_Range]
© 2006 Fujitsu Services Company in Confidence Page 137
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
El't I Op1 Op2 Op3 I Op4 Ops Op6
00 STT 10 I CDD J90 ATT 02 GIOOL
10
ol BRK CDD J90 ATT 02 GES
02 FCH 13 GTO1L
iW BLU GDD J90 NTL 11 SET 1 GTO
12
12 BRK ALO 31 GDD J90 GES
13 crT STT 210] GTO61
810
14 BLU GDD J90 NIL 14 SET 2 TIP 4 PGP 20 GTO
15
15 BLU GDD J90 NTLIS SETI crt STT 450 I GTO
1350 62
16 BLU GDD J90 NIL 16 SET2 TTP 4 PGP 20 GTO
17
7 BLU GDD J90 NTL 17 SET3 cIT STT 900 I GTO
900 66
18 BLU GDD J90 NIL 18 SETI TIP PGP 12 GTO
19
19 BLU GDD J90 NTL 19 SET3 crr STT 900 I GTO
900 67
20 TIP 4 crT STT 1800 I GTO 63
5400
a I cir STT 300 I GTO
900
22 BLU GDD J90 NTL 22 SET1 TIP 4 PGP 12 GTO
23
23 BLU GDD J90 NTL 23 SET2 crr STITT 450 I GTO
1350 65
24 BLU GDD J90 NTL 24 SETI TTP 4 PGP 12 GTO
25
25 BLU GDD J90 NTL 25 SET2 GTO
20
31 TIP4 PGP 12 GTO 13
35 TIP 4 PGP 12 GTO61
41 TIP 4 PGP 12 GTO 62
42 ENC 18 GTO 16
45 TIP 4 PGF 21 GTO 63
SL TIP 4 PGP 20 GTO 64
55 TIP4 PGP 20 GTO 65
56 ENC 16 GTO 18
61 BRK ATT 14 GDD J90 ALO 35 I GES
62 BRK ATT 42 GDD J90 ALO 41 I GES
63 BRK ATT 24 GDD J90 ALO 45 I GES
64 BRK ATT 22 GDD J90 ALO 51 I GES
65 BRK ATT 56 GDD J90 ALO 55 I GES
66 BRK ATT 18 GDD J90 GES
© 2006 Fujitsu Services
Company in Confidence
Page 138
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
BRK I ATT 16 I GDD J90 GES
70 SET4
71 TIPS GSB 80
75 BRK ATT71 GES
80 crT STT 3030 I RIN
90 crT STT 3030
91 BRK ATT G92 I ALO G92 ALC ABH PGP G96 PGF cDD TIP GTO
G92 97 G95 START 10 00
92 TTP 10 crr STT 3030 RTN
95 SBH RIN
1200
1200
96 CBH RIN
9o7 RCM RIN
Table 93 D Range Test Elements - Dialled Period
© 2006 Fujitsu Services Company in Confidence Page 139
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
5.13.3.b.5 Test Plan - Dialled (VOD)
[HKEY_LOCAL_MACHINE\SOFTWARE\ICL\Pathway Configuration\CNIM\Test_Elements\I_Range]
© 2006 Fujitsu Services Company in Confidence Page 140
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Ert] Opt Op2 I Op3 I Op4 Ops Ops
00 STT 10 I CDDJ70. ATT 02 GTOOL
10
ol BRK CDD 370 ATT 02 GES
02 I FcHIs I Grol
i BLU GDD J70 NTL 11 SET 1 GTO 12
12 BRK GDD J70 ALC 31 GTO 12
13 crt STT 210 I GTO61
810
14 BLU GDD J70 NTL 14 SET2 TIP 4 PGP 20 GTO15
15 BLU GDD J70 NTL 15 SETI crT STITT 450 I GTO 62
1350
16 BLU GDD J70 NTL 16 SET2 TIP 4 PGP 20 GTO 17
17 BLU GDD 370 NTL 17 SET3 crT STT 900 I GTO 66
900
18, BLU GDD J70 NTL 18 SET1 TIP 4 PGP 12 GTO 19
19 BLU GDD 370 NTL 19 SET3 crT STT 900 I GTO 67
900
20 crt STT 1800 I GTO 63
5400
21 cIT STT 300 I GTO 64
900
22 BLU GDD J70 NTL 22 TIP 4 PGP 12 GTO 23
23 BLU GDD J70 NTL 23 SET2 crt STT 450 I GTO 6S
1350
24 BLU GDD J70 NTL 24 SET1 TIP4 PGP 12 GTO 25
25 BLU GDD J70 NTL 25 SET 2 GTO 20
31 CLP 12 GTO 13
35 CLP 12 GTO61
41 CLP 12 GTO 62
42 ENC 18 GTO 16
45 CLF 21 GTO 63
51 CLP 20 GTO 64
55 CLP 20 GTO65
56 ENC 16 GTO18
61 BRK ATT 14 GDD ALC 35 GES
J70
62 BRK ATT 42 GDD ALC 41 GES
J70
63 BRK ATT 24 GDD ALC 45 GES
370
64 BRK ATT 22 GDD ALC 51 GES
370
65 BRK ATT 56 GDD ALC S55 I GES
170
66 BRK ATT 18 GDD GES
J70
67 BRK ATT 16 GDD GES
370
70 crt STT 3030
© 2006 Fujitsu Services
Company in Confidence
Page 141
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
BRK I ATT ALO G72 ALC ABH PGP PGF G80 cDD TIP 10 I GTO
G72 G72 G82 G81 START 00
72 TTP 10 crr STT 30 I RIN
30
80 SBH RIN
1200
1200
81 CBH RIN
82 RCM RIN
Table 94 I Range Test Elements - Dialled Period - ISDN
© 2006 Fujitsu Services
Company in Confidence
Page 142
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
5.13.3.b.6 Test Plan - Dial Back S60.
In this plan the dial back sequence will start immediately that an inbound ISDN call is
detected. The first thing it must do is determine whether the line is down.
THKEY_LOCAL_MACHINE\SOF TWAREACL Pathway Configuration\CNIM\Test_Elements\B_Range]
EI't Op 1 Op2 Op3 Op4 Ops
00 STT 10 10 ATT 11 GTO 01
ol BRK ATT 11 GES
ll ILD 21 ILO 21 GTO 12
12 BRK GTO 11
21 LPS 120 120 I GTO 22
22 TIP 4 PGF 25 CTT STT 3232 I GTO 24
23 LNE 22 GTO 30
24 BRK ATT 23 GES
25 BLU NTL 25 SET3 EIC 4010 I GTO 27
26 TIP 4 PGF 30 CTT STT 3232 I GTO 28
27 LNE 26 GTO 30
28 BRK ATT 27 GTO 28
30 ILD 40 GTO 31
31 BRK GTO 30
40 LPS 00 END
Table 95 Dial Back
The test plans are stored in registry using the CNIM programming language. The dial back test
plan has been modified such that, at the end of the 2 minute "pinging period" CNIM will wait
within the dial back test plan until the line drops. CNIM will periodically (90 sec.) do a test ping
and determine if the line changes status in response to that ping.
The LPS 0 0 step immediately before the end ensures that the loop timer is cancelled.
The following table of possible results shows CNIMs actions following each periodic test ping.
Ping Result Line Status Exit Dial Back
Success No Change No
Success Does Change Yes
Fail No Change Yes
Fail Does Change Yes
Table 96 Ping Result and Line Status
© 2006 Fujitsu Services
Company in Confidence
Page 143
Fujitsu
Services
CNIM Low Level Design
COMPANY IN CONFIDENCE
FUJ00171956
FUJ00171956
Ref: RS/LLD/004
Version: 4.0
Date: 8/05/2006
If the ping fails or the line does change status then CNIM will exit from the dial back test plan.
If the line does not change status and the ping succeeds then the line must be being held open by
some external application. CNIM will not force the line to close but will continue looping until
the line is allowed to close.
CNIM does not need to wait until the periodic ping before exiting the dial back plan. Once it has
finished the 2 minute mandatory pinging period it will respond to a change in line status and exit
the dial back plan. The periodic ping is used in the event of a "Layer 1" failure which may
prevent the line changing status.
5.13.3.b.7
Test Plan - Satellite
Pinging is done once every 15 minutes.
The ping interval is reduced to 4 minutes and the ping sequence is altered to use
keep alive pings in the first instance and test pings in the event of failure.
The KAP item was removed as it caused premature setting of the fail state.
EI't Opt Op 2 Op3
00 STT 10 10 ATT 11 GTO 01
OL BRK ATT 11 GES
ll TTP 40 GTO 13
12 BRK ATT 11 GES
13 CTT STT 240 240 I GTO 12
Table 97 P Range Test Elements - Permanent Connection (Satellite) - S60
5.13.3.b.8 Test Plan - ADSL
EI't Op1 Op2 Op3 Op4 Ops
00 ATT 11 GTO 01
01 BRK ATT II GES
im TTP 5 GTO 30
12 BDP 5 PGF 20 GTO 13
13 BRK ATT 30 ALO 20 [I ALC20 I GES
20 TIP 5 GTO 13
30 CIT STT 300 300 I GTO 12
5.13.3.b.9
Table 98 A Range Test Elements - ADSL - S60 - With Test On Line State Change
Test Plans for RAS at BNR - S92
© 2006 Fujitsu Services
Company in Confidence
Page 144
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
5.13.3.b.9.1 Test Plans - ADSL Only
These elements are stored under the key:
[HKEY_LOCAL_MACHINE\SOFTWARE\ICL\Pathway Configuration\CNIM\Test_Elements\RA_Range]
The following elements are used overnight where no ISDN or ADSL backup is
available outside core hours.
CNIM is expected to respond to the manual test button and does this via the MNT
element. It must also respond to the Drop button and this is picked up by the DRP
element.
When carrying out a manual test CNIM will use the LPS loop element with a time of
120 seconds. CNIM will carry out bandwidth pings during the test if required.
CNIM will reset the Test flag back to 0 at the end of the test via the STE element.
[HKEY_LOCAL_MACHINE\SOFTWAREIICL\Pathway Configuration\CNIM\Test_Elements\RA_Range]
EIt
‘Opt I Op2 I Op3 I Ops I Ops I Ops I Op? I Op8 I Op? I Opi0 I Opt! I Opt2 I Opis I Opts
ly
cop I MoT
190 Jt
SeT1 I SBT STT 10 I GTO
300 10 2
300
2
BRK I GDD I ATT ALO I ALC ABT I ABH I MNT I MNT I DRP mbt [PCF I PGP I GES
J90 G31 G31 G31 Gat G80 G50 G61 185 J G65 G78
TIPS I RIN
‘SBT BDPS I RIN
300
300
RCS I LPS cit Sit 5 [RIN
120 5
120
61
BRK I GDD I ATT sTT 5 I ABT DRP I MDt UNE STE RIN
5
90 G31 Gat 85 J START
65 ‘SBH RIN
1200
1200
78 I CBH I RIN
80
TIPS I PGF RIN
G8t
81
RCM I GSB78 I GSB65 I RIN
85
SETO I GTO
86
86
BRK I GDD IMo1 I ALO I ALC GES
© 2006 Fujitsu Services Company in Confidence Page 145
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
wo [st [ot I oat
90 crt sTT
3030
of BRK ATT ALO ALC ABH PGF PGP cDD TIP 10 I Gro
G92 G92 G92 G81 G65 G78 STAR 00
r
92 TTP crT SsTT RIN
10 3030
Table 99 RA Range Elements - S92
© 2006 Fujitsu Services
Company in Confidence
Page 146
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
5.13.3.b.9.2 Test Plan - ADSL with GSM Backup
These elements are stored under the key:
[HKEY_LOCAL_MACHINE\SOFTWARE\ICL\Pathway
Configuration\CNIM\Test_Elements\RAG_Range]
Elt I Opt I Op2 I Op3 I Ops I Ops I Op6 I Op? I Op8 I Op9 I Opl0 I Opti I Opi2 I] Op13 I Op14 I Opts
i) CDD MDT MDZ
G90 Jt J2
1 SET1 I SBT SIT GTO
300 1010 I 21
300
12 SET2 I SBT SIT GTO
300 I 1010 I 22
300
a BRK GDD AIT ALO ALC ABT ‘ABH MNT MNT DRP MD1 MD2 PGF PGP GES
co [ost Iost I cat Ios I ogo I cso I cer I us I vit I viz I ce I cre
2 [BRK [GOD [ATT IAO IAC I ABT I ABH I MAT I WNT I DRP I MoI I MO2 I PcF I PGP I GES
c9 I 32 I 32 I G32 I G42 I ogo I cso I ces I us I uit I vi2 I ce5 I cre
3 TIPS I RIN
32 TTP RIN
20
41 SBT BDP5 I RIN
300
300
42 ‘SBT TTP 20 I RIN
300
300
50 RCS LPS ciT STT 5 I RIN
120 5
120
61 BRK GDD AIT STT 5 I ABT DRP MD1 MD2 LNE STE RIN
Go G31 5 Gat 185 Jt J2 ‘START
2 [BRK I GOD I ATT I str 5] ABr I ORP I MoI I Moz [INE I STE I RIN
co I 632-4 5 ca I 85 I vit I sta I START
65 ‘SBH RIN
1200
1200
78 CBH RIN
80 TIPS I PGF RIN
G8t
8 RCM I GSB GSB RIN
78 65
85 SETO I GTO
86
86 BRK GDD MD1 MD2 ALO ALC GES
© 2006 Fujitsu Services Company in Confidence Page 147
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
CH [it [v2 [or I oi
90 crT sTT
3030
a [BRK [arr [ato [arc [ABH IPcr I PoP [cpp ITiP10 I RIN
G92 G92 G92 G81 G65 G78 STAR
T
92 TIP. crT SsTT RIN
10 3030
Table 100 RAG Range Elements - S92
© 2006 Fujitsu Services
Company in Confidence
Page 148
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
5.13.3.b.9.3 Test Plan- RAS GSM Backup
These elements are stored under the key:
[HKEY_LOCAL_MACHINE\SOFTWARE\ICL\Pathway Configuration\CNIM\Test_Elements\RG_Range]
This is used by NDIS outlets running on GSM backup.
Ett] Opt? I Op2 I Op3 I Ops I OpS I Ops I Op? I Op8 I Op® I Opt0 I Opi
WP SIT 3 I CoD MOT] M02] Ms IW OR
30 J70 430 30 430 I vo I 30
7 [BRK [GoD I ArT MDT I MD2 I M03 I MD4 I GSB20 IDRP I MNT I ABH I PCF I PGP I GES
J70 Gt2 I 430 30 I 30 I 80 30 I 50 I G60 I G65 I 86
2 I TIP 20 I RIN
20 I cit STT 30 I RIN
30
30 I GSB20 I SETO GTO 40
40 I BRK GDD MD4 ATT GSB.20 I GES
370 180 G12
0 I RCS TPS 120 I GSB 55
120
51 I BRK GoD I AIT MDS 68855 I DRP I INE STE RIN
70 G12 80 30 START
55 I CIT STT55 I RIN
60 [RCM I GsB66 I GsB65 I RIN
65 I SBH RIN
4200
1200
70 [cir I str30
30
7 [BRK I ATT ALO. [ALC [ABH I PGF I PGP cpp I TP 10 I Gro
G72 G72 G72 G60 665 G66 STAR 00
72 I Trio I cir I str30 I RIN
30
80 I SET4 GTO 10
Table 101 RG Range Elements - S92
© 2006 Fujitsu Services Company in Confidence Page 149
Fujitsu CNIM Low Level Design
Services
COMPANY IN CONFIDENCE
FUJ00171956
FUJ00171956
Ref: RS/LLD/004
Version: 4.0
Date: 8/05/2006
5.13.3.b.9.4 Test Plan - ADSL with ISDN and GSM Backup
[HKEY_LOCAL_MACHINE\SOFTWARE\ICL\Pathway
Configuration\CNIM\Test_Elements\RAIG_Range]
© 2006 Fujitsu Services Company in Confidence
Page 150
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
EIt] Opt I Op2 I Op3 ] Ops ] OpS I Op6 I Op? I Op8 I Op9I Opl0 I Opi] Op ] Op I Op Op
I 3 I 14 15
C0
co I utt Juiz I a3
TT [ser [ser [sit [cro
1 300 I 1010 I 2
300
2 [Set I Sar I Sit I cro
2 300 I 1010 I 22
300
% [set [sat [st I cto
3 300 I 1010 I 23
300
2 I eRK I GdD I ATT [ALO [ALC I ABT I ABH I MNT I MN I ORP I MDI I MD2 I MOS I Por I PGP I GES
6% I 31 I cat I est I os I ce I cs I T I ves Jatt Ist2 I vis I ces I ore
Gt
2 I BRK I GoD I ATT I ACO I ALC I ABT I ABH I WNT I MN I DRP I MOT I MO2 I MOS I POF I PCP I GES
6 }c3i I cat I cst I 42 I ce I cs I T I uss Jatt Ist2 I vis I ces I cre
62
m% I BRK I GdD [ATT [ALO I ALC I ABT I ABH I MNT I MN I ORP I MDI I MD2 I MOS I PoF I PGP I GES
69 I 633 I 33 I 33 I G43 I cs I cs I T I ves Ju Iut2 I vis I ces I cre
663
3 I TP I RIN
5
3 I TP I RIN
20
4 [set [sor I RIN
300 I 5
300
a I sar I TP I RIN
300 I 5
300
® [ser [qr [RIN
300 I 20
300
5 [Ros [PS [ort I sit I RIN
120 55
120
1] BRK I GoD I ATT I Str I ABT I DRP I M1 I MO2 I MDS I INE I Ste I RIN
co }o3 I55 Jou Juss Jun Iut2 I ut3 I star
T
2 [ark I cop [art [str [Ast I ORP I moi I wo2 I M03] INE I ste I RIN
co }o3i I55 I oa Iuss fun I uz I ais I star
T
3 I BRK I GoD I ATT I Str I ABT I DRP I M1 I wO2 I MOS I INE I STE I RIN
60 }633 I 55 I oa fuss fun I uz I ats I STAR
T
4 I SBH I SM2 I RIN
1200 I 560
1200 I 680
© I SBH I CM2 I RIN
1200
1200
© 2006 Fujitsu Services Company in Confidence Page 151
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
78 CBH M2 RIN
80 TTP PGF RIN
5 G8
81 RCM I CBH ‘SBH RIN
1200
1200
85 SET GTO
0 I 86
6 I BRK I GDD I moi I MO2 I wos I ALO I ALC I GES
oo fut I st2 I v3 I G31 I cai
90 CIT sTT
30
30
91 BRK I ATT I ALO I ALC I ABH PGF PGP cDD: TTP I RTN
G92 I G92 G92 I G81 G65, G78 STAR I 10
T
92 TIP crt sTT RIN
10 30
30
Table 102 Test Plan - ADSL/ISDN/GSM
© 2006 Fujitsu Services
Company in Confidence
Page 152
Fujitsu
Services
CNIM Low Level Design
COMPANY IN CONFIDENCE
FUJ00171956
FUJ00171956
Ref: RS/LLD/004
Version: 4.0
8/05/2006
Date:
5.13.3.b.9.5 Test Plan - ISDN Only
RAS outlets running on Service Type 14 are required to test the backup (ISDN)
connection every Wednesday evening during the evening.
The RIT (RAS ISDN Test) Call Plan period will be given a nominal time of 21:00 -
21:10, i.e. a 10 time period. However a randomisation factor built into CNIM will move
the start/end times back by a value between 0 and 160 minutes. The maximum offset
(160) is stored in OFFSET_RIT under the CNIM\Times section of registry. Therefor
the test will be carried out at any time between 21:00 and 23:40.
During this time period Fallback_ISDN will become mode 1 and CNIM will carry out a
series of test pings until the end of the call plan period.
Alteration of the backup ISDN test timing would require updates to registry and/or the
Call Plan file.
The test sequence is shown below.
[HKEY_LOCAL_MACHINE\SOFTWARE\ICL\Pathway Configuration\CNIM\Test_Elements\RIT_Range]
EI't I Op1 I Op2 I Op3 I Op4I OpS I Op6 I Op7 I Ops I Op9 I Opi
0
00 CDD I SET1 RCS
330
10 TTP 5 I GSB 20
11 BRK ATT 10 I FNL1 I GES
20 CTT STT 30] RTN
30
30 CTT STT 30
30
31 BRK ATT ALO ALC I ABH PGF PGP CDD I TIP GTO
G32 G32 G32 G40 G45 G46 STAR I 10 00
T
32 TIP cTT STT 30 I RTN
10 30
40 RCM I CBH SBH RTN
1200
1200
45 SBH RTN
1200
1200
46 CBH RIN
Table 103 RIT Range Test Elements - S92
CNIM will not carry out any bandwidth pings during this test phase.
The FNL element was added to ensure that the test results were logged before
switching test sequences
© 2006 Fujitsu Services
Company in Confidence
Page 153
Fujitsu
Services
CNIM Low Level Design
COMPANY IN CONFIDENCE
FUJ00171956
FUJ00171956
Ref: RS/LLD/004
Version: 4.0
Date: 8/05/2006
5.13.3.a.1.6 Test Plan - RAS at Idle
This is used by NDIS sites running on GSM at Idle, ie. Mode 4 (BNR Mode 2).
Connection Manager will have set the connection to idle. A test ping will be done
every minute to update the network state.
[HKEY_LOCAL_MACHINE\SOFTWARE\ICLIPathway
Configuration\CNIM\Test_Elements\RID_Range]
EI't Opt Op2 Op 3 Op4 Ops
00 GSB 10 CDD J40 GSB 20 GTO 50
10 CTT STT 60 60 RTN
20 SET 4 RTN
30 TTP 20 20 GSB 10 RTN
40 BRK ATT G30 CDD GSB 20 GTO 50
START
50 BRK ATT G30 GES
Table 104 RID Range Test Elements - S92
Each Break operation is at the start of an element and that element is always terminated by a
GoTo operation that takes control back to the start of the same element. The Break operation is
followed by operations that allow branching under certain conditions, i.e. the test timer has
expired or the line has opened or closed.
5.13.4 Code Character for Test Ranges
The character to be used to indicate in TuneableTrace which test range is in use, as
from S92, will be stored within registry in the following location.
[HKEY_LOCAL_MACHINE\SOFTWAREIICLIPathway Configuration\CNIM\Test_Elements\All_Range_Letters]
Value Name Value
B_Range ‘B'
D_Range 'D'
I_Range uM
E_Range 'E'
F_Range 'F'
P_Range 'P'
FR_Range 'R'
RIT_Range 'T'
RA_Range ‘A’
RG_Range 'G
RAIG_Range A
RID_Range 'K'
RAG_Range 'H'
© 2006 Fujitsu Services
Company in Confidence
Page 154
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
I FR_Range rR’
5.14 Keep Alive Strategy Overview
Requirement: See section 2.2.10
Keep Alive pings are required from CNIM in two situations.
e During Dial Back
e During Fixed Periods, e.g. FRIACO Fixed, Permanent Connection, etc.
Keep Alive will be carried out by sending "Pings" to one or more of the VPN servers with
which the Gateway is configured to communicate. During Keep Alive periods the Eicon card
will be configured with a suitable Shorthold Timer and Minimum Call Duration Time.
The interval between pings will be a configurable proportion of this time and will be optimised
to reduce the load on the VPN servers.
A KeepAlive module will be used to control the frequency and target of each ping. This module
will be responsible for parsing the VPN Policy file (SGVPN.INI) found on each gateway. Each
policy file contains the IP addresses of the VPN servers with which the outlet may establish
encrypted sessions.
At the first ping attempt CNIM will ping all eight VPN servers and store the address of the first
VPN server to reply. Thereafter CNIM will only target that VPN server for its Keep Alive
pings.
5.15 Time Format Overview
Requirement: See section 2.2.11.a
Time values are used within CNIM in a variety of ways. In particular input data from the Call
Plan and output data to the Monitor, Summary and Bandwidth files.
Data written to the trace file is also time stamped.
Times within CNIM are considered to be in U.T.C. except for those specified in the Call Plan.
5.16 Design Overview: GetStatus Query
Requirement: See section 2.2.13
The CNIM_Get_Status function is implemented with the CNIM_API.dll. This in turn interfaces
to the CNIM service using the RPC mechanism.
The CNIM_Get_Status function is called from the Counter Call Scheduler (CCS). The Get
Status report provides the current status of a network connection to the caller. It specifies the
defined connection type and the current mode of operation.
The function is called with a timeout parameter which defines the maximum length of time that
the CCS wishes to wait for network state information. If the network state changes during that
time period then CNIM will return the latest network state.
All parameters, with the exception of dwTimeout, are supplied as input/output parameters. This
is because CNIM will compare its current network values with those supplied by CCS. If these
differ CNIM will return immediately with the parameters updated to the latest values of network
state.
© 2006 Fujitsu Services Company in Confidence Page 155
Fujitsu
Services
FUJ00171956
FUJ00171956
CNIM Low Level Design Ref: RS/LLD/004
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
CNIM_DLL_API DWORD _stdcall CNIM_Get_Status(
DWORD
DWORD
DWORD
DWORD
CHAR
DWORD
DWORD
Where
*iConnStatus,
*iConnType,
*dwTickNailedUp,
*dwTickLastConnChange,
*swFailCode,
*dwTickPermanent
dwTimeout);
* Denotes return a value
The CNIM ‘Get_Status’ will return one of a set of values as shown in Table 105.
Any ‘nailed-up’ time reported by CNIM is from the start of the network connection up to the
expected close of that connection. In the majority of cases this will include a period ‘before’ and
‘after’ the SLA period as CNIM will randomise both the ‘start’ and ‘end’ times. With a
FRIACO connection type, the change from FRIACO-Establish to the FRIACO-Fixed will be
reported to the Counter Call Scheduler as a change of connection. This change will be instigated
by CNIM at a randomised time prior to the defined ‘start’ time.
Function Action Return Value
Function Succeeded 0
Function Timed Out* CNIM_GS_TIMEDOUT
Function Failed CNIM_GS_FAIL
Table 105 GetStatus Return Values
*Note: Timed Out indicates the function returned valid data after a specified timeout value
within which the line state did not change
The Connection Status parameter supplied to the GetStatus call will be updated
5.16.1 Connection Status
© 2006 Fujitsu Services Company in Confidence Page 156
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Value Defined Name Description
0 CNIM_GS_UNKNOWN Returned if the function call failed, e.g.the DLL could
not communicate with the CNIM service.
1 CNIM_GS_CONNECTED Connected — may or may not be nailed up
2 CNIM_GS_DISCONNECTED NOT connected (last call attempt succeeded)
3 CNIM_GS_LOST_CONNECT Connection was lost (cut) or disconnected
4 CNIM_GS_FAILED_ONCE First connection attempt has failed (may be after a lost
connection)
5 CNIM_GS_TEMP_UNAVAILABLE I More than one connection attempt has failed and not yet
deemed to be a permanent failure
6 CNIM_GS_PERM_UNAVAILABLE I Connection has failed and needs attention to get it back
Table 106 Connection Status Values
5.16.2 Connection Type
*iConnType - this indicates what type of connection is currently being used and is ignored if
supplied as NULL. It is in 3 parts, i.e. 3 bytes, with 00 returned if the function call failed.
Outlet type
(mask of
Oxff)
Value Meaning
00 Function call failed
OL Voice (mobile)
02 Satellite
03 Frame Relay
04 Bronze (Metered-On-Demand)
05 Metered ‘nailed-up’ (Silver part time A)
06 Metered ‘nailed-up’ (Silver part time B)
07 FRIACO ‘nailed-up’ (Silver Daytime) (C1)
08 FRIACO ‘nailed-up’ (Silver Daytime) (C2)
09 Non-FRIACO (Metered) ‘nailed-up’ (Silver Daytime)
10 FRIACO 24hour (Silver) (C1)
i FRIACO 24hour (Silver) (C2)
12 Non-FRIACO (Metered) 24hour (Silver)
13 ADSL
14 ADSL with ISDN
Table 107 Connection Type - First Byte
© 2006 Fujitsu Services Company in Confidence Page 157
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Current connection type
(mask of 0x00ff)
Value Meaning
0x0100 Satellite
0x0200 Metered
0x0300 FRIACO
0x0400 Voice
0x0500 ADSL
0x0600 ISDN with RAS
0x0700 GSM
0x0800 Frame Relay
0x0900 PSTN
Table 108 Connection Type - Second Byte
Current QoS type may be
one or more of the
following bitmap values
Value Meaning
0x010000 Nailed up period
0x020000 ‘Fixed’ connection
0x040000 Emergency connection
0x080000 Contracted Silver Outlet
Table 109 Connection Type - Third Byte
During a failed connection the current connection type and current QoS are those preferred for
the current period.
5.16.3 TickNailedUp
*dwTickNailedUp - this is a reference to a DWORD. When the function returns, the DWORD
will be set to the TickCount for the time at which CNIM will no longer 'nail up' the connection.
It is ignored if supplied as NULL.
This is used so that CCS knows when Riposte will no longer be nailed up.
5.16.4 TickLastConnectionChange
*dwTickLastConnChange - returns the tickcount for the start of the current connection, the
end of the last connection, or time a connection first failed as appropriate. This will change
when there is a fast reconnection that caller may not otherwise have detected. It is ignored if
supplied as NULL. The tickcount at the start of the service will be returned before the first
connection attempt.
© 2006 Fujitsu Services Company in Confidence Page 158
Fujitsu
Services
CNIM Low Level Design
COMPANY IN CONFIDENCE
FUJ00171956
FUJ00171956
Ref: RS/LLD/004
Version: 4.0
Date:
8/05/2006
5.16.5 FailCode
*swFailCode — supplied as an array of CNIM_GS_FCLEN bytes. A printable version of a
failcode is returned in this field if the last connection attempt has failed (indicates what failure
caused the primary connection to fail). It is “” for a successful connection (or disconnection)
and ignored if supplied as NULL.
CNIM is expected to choose the most appropriate form of representation for the fail code.
5.16.6 TickPermanent
*dwTickPermanent - returns the tickcount for when a failure is anticipated will become
permanent and needing attention.
5.16.7 Timeout
*dwTimeout - this indicates the timeout for the function in milli-seconds
If this value is (DWORD)-1 it will not timeout and will wait until it has something to return to
the caller.
If this value is >= 0 then the function will return either, (a) when it has something to report to
the caller, or (b) when the timer has expired (whichever occurs first).
If this value is 0 (zero) it will timeout immediately and ‘return’ the current status details.
5.17 Static Test Modes
There are two CNIM function calls that are test scenarios, initial testing at implementation when
CNIM is first installed and activated, and secondly during normal running as a test facility.
5.17.1.a CNIM Test — Implementation
During CNIM installation the Implementation test is called by Tivoli. In version 1 of CNIM the
metered numbers were tested to confirm network availability and then the registry flags shown
below would be modified depending on whether the test has been passed or failed.
Flag
Pre Test Value
Post Test Value - Fail
Post Test Value - Pass
MIGRATION_STATE
WITHIN_MIGRATION
WITHIN_MIGRATION
POST_MIGRATION
ImpTestResult
-blank-
FAIL
PASS.
dwimpTestResult
0
1
0
Service Start
Manual
Manual
Automatic
Table 110 Implementation Test Flags
In version 2 of CNIM the line is not tested and registry is updated to show that the test has
passed. The "Fail" values above are no longer required.
5.17.1.b CNIM Test — normal running
During normal running if the CNIM test function is invoked (CNIMConfig —t) will attempt Data
Centre calls using the Mode I Primary and Mode 2 Primary numbers.
A result file is created within the directory specified by the "Directory_Test_Files" entry in
"Live" registry and the filename prefix is specified by the "Test_Prefix" entry, see Table 48.
The file name has the following naming structure:
© 2006 I Fujitsu Services
><
> _<hh-mm>
Company in Confidence
Page 159
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
The file has the following format:
Time Service 1"No. OK? 2™No. OK?
(UTC) Type
dd/mm/yyyy I hh:mm:ss [1-12 I 11 Yes I 11 Yes
digits I or No I digits I or No
For example:
24/10/2001, 15:00:33, 7, 12345678911, Yes, 12345678912, Yes
From S60 (CNIM 3) the Normal Test is removed.
5.18 CNIM Reset
To change the service type of an Outlet, the new type is put into the CNIM ‘delivery’ Registry.
CNIM is then called with the ‘r’ option (CNIMConfig — r) that notifies CNIM that there has
been a change in service type and to re-read the Registry and file entries into the ‘live’ Registry.
This ‘reset’ function has the same effect as starting the CNIM service.
5.19 Service Installation and Configuration
CNIM is installed by the use of the command line instruction:
CNIM -install
And is removed by the use of:
CNIM -remove
On initial installation CNIM registry will contain certain default values.
During the migration phase of BI3 CNIM will be required to carry out an implementation test as
described in section 5.17.1.a. If the test is passed then the relevant registry flags will be set such
that CNIM will move to normal operation.
During the installation of a "spare" gateway the implementation test is not carried out and the
installation script will make the necessary registry changes.
5.20 CNIM Trace
CNIM Tracing is controlled by a set of flags defined in Table 111. Each text message output by
CNIM is assigned a low level trace flag.
Flag Hex Value Description
TL_MUST_LOG 0x00020000 Message must be logged.
TL_FN_ENTRY 0x00010000 Log function name on entry.
TL_LL_ERROR 0x00002000 Low level errors
TL_HL_ERROR 0x00001000 High level errors
TL_IDL DATA 0x00000400 IDI data
TL_VL_DATA 0x00000200 Very Low level data
TL_LL_DATA 0x00000100 Low level data
TL_ML_DATA 0x00000010 Medium Level data
TL_TT_DATA 0x00000008 Test Timer data
© 2006 Fujitsu Services Company in Confidence Page 160
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
TL_OP_DATA 0x00000004 Operation Element data
TL_HL_DATA 0x00000002 High level data
TL_EVENT_LOG 0x00000001 Log events to event log
Table 111 Trace Flags
CNIM Tracing module uses the following high level trace flags to determine whether messages
should be sent to the event log and whether events should be logged to file.
Messages may be in the form of a text string within the source code or a message stored within
the CNIM message DLL.
Messages are sent to one or more of the following outputs:
© CNIM bg file
e TuneableTrace log file
e Event log
¢ Debugging output
5.20.1 Default Trace Levels
The default trace levels used by CNIM for both CNIM trace and TuneableTrace, are given in
4.1.3.k and 4.1.3.1. These levels are supplied in registry during installation.
5.20.2 CNIM Log File
The CNIM log file may only contain a maximum number of lines. The file name, location and
maximum number of lines are specified in registry as shown in section 4.1.3.k. The level of trace
for this file is also specified in the same location in registry.
The file wraps around when the max. line count is exceeded.
The old log file is overwritten when CNIM starts.
At S60 (CNIM 3) the CNIM log file is no longer used.
5.20.3 TuneableTrace File
The trace files for TuneableTrace are created in the directory "C:\TuneableTrace" and are
archived automatically. The registry parameters controlling CNIM TuneableTrace are shown in
section 4.1.3.l.and are ID, Namel and Name2.
An application, TraceTune.exe is used to allow dynamic tuning of the trace entries in the
registered with TuneableTrace.
In order to start tracing the following command should be used.
TraceTune ADD name! name? instance tracelevel
This call will adjust the tracelevel for the component identified by the namel, name2 and
instance parameters. Tracelevel must be supplied as 8 hexadecimal digits. Empty string
parameters, should be supplied as “”. A tracelevel value of 0 will disable tracing.
Note that the registry parameter ID is used as the "instance" parameter in the TraceTune ADD
command.
CNIM may use the TuneableTrace function:
DWORD dwTraceLevel = TDTraceLevel(m_TuneableTraceHandle);
© 2006 Fujitsu Services Company in Confidence Page 161
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
5.20.4 Event Log
CNIM will register with the event log using the parameters shown in section 4.1.3.m. The
service has the source name "CNIM".
5.20.5 Debugging Output
When run in debug mode CNIM will output messages to the screen to aid development.
5.21 Trace Logic
Tracing is required to be able to output trace information to any of the four output types
mentioned above.
Tracing is controlled by the following parameters:
Parameter Output Description
Message Trace Level (MTL) I Any Trace Level assigned to
message.
Any one of the low level trace
levels.
Tuneable Trace Level (TTL) I TuneableTrace Current Tuneable — Trace
Level.
Combination of any low or
high level trace level.
CNIM Trace Level (CTL) CNIM Log Current CNIM log Trace
Level.
Combination of any low or
high level trace level.
DEBUG Flag Debug Output Flag set if running in debug
mode.
Table 112 Tracing Parameters
The logic for tracing is shown below in Figure 13.
© 2006 Fujitsu Services Company in Confidence Page 162
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Trace a Message either as simple text or as an event
message ID with text inserts
y
is it Simple >
Text No
Extract text from message DLL and
combine with inserts.
i
Get TuneableTrace Level (TTL)
Get CNIM Log Trace Level (CTL)
oO~™ Note the CNIM Trace
, ~ Level is used to
‘Is TL_EVENT_LOG determine if events
“flag set within CTL_~
Yes
are sent to the
event log.
Assign a Trace Level
to the message
(MTL) Send Message This gives the option to
to Event Log turn off all event
No logging
Send message to TuneableTrace with its assigned
trace level (MTL) Assign Trace Level
« TL_MUST_LOG
TuneableTrace will decide for itself whether to log to the message (MTL)
the message, if MTL flag is set within TTL
Get CNIM Log Trace Level (CTL)
Ag MTL flag set within
Yes << CTLor TL_MUST_LOG >
“set within MTL
Log to CNIM log file. No
Da Print Message
~~ nal
ewe in Yes to Screen
debug mode ’
- No > Finish le
Figure 13 Trace Logic
© 2006 Fujitsu Services Company in Confidence Page 163
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
5.22 Call Logging Logic
The logical interaction of the NetLevel objects, CNet, which waits for network events
and CLogger which controls the logging of QOS data, is shown below.
CLogger
PingMan
State
I CNetLevelTop Data Run Notification
I ConMan Registry
Notification
IDI Thread
Notification
ADM Registry
CNetLevel3 Notification
CNetLevel2 id
Poll = RAS API
——_ CNetLevelt $$
Figure 14 Call Logging Logic
5.23, CP4097 - 20 Minute Reset of Connection Manager
1. At initial ping failure CNIM will set a twenty minute "blackhole" timer.
2. CNIM will carry on doing bandwidth pings every 5 minutes, irrespective of the
network condition.
3. CNIM will terminate the timer if a ping succeeds.
4. Upon expiry of the 20 minute "blackhole" timer CNIM will retest the connection and
if the test fails it will request a connection reset. If the test succeeds then the test
cycle will be aborted.
5. CNIM will use the Connection Manager registry interface as explained in section
5.10 to set the reset flag.
5.24 CP4103 - Logging of GSM Received Signal Strength to TuneableTrace
The Connection Manager registry area used by CNIM is explained in section 4.1.3.q.
© 2006 Fujitsu Services Company in Confidence Page 164
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
As part of the Connection Management development, the registry value "CurrentDialParams"
will be modified to have three further comma-separated variables appended when the GSM
connection is in use. Three examples are shown below.
"49, 1234560010100A,0000,isdn,.ISDN,ADSL1" ADSL dial params
"49, h1234560010100C,0808 1401224,modem,T-modemCOM,COM11,GSM,?,?" GSM but info not available
"49, 1234560010100C,0808 1401224,modem,T-modemCOM,COM11,GSM,+CSQ: 23 99,123....789" GSM
with rssi and imei
CNIM will monitor the "CurrentDialParams" value in registry and will copy that entry to
TuneableTrace each time it is changed. CNIM will not attempt to interpret the signal strength
values.
© 2006 Fujitsu Services Company in Confidence Page 165
Fujitsu
Services
FUJ00171956
FUJ00171956
CNIM Low Level Design Ref: RS/LLD/004
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
5.25 Event Logging of Network Switch
CNIM will log the fact that it has succesfully changed or failed to change from one
connection type to another and the time at which the change attempt occurred. The
following table shows change of connectivity against event.
Start Network I End Network Action Event
Type (SNT) Type (ENT)
Idle/NDIS/ADSL/ I NDIS/ADSL/ Successful Connect 490 Network changed from (SNT) to
ISDN/GSM ISDN/GSM (ENT)
CNIM: Network changed from IDLE to
ADSL at 22/01/2006 20:30:38,
Idle/NDIS/ADSL/ NDIS/ADSL/ Failed Connect 491: Failed to change from (SNT) to.
ISDN/GSM ISDN/GSM (ENT)
CNIM: Network failed to change from
IDLE to GSM at 23/01/2006 11:56:07
Idle/NDIS/ADSL/ Idle Drop 490: Network changed from (SNT) to
ISDN/GSM IDLE
CNIM: Network changed from ADSL to
IDLE at 22/01/2006 20:30:38
ADSL ISDN Successful automatic 490: Network changed from ADSL to
failover to ISDN ISDN
CNIM: Network changed from ADSL to
IDLE at 22/01/2006 20:30:38
CNIM: Network changed from IDLE to
ISDN at 22/01/2006 20:30:48
ADSL No Connection Failed automatic 491: Failed change from ADSL to ISDN
failover to ISDN
ADSL/ISDN/GSM
No Connection
RAS connection
dropped due to
network failure.
No specific event required.
Note that a call closure record with
appropriate result, will be produced and
a ping failure event.
Table 113 Network Switch Event Requirements
CNIM will also log the results of the backup (ISDN) test that occurs automatically and
is marked in the Call Plan as an RIT period. CNIM will log the number of successful
pings against the total number of pings and will also display the result as a
percentage.
in Appendix A3.
These event descriptions, IDs and event types are shown below. More detail is given
Event Description Event ID Event Type
Successful Change of Network 490 T
Unsuccessful Change of Network
E
© 2006 Fujitsu Services
Company in Confidence Page 166
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Backup Test Result l 492 l I ]
Table 114 Events for Change of Connection Type
© 2006 Fujitsu Services Company in Confidence Page 167
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
6 IMPLEMENTATION
6.1 Service
The service is implemented in C++. A base class is used to provide generic NT service
functionality. A derived class provides functionality specific to the CNIM service.
6.1.1 Threading
The service is implemented as the following threads:
e A main thread, which receives service control notifications from the SCM and sends service
status notifications to the SCM. It passes control requests to a watcher thread.
e ACCNIM thread that receives control requests from the main thread and implements these.
This prevents the main thread from blocking waiting for the service to implement the
control.
e A CallManager Test thread which controls testing of the line.
e An EiconManager Logging thread which monitors the line state using the IDI interface and
logs call data.
e A KeepAlive thread which may be activated to continuously ping the VPN servers.
e An RPC thread which is used to monitor RPC connections from the CNIM_API DLL.
e API external thread for GetStatus.
The structure of the main threads is shown Figure 15.
The main thread handles the main() executable entry point, and also the service notification
handler function.
The service thread contains ServiceMain(), the point of execution for the service. In turn, the
service thread creates the logger and tester threads and then performs the main functionality of
the service within its Run() function.
The logger and tester threads implements stop and shutdown control requests. They carry out
the essential functionality of CNIM.
© 2006 Fujitsu Services Company in Confidence Page 168
Fujitsu
Services
CNIM Low Level Design
COMPANY IN CONFIDENCE
FUJ00171956
FUJ00171956
Ref: RS/LLD/004
Version: 4.0
Date: 8/05/2006
CNIM Process
main ()
{
}
StartServiceCtr1Dispatcher (ServiceMain)
Main thread starts the
Service control dispatcher
service control dispatcher
Dispatcher calls handler.
(on main threa
Di
and
ispatcher creates thread
calls ServiceMainfunction
(on secondary thread)
Main thread
Handler(...)
{
case SERVICE_CONTROL_STOP ...
case SERVICE_CONTROL_INTERROGATE ..
case SERVICE_CONTROL_SHUTDOWN ...
Service thread
ServiceMain()
{
Run ()
RegisterServiceCtrlHandler (Handler)
Launch watcher thread(WatcherProc)
SN
Test Thread Logger Thread
TestProc() LoggerProc()
{ {
case STOP case STOP
case SHUTDOWN case SHUTDOWN
case START_TEST case LINE_UP
case STOP_TEST case LINE_DOWN
, ,
Figure 15: Service threading
6.1.2 Service control notifications
The SCM requests the service to change state by sending notifications to the service notification
handler function:
Notification
Meaning
Comments
SERVICE_CONTROL_STOP
Requests the service to stop.
Supported
SERVICE_CONTROL_PAUSE
Requests the service to pause
Not supported
SERVICE_CONTROL_CONTINUE
Requests the paused service to
resume.
Not supported
SERVICE_CONTROL_INTERROGATE
© 2006 Fujitsu Services
Company in Confidence
Page 169
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Requests the service to update Supported
immediately its current status
information to the service control
manager
SERVICE_CONTROL_SHUTDOWN Requests the service to perform Supported
cleanup tasks, because the system is
shutting down.
RANGE 128 TO 255 User defined notifications Not supported
When a control notification is received, the service will report the appropriate status
notification, see section 6.1.3.
6.1.3 Service status notifications
The service will report its state to the NT Service Control Manager using the usual
SetServiceStatus() API:
State Meaning When reported
SERVICE_START_PENDING The service is starting. I As soon as ServiceMain() is entered.
SERVICE_RUNNING The service is running. I As soon as Run() is entered.
SERVICE_PAUSE_PENDING The service pause is Not reported; pause and continue are
pending. not supported
SERVICE_PAUSED The service is paused. I Not reported; pause and continue are
not supported
SERVICE_CONTINUE PENDING I The service is Not reported; pause and continue are
resuming. not supported
SERVICE_STOP_PENDING The service is As soon as SERVICE_CONTROL_STOP
stopping. notification is received at Handler()
and again after breaking out of main
processing loop
SERVICE_STOPPED The service is not When the service has broken out of
running. its main processing loop and tidied
up
Failure to respond to service control notifications in a prompt manner with the appropriate
service status notification will cause the NT SCM to think that the service is no longer
responding.
© 2006 Fujitsu Services Company in Confidence Page 170
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Service start-up:
Service initialisation is not a lengthy activity and consequently SERVICE_START_PENDING
notifications with wait hints and periodic checkpoints are not required.
Service stop / shutdown:
Service stop/shutdown may be a lengthy activity and consequently SERVICE_STOP_PENDING
notifications with wait hints and periodic checkpoints are required.
When a SERVICE_CONTROL_STOP or SERVICE_SHUTDOWN notification is received by the
Watcher thread it issues a SERVICE_STOP_PENDING notification, signals the Service thread to
stop and then exits. The Service thread on detecting the stop signal issues a further
SERVICE_STOP_PENDING notification, tidies up and issues a SERVICE_STOPPED notification
before exiting.
6.1.4 Inter-thread Communication
Communication between the Main thread and the Watcher thread is via events. The Main thread
on receipt of service control notifications signals events from the SCM as follows:
EVENT Service Control Notification Comments
STOP. SERVICE_CONTROL_STOP Supported
PAUSE SERVICE_CONTROL_PAUSE Not supported
CONTINUE SERVICE_CONTROL_CONTINUE Not supported
SHUTDOWN SERVICE_CONTROL_SHUTDOWN Supported
Communication between the Watcher thread and the Service thread is via events. The Watcher
thread on detecting signals from the Main thread signals events as follows:
EVENT Signal Detected Comments
WO_STOP STOP or SHUTDOWN
6.1.5 Service Events
Whilst in its main processing loop the Service thread is waiting for one of a number of events to
be signalled. The action taken upon notification of an event is dependent on the state. The
following sections show for each state the events that can be signalled and the action that is
taken.
6.1.5.a CCNIM
EVENT Action
m_hStopEvent service stop event
m_hPauseEvent service pause event
m_hContinueEvent service continue event
6.1.5.6 CCallManager - Test Thread
© 2006 Fujitsu Services Company in Confidence Page 171
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
EVENT Action
m_hTesterShutdownEvent
Test Thread should return, service is shutting down
m_hStartTest
Start Test on Timer Expiry
m_hStartDialBack
Start a Dial Back
m_hNormalTest;
Start a Normal Test
m_hSetMode3
Set Mode 3 Parameters
m_hCallActivated
A Call has been Activated
m_hCallClosed
A Call has been Closed
m_hReset
Reset all CNIM Parameters
m_hStartCPTest
Start of Call Plan Period
Table 115 Test Thread Events
6.1.5.¢ CEiconManager - Logging Thread
EVENT
Action
m_hLogShutdownEvent
Stop thread, service stopping.
m_hPingOK_ Satellite
Ping Succeeded on Satellite Service
m_hPingFailed_Satellite
Ping Failed on Satellite Service
m_hEndOfDay
End of Day, Update and Rename QOS Files
m_hLayer1_Lineldle
Line has gone Idle
m_hLayerl_LineOut
Line has connected out
m_hLayer!_LineIn
Line has connected in
m_hLayer2_Activating
Layer 2 is activating
m_hOpenSummaryRecord
Open a new Summary Record
m_hDropThrough
Go through wait loop
m_hIDI_ Reset
Reset the IDI interface
Table 116 Eicon Manager Events
© 2006 Fujitsu Services
Company in Confidence Page 172
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
6.2 Classes
CNIM is constructed as a multithreaded service with the functionality to carry out three main
tasks:
1) Log all calls made to and from the outlet.
2) Test and reconfigure the connection.
3) Provide connection status information to any application that requests it.
6.2.1 Class Overview
CNIM classes are shown within the boundary whilst external modules which provide an
interface to which CNIM connects, are shown outside.
© 2006 Fujitsu Services Company in Confidence Page 173
Fujitsu CNIM Low Level Design
Services
COMPANY IN CONFIDENCE
FUJ00171956
FUJ00171956
Ref: RS/LLD/004
Version: 4.0
Date:
8/05/2006
CNIM Classes
CallManager —— CEiconManager
RPC Module
icnimsc (=> CRPCManager
DIAPI
IDI Interface I eave
Eicon Card
° CNIM_API.dll
XY > Counter Call Scheduler)
Figure 16 CNIM Class Overview
6.2.2 CService
The CService class provides a generic NT service capability.
6.2.3. CServicelnstall
The CServiceInstall class provides the functionality required to install and remove the service.
The public methods Install () and Remove () are modified as follows:
e They return a bool value, TRUE indicating success and FALSE indicating failure.
© 2006 Fujitsu Services Company in Confidence
Page 174
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
e They output information and error messages to the Event Log.
6.2.4 CCNIM
The CNIM service class CCNIM is derived from CService.
The CCNIM class provides methods that support service specific functionality, namely:
e The processing logic within the Service thread required during service startup, running and
closedown.
6.2.5 CEiconManager
The CEiconManager class controls the Eicon card configuration and monitors line state for
logging purposes
The IDI interface is configured to notify CNIM when the line state changes. In addition the
interface is used to retrieve the current connection status and the last disconnection Cause Code
retrieved from the network.
The DIAPI interface is used to reconfigure the Eicon card with the appropriate telephone
number(s) and parameters such as the Minimum Call Duration Time (MCDT).
IDI Interface
~ CEiconManager
DIAPI Interface
Request Notification of: sg
Line Up lai DiClose()
Line Down / s
Line Activation int DI_Disabe int chan)
int Di_Enable (int chan)
GetCauseCode() Int Di_SaveNumbers (pdinumbers pnumbers)
GetLineState() Int Di_GetNumbers (pdinumbers pnumbers)
GetLayert State int DL SavePids (char ‘pwed_inbound
v 0 IDlinterface I pete char “pwd_outboundl
char *usr_inbound[MMAX_USER_NARE_CNT]
char *usr_outbound)
int Di_GetPads (char *pwd_inbound,
char “pwd_outbound,
char *ust_inbound(MAX_USER_NAME_CNT]
char *ust_outbound)
Eicon Card
int DI_SetCommOpts (paicommopts poopts)
int Di_GetCommOpts (pdicommopts poopts)
Figure 17 Eicon Interfaces
The EiconManager is responsible for controlling the CNIM Logger thread. Essentially this
thread waits for line events and responds appropriately, for example to update the current
Monitor and Summary files.
The logger thread will also interact with the test thread, so that when the line is activated by
some external application the tester thread is aware of this event and may test the line if
required.
© 2006 Fujitsu Services Company in Confidence Page 175
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
CEiconManager:
Logger Thread:
v
Wait For Line Event
a Open Monitor Record
Event Line Up
Close Monitor Record
Event Line Down
IDI Interface
Event Line Up
Event Line Down
Line State
Figure 18 Logging Thread - IDI Interaction
6.2.5.a Protected Members
static CEiconManager* I _m_pThis Static pointer to this
‘CDIAPI_ Manager m_DIAPI_Manager DIAPI Interface Manager
CIDI_ Manager m_ IDI Manager TDI Interface Manager
‘CRunMode m_ModeCurrent ‘Current Run Mode
‘CRunMode m_ModeRequired Run mode required for new Call Plan
period
CPeriodRecord m_PeriodRecord ‘Current record in the summary file
‘CMonRecord m_MonRecord ‘Current record in the monitor file
CEventList m_IstLineEvents List of line events received from IDI
‘CCallManager* m_pCaliManager Pointer to the Call Manager
eCallResult m_erLastResult Result from last eall closure
‘SYSTEMTIME m_sysStartTime Time at which call started
‘SYSTEMTIME m_sysEndTime Time at which call ended
DWORD m_dwLogThreadld ThreadID for the Log Thread
DWORD m_dwLogkxitCode Exit code for the Log THread
DWORD m_dwTickStart Tick count at call started
© 2006 Fujitsu Services Company in Confidence Page 176
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
DWORD m_dwTickEnd Tick count at call ended
BOOL m_bSatelliteCallStarted Has satellite call started
BOOL m_blsLogRunning IsLog Thread running
BOOL m_bPingOK Did Last Ping Succeed
BOOL, ‘m_bAwaitingNumberChange Tndicates if a number change is
underway
eLineState
m_LastState
Last line state recorded from IDI
eLineMode
m_LineMode
Line mode is either ISDN or Data
eLayeri State
m_L1State
Layer I state
CString m_esB1RemoteAddress Channel B1 Remote Address
CString m_esB2RemoteAddress Channel B2 Remote Address
CString m_esBILineState ‘Channel BI Line State
CString m_esB2LineState ‘Channel B2 Line State
‘m_esB1CauseCode
‘Channel BI Cause Code
wring
m_esB2CauseCode
‘Channel B2 Cause Code
CString
m_esCaliDate
Monitor Record Call Date
CString
m_esCallStartTime
“Monitor Record Start Time
m_esCallEndTime
‘Monitor Record End Time
CString
Monitor Record Call Duration’
CRITICAL_SECTION
‘m_CS_LineEvents
Critical Section Guarding Line Events
CRITICAL_SECTION
m_CS Codes’
Critical Section Guarding Cause Codes
CRITICAL_SECTION
m_CS_GetLineData
Critical Section Guarding Line Data
CRITICAL_SECTION
m_csRunMode
Critical Section Guarding Run Mode
static m_CS IDI Critical Section Guarding IDI Interface
CRITICAL_SECTION
HANDLE m_hIDI Reset Event Handle for IDI Reset
HANDLE m_hDropThrough Event Handle for dropping through
HANDLE m_hLayer!_Lineln Event Handle for Line In
HANDLE m hlayer!_LineOut Event Handle for Line Out
HANDLE m hLayer! Lineldle Event Handle for Line Idle
HANDLE m_hEndOMay Event Handle for write the period file
HANDLE m_hPingOK_ Satellite Event Handle for satellite ping succeeded
HANDLE m_hPingFailed Satellite Event Handle for satellite ping failed
HANDLE m_hOpenSummaryRecord Event Handle for ereate a summary
record
HANDLE m_hLayerl_Up Event Handle for Layer I up
HANDLE m_hLayerl_ Down Event Handle for Layer 1 down
HANDLE m_hLayer2 Activating Event Handle for Layer 2 activating
HANDLE m_hLayer2 Activated Event Handle for Layer 2 activated
HANDLE m_hLayer2_ Closing Event Handle for Layer 2 closing
HANDLE m_hLayer2_ Down Event Handle for Layer 2 down
HANDLE m_hLineDown Event Handle to signal that line number
can be changed
HANDLE m_hLogThread Event Handle for the Log THread
HANDLE m_hAbandonSetCardNumber Event Handle for Abandon Card
Configuration
HANDLE m_hLogShutdownEvent Event Handle for Shutdown event
HANDLE m_hLineOutForCheck To signal that line is connected out
© 2006 Fujitsu Services
Company in Confidence
Page 177
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
6.2.6 CCallManager
The CCallManager class controls the testing and choice of line numbers, depending on data
from the Call Plan.
CallManager contains a member which is an instance of CCallPlan. This member is initialised at
service start up and when a reset is requested.
CallManager is responsible for parsing the Call Plan file and creating a list of call plan elements
which are logically grouped by Network Service Type and then by Day of the Week.
© 2006 Fujitsu Services Company in Confidence Page 178
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Note: All times in the Call Plan are considered to be local time,
‘msiType = PC
Monday
0900-3400
Day= Tuesday
Pettod: 00100-3400
ComiType= PC
FRIACO Silver Daytime A
DefiultConiTyp2 = MOD.
Day Montay
Callmanager Peat 0000-000, 01.00.0800,
Comtype= MOD. FE
Parse Call Plan
Create Call Plan List \ Pati 00.0001 60, 0100.08.00, 08 00-17 30,
\ ComType= MOD. FE. Fr
\
\ I bay Friday
\ Pettod= 00-00-0100, 01-00-0800, 0800-17-30, 17-30-2400
ComType= MOD. FE. Fr Mop
) Peniod= 00-00-0100, 0100-08-00, 08:00-13:00, 1300-2400
v ComType= MOD. FE, Fe Mop
Call Plan Day= Sunday
Methods: ‘Conn Type MOD, FE, MOD
GetCurrentElement
re)
[Non FRIACO Silver 24HR
=MF
El1 I E12 I E13 I E14 I EIS
DetiltConnTy
Day= Monday
EIQt I Fl22 I £125 I El24 I £125 pened ewane240
X% \ yf ‘Conn Type= MF
\ ConiType= MF
Saturday
CP Element + 00 00-2400
Properties: ComfType= MF
Start Time Day sunday
Peto 60-00-24 00
End Time ComiType= ME
Connection Type
Figure 19 Call Plan Conversion to Element List
© 2006 Fujitsu Services Company in Confidence Page 179
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
The CallManager is responsible for control of the TestManager which converts the CPL
Elements in registry into a linked list of TestOperations, grouped into TestElements and stored
by TestManager as a set of ElementLists, one list per connection type.
CallManager test thread is used to run each operation in turn, each operation being able to
return the address of the next operation to run.
CCallManager contains a CPL interface comprising a number of class methods which may be
called by the current test operation.
Each operation will call its own Run method which calls the appropriate CCallManager function
within the CPL interface.
v
Test Manager
Voice on Demand CPL
Typical Element Lists OOATT 01
O1SET 1GTO 02
VOD Element List O2BRKALC 21GTO 02
O3CTTSTT 300 900GTO 51
MOD Element List O4SET 2TTPPGF O5PGP 10
. OSSET 1CTTSTT 450 1350GTO 52
I I I Dial Back Element List O6SET 2TTPPGP 10PGF 07
ee \) O7SET 3CTTSTT 900 900GTO 56
\ CallManager: * O8SET 1TTPPGP 02PGF 09
O9SET 3CTTSTT 900 900GTO 57
Member: 1OCTTSTT 1800 5400GTO 53
\ Testmanager 11CTTSTT 300 900GTO 54
\ 12SET 1TTP PGP 02PGF 13
Test Thread y Break 13SET 2CTTSTT 450 1350GTO 55
\ Wait Line or Time Event 14SET 1TTPPGP 02PGF 15,
15SET 2GTO 10
Y 21CLP O2CLF 03
Run List of Test Operations 25CLP O2CLF 51
" A__untilBreakorEnd I 26CLP O2CLF O4ENC 04
S1CLP O2CLF 52
I or \500 GTO II I ¥ 32CLP O2CLF O6ENC 08
900 Break/End 36CLP 14CLF 53
[ 36CLP 14CLF 11ENC 14
End 41CLP 10CLF 54
\ / Y 42CLP 10CLF 12ENC 12
End - Reset Operation List ASCLP 10CLF 55
46CLP 10CLF 18ENC 06
\ Call Run Method S1BRKALC 25ATT 26GTO 51
\ 52BRKALC 31ATT 32GTO 52
S53BRKALC 35ATT 36GTO 53
/ S4BRKALC 41ATT 42GTO 54
SSBRKALC 45ATT 46GTO 55
SEBRKATT O8GTO 56
57BRKATT O6GTO 57
Test element 03
CPL Interface
Test Operation _otctt
TOT_STT
Cancel Test Timer
_OT_END
Figure 20 CPL to Test Sequence Schematic
© 2006 Fujitsu Services Company in Confidence Page 180
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
6.2.6.a Protected Members
‘static CCallManager* ‘m_ pThis Static pointer to this
‘CEiconManager*™
‘m_pEiconManager
Pointer to the Ficon Manager instance
static eFailMode
m_FailMode
Current fail mode status for CCS
CTestManager m_TestManager Test Manager member
CRegistryManager m_RegistryManager Registry Manager
CTestMode m_TestMode Current Failure Condition
(CTimerManager* m_pTimerManager Timer Manager
(CPingManager Ping Manager
eCallResult m_erLastResult Result of last call
(CCallPian m_CallPlan Call Plan
BOOL m_bPingSucceeded Did the last ping succeed
int m_iLocalCallAttempts ‘Number of focal call attempis
int ‘m_iSuccessfulCallAttempts Number of successful focal call attempts
int ‘m_iFailedCallAtempts Number of failed local eall attempts
int m_iStoredMode Store the last connection mode
static BOOL ‘m_bCallPlanOK Is Call Plan stored OK
BOOL m_bisEicon ‘Do we have Eicon available
DWORD m_dwTesterThreadld Tester Thread ID
DWORD m_dwTesterExitCode Test Exit Code
HANDLE m_hTesterShutdownE vent Handle to event for thread shutdown
HANDLE m_ hTesterThread Handle to tester thread
HANDLE m_ hSetToLast Flandle to event to set return to previous test
sequence.
HANDLE m_hCallActivated Event indicating call activated
HANDLE ‘m_hCaliClosed Event indicating call closed
HANDLE m_ hStariTest Event indicating test started
HANDLE m_hStartCPTest Event indicating new Call Plan period
HANDLE m_hSetMode3 Event to set Mode 3
HANDLE ‘m_hNormalTest Event to run Normal Test
HANDLE m_himpTestComplete Event indicating Implementation test complete
HANDLE m_hReset Reset CNIM parameters
HANDLE m_hStartDialBack Start dial back sequence
HANDLE m_hLineUp Line Up event handle
HANDLE m_hLineDown Line Down event handle
CRITICAL_SECTION
‘m_CS_ServiceType
Protect Get Service Type
static CRITICAL_SECTION
_m_CS FailMode
Protect Get Fail Mode
static CRITICAL_SECTION _m_CS_TestMode Protect Test Mode
static CRITICAL_ SECTION ‘m_CS_RunMode Protect Run Mode
static CRITICAL_ SECTION m_CS Protect Initialisation
static CRITICAL_ SECTION m_CS_ConType Protect Get Connection Type
6.2.7 CCallPlan
This class is responsible for reading the text file containing Call Plan information and storing it
as a set of Call Plan elements.
© 2006 Fujitsu Services
Company in Confidence
Page 181
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
6.1.8 CTestManager
A TestManager object is held by the Call Manager and controls the complete line test sequence.
The Test Manager holds a set of test elements for each test scenario, where each test element
comprises a set of test operations.
The Test Manager will be initialised at service start up to read in each range of elements from
registry and to check that each element can be parsed and that the range is complete. There
should be no missing links in the chain of elements.
The following test sequences must be provided:
E Range for FRIACO Establish
F Range for FRIACO Fixed
D Range for Metered (Dialled) Fixed
I Range for Voice on Demand
P Range for Permanent Connection (Satellite)
B Range for Dial Back
N Range for Normal Test
At any given time CNIM will be within one of the above sequences.
6.1.9 CIPAddress
The CIPAddress class supports the creation and manipulation of IP addresses. In general this
class is used to convert a string read from text file, into an IP address capable of being
recognised by the Win32 API.
6.1.10 CEventLog
The CEventLog class supports the output of events to the NT event log.
© 2006 Fujitsu Services Company in Confidence Page 182
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
7 NON FUNCTIONAL REQUIREMENTS
7.1 Performance
Performance requirements are as yet undefined
¢ The CNIM will not have a significant impact on the performance of other processes.
7.1.1 Registry sizing
Section 4.1.3 specifies the size and number of Registry items used.
7.1.2 Event logging
Section 8.4 estimates the volume of information logged to the NT event log.
7.2 Resilience
This section describes how the CNIM is resilient to various types of failure. The following are
discussed:
© Corrupt Policy File
¢ Terminal failure of the CNIM service
7.2.1 Corrupt Policy File
A corrupt Policy File will necessitate replacement of the gateway counter PC. It would not be
possible for CNIM to determine the IP addresses of the VPN servers.
7.2.2. Failure of the CNIM service
A terminal failure of the CNIM service will require a reboot of the gateway counter PC.
7.3 Security
7.3.1 Event Logging
The event logging does not compromise security. It does reveal the state of the CNIM at
various times.
7.4 Systems Manageability
7.4.1 Installation/Removal
The installation procedure for the CNIM service is as follows:
1. Enter installation registry entries from CNIM.reg file
2. Run CNIM.exe with a —install option from an appropriate batch file. CNIM makes the
required Service Control Manager calls to register itself as a service. It returns a value of 0
in the event of success and non-zero if an error occurred.
Note that the service does not need to be started because the system will reboot following the
installation.
When running the installation functionality CNIM detects which platform it is running on to
ensure that it is only installed on the gateway counter (the installation command will be run on
both gateways and slaves). This counter state is determined by examining the registry entry
[HKEY_LOCAL_MACHINE\SOFTWARE\ICL\Pathway \Fingerprint\Variables]
The _CType value is set to "Gateway", "Slave" or "Training"
© 2006 Fujitsu Services Company in Confidence Page 183
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
If this value is not equal to “Gateway” then CNIM does not register with SCM and returns 0.
CNIM also supports an —uninstall option. This stops and de-registers the service by making the
appropriate Service Control Manager calls. It returns a value of 0 in the event of success and
non-zero if an error occurred.
7.4.2 Startup and Shutdown procedures
The Service Control Manager will manage the CNIM service by starting the service
automatically. Subsequent control is via the Control Service API (OpenService(), StartService(),
ControlService()).
For development testing, the CNIM can be controlled using the NT Control Panel Services
applet, or the net start/stop console command.
7.4.3, Maintenance
No regular maintenance or housekeeping is required for the components described in this
design. Error messages are logged using the NT event log, see section 8. The existing
mechanisms for management of the NT event log will be used.
7.4.4 Software Distribution
The files identified in section 11.1 will be distributed by Tivoli.
The service will respond to requests to stop (SERVICE_CONROL_STOP in the service notification
handler function). Tivoli can stop the service to undertake software distribution, and can then
restart the service.
7.4.5 Year 2K compliance
The deliverables will be Year 2000 compliant.
7.4.6 Finite Date Limits
None.
7.5 Extensibility
There are no extensibility requirements at this time.
© 2006 Fujitsu Services Company in Confidence Page 184
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
8 ERROR HANDLING AND EVENT LOGGING
8.1 Logging Requirements
Errors detected by the CNIM service will be logged to the NT event log.
8.2 Event Logging
A list of event log messages is available in Appendix Al.
The event log source name “CNIM” is used:
The event log message .dll is registered via a registry script
The service will make informational entries in the NT application event log when the service is
ready to perform work and when it is closing down. Any errors will also be logged.
8.3 Auditing
There are no specific auditing requirements associated with this design.
8.4 Event Logging Estimates
This section estimates the volume of information logged to the NT event log.
Activity Number of messages logged
Service startup 12
Service shut down 1
InitiateCrypt entries added to policy File I 4
Table 117 Event Logging Estimates
© 2006 Fujitsu Services Company in Confidence Page 185
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
9 TARGET ENVIRONMENT
Outlet Gateway PC.
© 2006 Fujitsu Services Company in Confidence Page 186
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
10 TESTING REQUIREMENTS
See [Ref 21]
© 2006 Fujitsu Services Company in Confidence Page 187
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
11 DELIVERABLES
11.1 Software
The following form the software deliverables:
File Description
CNIM.exe CNIM service
CNIM_msg.dll CNIM message .dil
CNIM_APIdll CNIM API .dil
CNIMConfig.exe CNIM configuration executable
CNIM.reg Initialise CNIM registry settings
These files will be installed/run on the gateway counter PC.
11.2, Documentation
A handover document gives instructions on how to install CNIM.
© 2006 Fujitsu Services Company in Confidence Page 188
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
12 ASSUMPTIONS AND RISKS
12.1 ASSUMPTIONS
The following assumptions have been made concerning this development. The risk of these
assumptions not being valid is discussed below:
ASS I DESCRIPTION
Al The requirements identified in section 2 are complete and correct.
12.2. RISKS
The following risks are associated with this development:
RISK I SEVERITY I DESCRIPTION
RI MEDIUM All assumptions (see section 12.1) are valid
© 2006 Fujitsu Services Company in Confidence Page 189
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
13: DESIGN CONFORMANCE
This table provides a measure of the compliance of the design against the requirements
described in section 2.
The following syntax is used in the Conform column:
A* indicates that the requirement has been satisfied
A* followed by a reference number indicates that the requirement has been satisfied and
specifies where in the design the requirement is satisfied
A* indicates a non-conformance
A D indicates a dependency on another development
The Comments column can be used to add any additional information (there should be no non
conformances or dependencies without a description in the comments column]
Tag I Doc I Ref I Description Conform I Comments
1 5.1 The CNIM shall run as an NT service *
under the LocalSystem account. The
service shall start automatically.
2 5.3. I CNIM will configure the Eicon card in a *
manner which is consistent with the mode
of operation required.
3 5.4 I CNIM configuration of the Eicon card and I *
mode of operation will be within the
concept of a Network Service Type that is
assigned to the outlet.
4 5.5 I Outlet configuration data for phone
numbers and Network Service Type is
delivered via a CDF. See [Ref 21]. CNIM
is required to retrieve CDF data from
registry.
5 5.6 I CNIM configuration of the Eicon card and
mode of operation will be within the
concept of a Call Plan that is generic
across all outlets.
6 5.7 I CNIM will log each call to a Monitor file I *
and produce a Summary file of the calls
for each day.
7 5.8 I If CNIM detects that the Data Centre has_ I *
attempted to contact the outlet whilst the
line is disconnected, it will go into
KeepAlive mode to cause the line to
connect.
9 5.14 I During certain periods of the day CNIM is I *
required to maintain the line connection to
eliminate the call setup time.
© 2006 Fujitsu Services Company in Confidence Page 190
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
CNIM may also be required to maintain
line connection if a call from the Data
Centre to the outlet has been detected.
10 5.15 I All times used by CNIM will be in UTC .
with the exception of times specified
within the Call Plan.
Call Plan times will be in local time so that
the same Call Plan can be used throughout
the year.
11 5.16 I CNIM will accept a "GetStatus" query *
from an external source. CNIM will return
data related to the current connection type
and status.
12 5.17 I CNIM is required to supply two static test
modes:
Implementation Test
Normal Test
© 2006 Fujitsu Services Company in Confidence Page 191
Fujitsu CNIM Low Level Design
Services
COMPANY IN CONFIDENCE
FUJ00171956
FUJ00171956
Ref: RS/LLD/004
Version: 4.0
Date: 8/05/2006
Appendix Al. I CALL PLAN - CNIM 1,2,3
Note: All times in the Call Plan are considered to be local time.
:CNIM Call Plan
;PC=Permanent Connection
sMOD=Metered-On-Demand
;VOD=Voice on Demand
:MF=Metered-Fixed
;FE=FRIACO Establish
;FF=FRIACO Fixed
[2]
Satellite
DefaultConnType = PC
Day= Monday
Period= 00:00-24:00
ConnType= PC
Day= Tuesday
Period= 00:00-24:00
ConnType= PC
Day= Wednesday
Period= 00:00-24:00
ConnType= PC
Day= Thursday
Period= 00:00-24:00
ConnType= PC
Day= Friday
Period= 00:00-24:00
ConnType= PC
Day= Saturday
Period= 00:00-24:00
ConnType= PC
Day= Sunday
Period= 00;00-24:00
ConnType= PC
0)
sVoice
DefaultConnType = VOD
Day= Monday
Period= 00:00-24:00
ConnType= VOD
Day= Tuesday
Period= 00:00-24:00
ConnType= VOD
Day= Wednesday
© 2006 Fujitsu Services Company in Confidence
Page 192
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Period= 00:00-24:00
ConnType= VOD
Day= Thursday
Period= 00:00-24:00
ConnType= VOD
Day= Friday
Period= 00:00-24:00
ConnType= voD
Day= Saturday
Period= 00:00-24:00
ConnType= VOD
Day= Sunday
Period= 00:00-24:00
ConnType= VOD
[4]
:Bronze
DefaultConnType = MOD
Day= Monday
Period= 00:00-24:00
ConnType= MOD
Day= Tuesday
Period= 00:00-24:00
ConnType= MOD
Day= Wednesday
Period= 00:00-24:00
ConnType= MOD
Day= Thursday
Period= 00:00-24:00
ConnType= MOD
Day= Friday
Period= 00:00-24:00
ConnType= MOD
Day= Saturday
Period= 00:00-24:00
ConnType= MOD
Day= Sunday
Period= 00:00-24:00.
ConnType= MOD
[5]
;Silver PartTime A (Metered)
DefaultConnType = MOD
Day= Monday
© 2006 Fujitsu Services Company in Confidence Page 193
Fujitsu CNIM Low Level Design
Services
COMPANY IN CONFIDENCE
FUJ00171956
FUJ00171956
Ref: RS/LLD/004
Version: 4.0
Date: 8/05/2006
Period= 00:00-08:30, 08:30-10:30,
ConnType= MOD, MF, “MoD
Day= Tuesday
Period= 00:00-08:30, 08:30-09:30, _09:30-24:00
ConnType= MOD, MF, MOD
Day= Wednesday
Period= 00:00-24:00
ConnType= I MOD
Day= Thursday
Period= 00:00-08:30, 08:30-09:30, 09:30-24:00
ConnType= MOD, MF, MOD
Day= Friday
Period= 00:00-24:00
ConnType= MOD
Day= Saturday
Period= 00:00-24:00
ConnType= MOD
Day= Sunday
Period= 00:00-24:00
ConnType= MOD
[6]
Silver PartTime B (Metered)
DefaultConnType = MOD
Day= Monday
Period= 00:00-24:00
ConnType= MOD
Day= Tuesday
Period= 00:00-24:00.
ConnType= MOD
Day= Wednesday
Period= 00:00-24:00
ConnType= MOD
Day= Thursday
Period= 00:00-24:00
ConnType= MOD
Day= Friday
Period= 00:00-24:00.
ConnType= MOD
Day= Saturday
Period= 00:00-08:30, 08:30-12:30, 12:30-24:00
ConnType= MOD, MF, MOD
Day= Sunday
© 2006 Fujitsu Services Company in Confidence
Page 194
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Period= 00:00-24:00
ConnType= MOD
17]
;FRIACO Silver Daytime A
DefaultConnType = MOD
Day= Monday
Period= 00:00-01:00, 01:00-08:00, 08:00-17:30, 17:30-24:00
ConnType= MOD, FE, FF, MOD
Day= Tuesday
Period= 00:00-01:00, 01:00-08:00, 08:00-17:30, 17:30-24:00
ConnType= MOD, FE, FF, MOD
Day= Wednesday
Period= 00:00-01:00, 01:00-08:00, 08:00-17:30, 17:30-24:00
ConnType= MOD, FE, FF, MOD
Day= — Thursday
Period= 00:00-01:00, 01:00-08:00, 08:00-17:30, 17:30-24:00
ConnType= MOD, FE, FF, MOD
Day= Friday
Period= 00:00-01:00, 01:00-08:00, 08:00-17:30, 17:30-24:00
ConnType= MOD, FE, FF, MOD
Day= Saturday
Period= 00:00-01:00, 01:00-08:00, 08:00-13:00, 13:00-24:00
ConnType= MOD, FE, FF, MOD
Day= Sunday
Period= 00:00-01:00, 01:00-08:00, 08:00-24:00
ConnType= MOD, FE, MOD
[8]
:FRIACO Silver Daytime B
DefaultConnType = MOD
Day= Monday
Period= 00:00-01:00, 01:00-08:00, 08:00-17:30, 17:30-24:00
ConnType= MOD, FE, FF, MOD
Day= Tuesday
Period= 00:00-01:00, 01:00-08:00, 08:00-17:30, 17:30-24:00
ConnType= MOD, FE, FF, MOD
Day= Wednesday
Period= 00:00-01:00, 01:00-08:00, 08:00-17:30, 17:30-24:00
ConnType= MOD, FE, FF, MOD
Day= Thursday
Period= 00:00-01:00, 01:00-08:00, 08:00-17:30, 17:30-24:00
ConnType= MOD, FE, FF, MOD
Day= Friday
© 2006 Fujitsu Services Company in Confidence Page 195
Fujitsu
Services
CNIM Low Level Design
COMPANY IN CONFIDENCE
FUJ00171956
FUJ00171956
Ref: RS/LLD/004
Version: 4.0
Date: 8/05/2006
Period= 00:00-01:00,
ConnType= - MOD,
Day= Saturday
Period= 00:00-01:00,
ConnType= MOD,
Day= Sunday
Period= 00:00-01:00,
ConnType= - MOD,
19]
;Non FRIACO Silver Dayt
DefaultConnType = MOD
Day= Monday
Period= 00:00-08:00,
ConnType= MOD,
Day= Tuesday
Period= 00:00-08:00,
ConnType= MOD,
Day= Wednesday
Period= 00:00-08:00,
ConnType= MOD,
Day= Thursday
Period= 00:00-08:00,
ConnType= MOD,
Day= Friday
Period= 00:00-08:00,
ConnType= MOD,
Day= — Saturday
Period= 00:00-08:00,
ConnType= MOD,
Day= Sunday
Period= 00:00-24:00
ConnType= MOD
[10]
;FRIACO 24HR Cl
DefaultConnType = MF
Day= Monday
Period= 00:00-01:00,
ConnType= MF,
Day= Tuesday
Period= 00:00-01:00,
ConnType= MF,
01:00-08:00,
FE,
01:00-08:00,
FE,
01:00-08:00,
FE,
‘ime
08:00-17:30,
MF,
08:00-17:30,
MF,
08:00-17:30,
MF,
08:00-17:30,
MF,
08:00-17:30,
MF,
08:00-13:00,
MF,
01:00-17:30,
FF,
01:00-17:30,
FF,
08:00-17:30, 17:30-24:00
FF, MOD
08:00-13:00, 13:00-24:00
FF, MOD
08:00-24:00
MOD
17:30-24:00
MOD
17:30-24:00
MOD
17:30-24:00
MOD
17:30-24:00
MOD
17:30-24:00
MOD
13:00-24:00
MOD
17:30-24:00
MF
17:30-24:00
MF
© 2006 Fujitsu Services
Company in Confidence
Page 196
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Day= Wednesday
Period= 00:00-01:00, 01:00-17:30, _17:30-24:00
ConnType= MF, FF, MF
Day= Thursday
Period= 00:00-01:00, 01:00-17:30, 17:30-24:00
ConnType= MF, FF, MF
Day= Friday
Period= 00:00-01:00, 01:00-17:30, 17:30-24:00
ConnType= MF, FF, MF
Day= Saturday
Period= 00:00-01:00, 01:00-13:00, 13:00-24:00
ConnType= MF, FF, MF
Day= Sunday
Period= 00:00-01:00, 01:00-08:00, 08:00-24:00
ConnType= MF, FF, MF
en]
sFRIACO 24HR C2
DefaultConnType = MF
Day= Monday
Period= 00:00-01:00, 01:00-17:30, _17:30-24:00
ConnType= MF, FF, MF
Day= Tuesday
Period= 00:00-01:00, 01:00-17:30, 17:30-24:00
ConnType= MF, FF, MF
Day= Wednesday
Period= 00:00-01:00, 01:00-17:30, 17:30-24:00
ConnType= MF, FF, MF
Day= Thursday
Period= 00:00-01:00, 01:00-17:30, 17:30-24:00
ConnType= MF, FF, MF
Day= Friday
Period= 00:00-01:00, 01:00-17:30, 17:30-24:00
ConnType= MF, FF, MF
Day= _— Saturday
Period= 00:00-01:00, 01:00-13:00, 13:00-24:00
ConnType= MF, FF, MF
Day= Sunday
Period= 00:00-01:00, 01:00-08:00, 08:00-24:00
ConnType= MF, FF, MF
[12]
sNon FRIACO Silver 24HR
DefaultConnType = MF
© 2006 Fujitsu Services Company in Confidence Page 197
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Day= Monday
Period= 00:00-24:00
ConnType= MF
Day= Tuesday
Period= 00:00-24:00
ConnType= MF
Day= Wednesday
Period= 00:00-24:00
ConnType= MF
Day= Thursday
Period= 00:00-24:00
ConnType= MF
Day= Friday
Period= 00:00-24:00
ConnType= MF
Day= Saturday
Period= 00:00-24:00
ConnType= MF
Day= Sunday
Period= 00:00-24:00
ConnType= MF
(13)
;ADSL
Day= Monday
Period= 00:00-08:00, 08:00-17:30, 17:30-24:00
ConnType= AE, AF, AE
Day= Tuesday
Period= 00:00-08:00, 08:00-17:30, 17:30-24:00
ConnType= AE, AF, AE
Day= Wednesday
Period= 00:00-08:00, 08:00-17:30, 17:30-24:00
ConnType= AE, AF, AE
Day= Thursday
Period= 00:00-08:00, 08:00-17:30, 17:30-24:00
ConnType= AE, AF, AE
Day= Friday
Period= 00:00-08:00, 08:00-17:30, 17:30-24:00
ConnType= AE, AF, AE
© 2006 Fujitsu Services Company in Confidence Page 198
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Day= Saturday
Period= 00:00-08:00, 08:00-13:00, 13:00-24:00
ConnType= AE, AF, AE
Day= Sunday
Period= 00:00-24:00
ConnType= AE
© 2006 Fujitsu Services Company in Confidence Page 199
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Appendix A2. CALL PLAN - CNIM 4 - S92 FOR BNR
The Call Plan for CNIM is as above with the exceptions of table13 which has new
connection type names and a new table 14 for ADSL with ISDN automatic backup.
;CNIM Call Plan
;PC=Permanent Connection
;MOD=Metered on Demand
;VOD=Voice on Demand
i ‘Metered Fixed
;FE=FRIACO Establish
;FF=FRIACO Fixed
[2]
;Satellite
DefaultConnType = PC
Day= Monday
Period= 00:00-24:00
ConnType= PC
Day= Tuesday
Period= 00:00-24:00
ConnType= PC
Day= Wednesday
Period= 00:00-24:00
ConnType= PC
Day= Thursday
Period= 00:00-24:00
ConnType= PC
Day= Friday
Period= 00:00-24:00
ConnType= PC
Day= Saturday
Period= 00:00-24:00
ConnType= PC
Day= Sunday
Period= 00:00-24:00
ConnType= PC
© 2006 Fujitsu Services
Company in Confidence
Page 200
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
[3]
;Frame Relay
Day= Monday
Period= 00:00-08:00, 08:00-17:30, 17:30-24:00
ConnType= FRE, FRF, FRE
Day= Tuesday
00:00-08:00, 08:00-17:30, 17:30-24:00
ConnType= FRE, FRF, FRE
Day= Wednesday
Period= 00:00-08:00, 08:00-17:30, 17:30-24:00
ConnType= FRE, FRF, FRE
Day= Thursday
Period= 00:00-08:00, 08:00-17:30, 17:30-24:00
ConnType= FRE, FRF, FRE
Day= Friday
Period= 00:00-08:00, 08:00-17:30, 17:30-24:00
ConnType= FRE, FRF, FRE
Day= Saturday
Period= 00:00-08:00, 08:00-13:00, 13:00-24:00
ConnType= FRE, FRF, FRE
Day= Sunday
Period= 00:00-24:00
ConnType= FRE
(1]
Voice
DefaultConnType = VOD
Day= Monday
Period= 00:00-08:00, 08:00-20:30, 20:30-24:00
ConnType= VOD, VODG, VOD
Day= Tuesday
Period= 00:00-08:00, 08:00-20:30, 20:30-24:00
ConnType= VoD, VODG, VOD
© 2006 Fujitsu Services
Company in Confidence
Page 201
Fujitsu
Services
CNIM Low Level Design
COMPANY IN CONFIDENCE
FUJ00171956
FUJ00171956
Ref: RS/LLD/004
Version: 4.0
Date: 8/05/2006
Day= Wednesday
Period= 00:00-08:00,
ConnType= VOD,
Day= Thursday
Period= 00:00-08:00,
ConnType= VOD,
Day= Friday
Period= 00:00-08:00,
ConnType= VOD,
Day= Saturday
Period= 00:00-08:00,
ConnType= VoD,
Day= Sunday
Period= 00:00-24:00
ConnType= VoD
(4)
;Bronze
DefaultConnType = MOD
Day= Monday
Period= 00:00-08:00,
ConnType= MOD,
Day= Tuesday
Period= 00:00-08:00,
ConnType= = MOD,
Day= Wednesday
Period= 00:00-08:00,
ConnType= MOD,
Day= Thursday
Period= 00:00-08:00,
ConnType= = MOD,
Day= Friday
Period= 00:00-08:00,
ConnType= MOD,
Day=__ Saturday
08:00-20:30, 20:30-24:00
VODG, VOD
08:00-20:30, 20:30-24:00
VODG, VoD
08:00-20:30, 20:30-24:00
VODG, VoD
08:00-20:30, 20:30-24:00
VODG, VoD
08:00-20:30, 20:30-24:00
MODG, MOD
08:00-20:30, 20:30-24:00
MODG, MOD
08:00-20:30, 20:30-24:00
MODG, MOD
08:00-20:30, 20:30-24:00
MODG, MOD
08:00-20:30, 20:30-24:00
MODG, MOD
© 2006 Fujitsu Services
Company in Confidence
Page 202
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Period= 00:00-08:00, 08:00-20:30, 20:30-24:00
ConnType= MOD, MODG, MOD
Day= Sunday
Period= 00:00-24:00
ConnType= MOD
(5]
;Silver PartTime A (Metered)
DefaultConnType = MOD
Day= Monday
Period= 00:00-08:00, 08:00-08:30 08:30-10:30, 10:30-20:30, — 20:30-24:00
ConnType= MOD, MODG, MFG, MODG, MOD
Day= Tuesday
Period= 00:00-08:00, 08:00-08:30 08:30-09:30, 09:30-20:30, 20:30-24:00
ConnType= MOD, MODG, MFG, MODG, MOD
Day= Wednesday
Period= 00:00-08:00, 08:00-20:30, 20:30-24:00
ConnType= MOD, MODG, MOD
Day= Thursday
Period= 00:00-08:00, 08:00-08:30 08:30-09:30, 09:30-20:30, — 20:30-24:00
ConnType= MOD, MODG, MFG, MODG, MOD
Day= Friday
Period= 00:00-08:00, 08:00-20:30, 20:30-24:00
ConnType= MOD, MODG, MOD
Day= Saturday
Period= 00:00-08:00, 08:00-20:30, 20:30-24:00
ConnType= MOD, MODG, MOD
Day= Sunday
Period= 00:00-24:00
ConnType= MOD
(6]
;Silver PartTime B (Metered)
DefaultConnType = MOD
Day= Monday
Period= 00:00-08:00, _08:00-20:30, _20:30-24:00
© 2006 Fujitsu Services Company in Confidence
Page 203
Fujitsu
Services
CNIM Low Level Design
COMPANY IN CONFIDENCE
FUJ00171956
FUJ00171956
Ref: RS/LLD/004
Version: 4.0
Date: 8/05/2006
ConnType= MOD,
Day= Tuesday
Period= 00:00-08:00,
ConnType= = MOD,
Day= Wednesday
Period= 00:00-08:00,
ConnType= MOD,
Day= Thursday
Period= 00:00-08:00,
ConnType= MOD,
Day= Friday
Period= 00:00-08:00,
ConnType= MOD,
Day= Saturday
Period= 00:00-08:00,
ConnType= MOD,
Day= Sunday
Period= 00:00-24:00
ConnType= MOD
(7]
;FRIACO Silver Daytime A
DefaultConnType = MOD
Day= Monday
Period= 00:00-01:00,
ConnType= MOD,
Day= Tuesday
Period= 00:00-01:00,
ConnType= MOD,
Day= Wednesday
Period= 00:00-01:00,
ConnType= = MOD,
Day= Thursday
Period= 00:00-01:00,
ConnType=. MOD.
MODG,
08:00-20:30,
MODG,
08:00-20:30,
MODG,
08:00-20:30,
MODG,
08:00-20:30,
MODG,
08:00-08:30
MODG,
01:00-08:00,
FE,
01:00-08:00,
FE,
01:00-08:00,
FE,
01:00-08:00,
FE,
MOD
20:30-24:00
MOD
20:30-24:00
MOD
20:30-24:00
MOD
20:30-24:00
MOD
08:30-12:30,
MFG,
08:00-17:30,
FFG,
08:00-17:30,
FFG,
08:00-17:30,
FFG,
08:00-17:30,
FEG
12:30-20:30,
MODG,
17:30-20:30,
MODG,
17:30-20:30,
MODG,
17:30-20:30,
MODG,
17:30-20:30,
MODG.
20:30-24:00
MOD
20:30-24:00
MOD
20:30-24:00
MOD
20:30-24:00
MOD
20:30-24:00
MOD
© 2006 Fujitsu Services
Company in Confidence
Page 204
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Day= Friday
Period= 00:00-01:00, 01:00-08:00, 08:00-17:30, 17:30-20:30, — 20:30-24:00
ConnType= MOD, FE, FFG, MODG, MOD
Day= Saturday
Period= 00:00-01:00, 01:00-08:00, 08:00-13:00, 13:00-20:30, — 20:30-24:00
ConnType= MOD, FE, FFG, MODG, MOD
Day= Sunday
Period= 00:00-01:00, 01:00-08:00, 08:00-24:00
ConnType= MOD, FE, MOD
[8]
;FRIACO Silver Daytime B
DefaultConnType = MOD
Day= Monday
Period= 00:00-01:00, 01:00-08:00, 08:00-17:30, 17:30-20:30, 20:30-24:00
ConnType= MOD, FE, FFG, MODG, MOD
Day= Tuesday
Period= 00:00-01:00, 01:00-08:00, 08:00-17:30, 17:30-20:30, — 20:30-24:00
ConnType= MOD, FE, FFG, MODG, MOD
Day= Wednesday
00:00-01:00, 01:00-08:00, 08:00-17:30, 17:30-20:30, 20:30-24:00
ConnType= MOD, FE, FFG, MODG, MOD
Day= Thursday
Period= 00:00-01:00, 01:00-08:00, 08:00-17:30, 17:30-20:30, — 20:30-24:00
ConnType= MOD, FE, FFG, MODG, MOD
Day= Friday
Period= 00:00-01:00, 01:00-08:00, 08:00-17:30, 17:30-20:30, — 20:30-24:00
ConnType= MOD, FE, FFG, MODG, MOD
Day= Saturday
Period= 00:00-01:00, 01:00-08:00, 08:00-13:00, — 13:00-20:30, — 20:30-24:00
ConnType= MOD, FE, FFG, MODG, MOD
Day= Sunday
Period= 00:00-01:00, 01:00-08:00, 08:00-24:00
ConnType= MOD, FE, MOD
© 2006 Fujitsu Services
Company in Confidence
Page 205
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
[9]
;Non FRIACO Silver Daytime
DefaultConnType = MOD
Day= Monday
Period= 00:00-08:00, 08:00-17:30, I 17:30-20:30, 20:30-24:00
ConnType= MOD, MFG, MODG, MOD
Day= Tuesday
Period= 00:00-08:00, 08:00-17:30, 17:30-20:30, 20:30-24:00
ConnType= MOD, MFG, MODG, MOD
Day= Wednesday
Period= 00:00-08:00, 08:00-17:30, 17:30-20:30, 20:30-24:00
ConnType= MOD, MFG, MODG, MOD
Day= Thursday
Period= 00:00-08:00, 08:00-17:30, 17:30-20:30, 20:30-24:00
ConnType= MOD, MFG, MODG, MOD
Day= Friday
Period= 00:00-08:00, 08:00-17:30, 17:30-20:30, 20:30-24:00
ConnType= MOD, MFG, MODG, MOD
Day= Saturday
Period= 00:00-08:00, 08:00-13:00, 13:00-20:30, 20:30-24:00
ConnType= MOD, MFG, MODG, MOD
Day= Sunday
Period= 00:00-24:00
ConnType= MOD
[10]
;FRIACO 24HR C1
DefaultConnType = MF
Day= Monday
Period= 00:00-01:00, 01:00-08:00, 08:00-17:30, 17:30-20:30, — 20:30-24:00
ConnType= MF, FF, FFG, MFG, MF
Day= Tuesday
Period= 00:00-01:00, 01:00-08:00, 08:00-17:30, 17:30-20:30, — 20:30-24:00
ConnType= MF, FF, FFG, MFG, MF
© 2006 Fujitsu Services
Company in Confidence
Page 206
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Day= Wednesday
Period= 00:00-01:00, 01:00-08:00, 08:00-17:30, 17:30-20:30, — 20:30-24:00
ConnType= MF, FF, FFG, MFG, MF
Day= Thursday
Period= 00:00-01:00, 01:00-08:00, 08:00-17:30, — 17:30-20:30, — 20:30-24:00
ConnType= MF, FF, FFG, MFG, MF
Day= Friday
Period= 00:00-01:00, 01:00-08:00, 08:00-17:30, 17:30-20:30, 20:30-24:00
ConnType= MF, FF, FFG, MFG, MF
Day= Saturday
Period= 00:00-01:00, 01:00-08:00, 08:00-13:00, 13:00-20:30, — 20:30-24:00
ConnType= MF, FF, FFG, MFG, MF
Day= Sunday
Period= 00:00-01:00, 01:00-08:00, 08:00-24:00
ConnType= MF, FF, MF
(11]
;FRIACO 24HR C2
DefaultConnType = MF
Day= Monday
Period= 00:00-01:00, 01:00-08:00, 08:00-17:30, 17:30-20:30, — 20:30-24:00
ConnType= MF, FF, FFG, MFG, MF
Day= Tuesday
Period= 00:00-01:00, 01:00-08:00, 08:00-17:30, 17:30-20:30, 20:30-24:00
ConnType= MF, FF, FFG, MFG, MF
Day= Wednesday
Period= 00:00-01:00, 01:00-08:00, 08:00-17:30, 17:30-20:30, — 20:30-24:00
ConnType= MF, FF, FFG, MFG, MF
Day= Thursday
Period= 00:00-01:00, 01:00-08:00, 08:00-17:30, 17:30-20:30, 20:30-24:00
ConnType= MF, FF, FFG, MFG, MF
Day= Friday
Period= 00:00-01:00, 01:00-08:00, 08:00-17:30, 17:30-20:30, — 20:30-24:00
ConnType= MF, FF, FFG, MFG, MF
Day=__ Saturday
© 2006 Fujitsu Services
Company in Confidence
Page 207
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Period= 00:00-01:00, 01:00-08:00, 08:00-13:00, 13:00-20:30, 20:30-24:00
ConnType= MF, FF, FFG, MFG, MF
Day= Sunday
Period= 00:00-01:00, 01:00-08:00, 08:00-24:00
ConnType= MF, FF, MF
[12]
;Non FRIACO Silver 24HR
DefaultConnType = MF
Day= Monday
Period= 00:00-08:00, 08:00-20:30, 20:30-24:00
ConnType= MF, MFG, MF
Day= Tuesday
Period= 00:00-08:00, 08:00-20:30, 20:30-24:00
ConnType= MF, MFG, MF
Day= Wednesday
Period= 00:00-08:00, 08:00-20:30, 20:30-24:00
ConnType= MF, MFG, MF
Day= Thursday
Period= 00:00-08:00, 08:00-20:30, 20:30-24:00
ConnType= MF, MFG, MF
Day= Friday
Period= 00:00-08:00, 08:00-20:30, 20:30-24:00
ConnType= MF, MFG, MF
Day= Saturday
Period= 00:00-08:00, 08:00-20:30, 20:30-24:00
ConnType= MF, MFG, MF
Day= Sunday
Period= 00:00-24:00
ConnType= MF
[13]
;ADSL
Day= Monday
Period= 00:00-08:00, 08:00-20:30, 20:30-24:00
ConnType=. RA, RAG. RA
© 2006 Fujitsu Services
Company in Confidence
Page 208
Fujitsu
Services
CNIM Low Level Design
COMPANY IN CONFIDENCE
FUJ00171956
FUJ00171956
Ref: RS/LLD/004
Version: 4.0
Date: 8/05/2006
Day= Tuesday
Period= 00:00-08:00,
ConnType= RA,
Day= Wednesday
Period= 00:00-08:00,
ConnType= RA,
Day= Thursday
Period= 00:00-08:00,
ConnType= RA,
Day= Friday
Period= 00:00-08:00,
ConnType= — RA,
Day= Saturday
Period= 00:00-08:00,
ConnType= _— RA,
Day= Sunday
Period= 00:00-24:00
ConnType= RA
[14]
08:00-20:30,
RAG,
08:00-20:30,
RAG,
08:00-20:30,
RAG,
08:00-20:30,
RAG,
08:00-20:30,
RAG,
;RAS = ADSL with ISDN backup
Day= Monday
Period= 00:00-08:00,
ConnType= — RA,
Day= Tuesday
Period= 00:00-08:00,
ConnType= RA,
Day= Wednesday
Period= 00:00-08:00,
ConnType= _— RA,
Day= Thursday
Period= 00:00-08:00,
ConnType= RA,
Day= Frida
08:00-20:30,
RAIG,
08:00-20:30,
RAIG,
08:00-21:00,
RAIG,
08:00-20:30,
RAIG,
20:30-24:00
RA
20:30-24:00
RA
20:30-24:00
RA
20:30-24:00
RA
20:30-24:00
RA
20:30-24:00
RA
20:30-24:00
RA
21:00-21:05,
RIT,
20:30-24:00
RA
21:05-24:00
RA
© 2006 Fujitsu Services
Company in Confidence
Page 209
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Period= 00:00-08:00, 08:00-20:30, 20:30-24:00
ConnType= RA,
Day= Saturday
Period= 00:00-08:00,
ConnType= _— RA,
Day= Sunday
Period= 00:00-24:00
ConnType= RA
RA
08:00-20:30, 20:30-24:00
RA
© 2006 Fujitsu Services
Company in Confidence
Page 210
Fujitsu Services
CNIM Low Level Design
COMPANY IN CONFIDENCE
FUJ00171956
FUJ00171956
Ref: RS/LLD/004
Version: 4.0
Date: 8/05/2006
Appendix A3.
Symbol
INITIAL ERROR
EVENT LOG MESSAGES
‘oor
RROR_GENERAL
General Ervorin CNIMP wana
ERROR EXCEPTION
[Exception Error in CNINPam anal
ERROR NULL POINTER
Aitempting to use a Null pontersar anval
FRROR EXTERNAL FN
3” frorin another function amend
FRROR PING FATED
© fron Ping leavened
EVMSG_COPYRIGHT 300 Ponval (a2) ParonFile Version 803 a enCopyright 2002 Fujin Senices Lid T
EVMSG_CNIM SERVICE CREATED 301 ence created T
EVMSG_CNIM SERVICE STOPPED 302 Bence sopped T
EVNSG_CNIM SERVICE REMOVED 303, Renee removed T
EVMISG_CNIM_SERVICE_RUNNING Tor Renee running T
IEVMSG_CNIM SERVICE STOPPING 305, ence stopping T
EVMSG_CNIM_ERROR_WINSD 308 Pal E
IEVMSG_CNIM STATE CHANGED 307 enice sate changed T
WMSG_NO_ERROR 308 fOtimaco ~ No Eror T
WMSG_USWERR_FILE_NOT_FOUND 309 [Otimaco -Filenot found E
IEVMSG_USWERR ITEM ALREADY EXISTS 310) fotimaco ~ Trem already exisis in policy le T
IEVMSG_USWERR FIO TIT fotimaco-File10 enor detected E
IEVMSG_USWERR_INVALID_CFG FILE 312 fotimaco -Tavalid Poly File E
[evais@ USWERR INSUFFICIENT PRIV 315 felimaco - You curently donot have the rights o execute the requested action, Usually @ r
password bas to be presented in advance
IEVMSG_USWERR_NOP
31 fotimaco - No operation done
IEVMSG_USWERR NOK
TIS [Uiimaco - Function not executed
IEVMSG_USWERR FWRUG
316 foTimaco =
al enor detected
WASG_USWERR_INIT
Timaco ~ Module not inialized
WMSG_USWERR_ALLOC
318 [ltimaco Message: Cannot allocate memory
IEVMSG_USWERR READ FIO
319) folimaco Mewage: Fil TO read enor
IEVMSG_USWERR_WRITE_FIO
a0 [ltimaco Message Fi TO wate enor
[VMISG_USWERR SESSION FRR
TOT [liimaco Mesage: General enor
EVMSG_ACCESS_ERR
322, [ltimaco Message: Access not allowed
IEVMSG_USWERR_OPEN FAILURE
325, fltimaco Message: An open command was not successful
IEVMSG_USWERR_NOT_ENOUGH MEMORY
32 [Otimaco Mewage: Not enough memory
EVMSG_USWERR IPC FAULT
325 Ilimaco Message: General failure of fntexprocess communication
[VMSG_USWERR_WAIT_AND_RETRY
326 JOtimaco Message The service currently does not take calls,
IEVMSG_USWERR_COMMUNICATE
327 [llimaco Mewage: General communication fale
SVMSG_USWERR_UNEXPECTED_RFT_VALUE
328 [Utimaco Message: Unexpected retum value
WMSG_USWERR_NO_CARDREADER
329 _[Utimaco Message: No card reader attached
IEVMSG_USWERR BUFFER OVERFLOW
Diimaco Message: Buller overlow
IEVMSG_USWERR_CARD_NOT POWERED
TST_fltimaco Message: Cards not powered
EVMSG_USWERR TIMEOUT
332 folimaco Mewage- A imeout has occured
SVMSG_USWERR_ILLEGAL_CARDIVPE
353 fltimaco Mewage Megal card type
IEVMSG_USWERR_NOT_ SUPPORTED
351 fllimaco Message: The requested functionality snot supported a this ime
sof res] ef raf af rf eof arf ae] rf eal em] raf ef ee] ef af ee] rel af
cleted
VMSG_USWERR_LEGAT_DRIVER 335 fltimaco Message: Mega diver
'VMSG_USWERR_ILLEGAL_FW_RELEASE 336 fUtimaco Message: The connected hardware whose fimawareis not useable by this soft E
IEVMSG_USWERR_OPEN FILE 337 Iltimaco Messaae: Fi opening filed E
IEVMSG_USWERR_CARD_NOT_INSERTED 338, IOtimaco Messaae: Card not inserted E
[EVNISG_USWERR_ILLEGAL_ARGUMENT 359, Iltimaco Message: Mega argument E
VMSG_USWERR_SEM_USED 340 Jltimaco Message: The semaphore cumently muse E
VMISG_USWERR_NO_DRIVER TAT [Otimaco Message: No device driver installed E
[EVNISG_USWERR_GENERAL_PATLURE 342 IOtimaco Message: General aus E
EVNSG_USWERR_OUT_OF SERVICE SAB JOtimaco Message: The service curently not avaiable E
EVNISG_USWERR_ITEN_NOT_FOUND SH Iltimaco Message: An em (ea a Key ofa specifi name) could not be found T
VMSG_USWERR_PW_WRONG 345 [Utimaco Message The presented password is wrong E
[ao [Diimaco Messaue: The password has been presented several times wione and fs therefore
FuMSc_USWERR_PW_LOCKED 6 Hocked. Usually use some administrator tool to unblock it F
IEVMSG_USWERR_IDENTITY_MISMATCH 347 ltimaco Message: The entity does not match a defined rosvaheck Menty E
itimaco Message: Multiple enors have occured, Use this if there is only the possibilty wo retum
IEVMSG_USWERR_MULTIPLE_ERRORS 348 fone enor code, bu thete happened different erors before (eg. each thread retuned a different I E
[vaso USWERR TEMS LEFT Tap [Ptimaco Message: There are stl tems eR, therefore ea. the directory stmcture ete cantbe Ip
© 2006 Fujitsu Services
Company in Confidence
Page: 211
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
FUNG USWERR_CONSISTINGY GHEE 350 Poimaco Mesage Ener dng comsteny chook =
'YMSG_USWERR_ON BLACKLIST 351 fitimaco Message: The IDs ona blacks, the requested actin is therefore not allowed E
JEVNSG_USWERR INVALID HANDLE Fy =
JEVRISG_USWERR SECTION NOT_FOUND 355 JUtmaco Messape: Seaton not ound i
TVNSG_USWERR_ENTRY NOT FOUND 354 [taco Message Eatrynt und 7
VAISG_USWERR_NO_MORE_SECTIONS 355 [Utinaco Message No mow scons 7
fEVaISG_USWERR_EO_REACIED. 356 fltmaco Message End of ie ached 7
VAISG_USWERRPW_T00 SHORT 357 JOtmaco Message The ng of te password was 00 show E
VNSG_USWERR FW T00 LONG S58 fUtimaco Message The Ing ofthe password was too ong E
[EVISG_USWERR ITEM EXPIRED. 359) fUtmaco Message: Some em (a cries) has expired =
TVMSG_UNKNOWN_UTINACO_ERROR 3a [aco Message: Unknown ror E
[EVNSG_USWERR_SGVPN_DRIVER NOP TOI [Otmaco Message No operations done TP er 7
JEVNSG_USWERR_SGVPNNO_VALID_VET 362 JUtmaco Message: Cerieate snot vald yet E
JEvniSo_USWERR FARM 365 fUtmaco Message The To prance conained an Mga vale E
VNSG_USWERR_PARNE TG [Oimaco Message The Sad panmcter contained an Heal vie E
JEvNISG_USWERR_PARNG 365 fUimaco Message The 3d parameter covtaied an Hepa value E
[EVNISG_USWERR_PARNTT 366 [mace Message: The Wh parce conned an Meal abe =
FUNG _USWERR PARNS 367 [Uimnaco Message: The Sth parameter contained an Hep vabe =
JEVNSG_USWERR FARMS 36 [Utmaco Message The Gh parameter contained an egal vahe =
VASG_USWERRPARMT 36 [Unaco Message: The Th panel contained an Hepal vabe E
VNSG_USWERR_NOMATCH 370 [Oinaco code pot eonised E
EVNSG_FUNCTION ENTERED TTT Pnton enero 7
JEvnSG_ FUNCTION LEAVING 372 Pancion iho 7
[EVRISG_SGVPN FAILURE 3 RGVPN FaresaParol E
JEvaISG-ERROR FILE 371 Pecan Gave te oe Pa =
VASG_DEBUG_RONNING 375 [ENIN runing a debug mode 7
[EVNISG_WINSOCK ERROR 376 ror lin Winsock Fancton 99a E
136 EXITING eo 7
[EVSG_ERRORINTTIALSE PORT NONTOR 378 Cannot nlalie port monior E
FYNso_DEnUG TI esage Text 7
JEVRISG_ SERVICE PAUSED 320. Revie paused 7
EVRISG_SERVICE RUNNING 31 Revie ning i
JEVNISG_ERROR CANNOT GET REGISTRY. CHANGES 382 [or cannot ge Ty changes E
JEVISG_ERROR CREATE EVENT Ta Eor seating eve Por Er E
EVNSG-ERROR IN CALL REVERSAL a1 foaled has fled =
VNSG_ERROR IN PING_TNEOUT 385 Pinger has te ot =
TVNSG_FRROR_ MESSAGE 336 pal E
[EVSG_ERROR UNABLE KEEP-UNE CLEAR 387 Pnablevo keep the ne car 5
TVNSG_INFO_RPC_THREAD_SIGNALLED 3 [Tbe RPC ead signal caught by CRIM 7
TVNISG_INFO_KEEP_ALIVE_THREAD SIGNALLED 59) [The Resp Ave tread sal cau by CNT 7
JEvaISG_INFO LOGGER_THREAD SIGNALLED 50 fie Logger tread signal caught by CNM 7
JEVRISG_INFO PORT _MON_TTIREAD SIGNALLED SOT fie Fort Mono ead seal cought by CRIT T
JEVRISG_INFO-CALLMON_TIREAD SIGNALLED SOE fie Call Monitor tread signal caught by CNM T
TYNSG_INFO_EXCTHREAD_SIGNALLED 305 fie Eicon Manager tread sal cau by CNIMT 7
{VMSG_CNIM_ERROR FILE_NOT_OPENED SHI ies lan sould not be opaned: The cause MPaPaPCD E
kEvniSG_ERROR INCORRECT DOW STRING SBS fie sung Vol faPan is nota vald dy ofthe weak, Check STF Fz =
JEVISG_ERROR ELEMENT NOT-INTTALISED 396 fEor An element has pt been aise =
JFVNISG_ERROR CONDITA MISMATCIT 37 Ear Thelin 9a Toaran has a Tere marberO eas Rom Te E
FEVRISG_ERROR INCORRECT CONTYPE STRING 398 fb tng! 91 FaPen nota valid conection type. Check STF Fe E
[FVAISG_ERROR_INCORRECT FERIOD_STRING 500) [The ag PT an not aval pod Check STF Fe =
SVNSG_FRROR_TABIE_NOT FOUND TO able Fa has not Deen Found E
FVASG_ERROR_DAY NOT FOUND TOT [Day Po has ot Dee found ne 7 E
[EVRISG_ERROR ELEMENT NOT FOUND. OX [Eement not ound Torte: aT =
TVNSG ERROR NULL PONTER TOR ror Nall Power E
TVMISG_ERROR_CANNOT- CREATE EM THREAD. TOT ant creat Econ anager tread Err E
TVMSG_ERROR_CANNOT-CREATE-CALLMON THREAD: TOS Cannot reat Call Monitored Ear a E
JFVASG_FRROR CANNOT CREATE CALLREV THREAD 106 Frannot create Call Reveal ead Evora =
JEVRSG_ERROR CANNOT CREATE PINGER THREAD 107 [lan create pager tnead Error 91 5
SVNISG_FRROR_CANNOT-CREATERPCTHREAD TOs Cannot seats RPC Tread Fron E
© 2006 Fujitsu Services
Company in Confidence
Page 212
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
'VMSG_ERROR CANNOT. CREATE PORT. MONITOR THREAD] 409 [eannot rate pon monitor tea: Er a
VNSG-ERROR IN DATE IN THENANE THO fie date samp cons an val eny3aPaP aT E
[EVISG_INFO_RENANING FILE THT Renaming Hea Pc saaraPaPeaD T
JEVNISG_ERROR_CANNOT_SET_PROPS_FRON NAME TT” annot et og ie properties Hom ame PPT E
JEVNISG_ERROR_CANNOT CREATE CALLMANAGER THREAD I 413 [annot cate the Call Manager thread E
[EVRISG_INFO-CALL_ MANAGER THREAD SIGNALLED TT ie Call Manager tad imal ugh by CNA 7
[vasa ERROR CAUSE CODE 1s [RE ese A eave SIRT he OT v
JEVNISG_ERROR INVALID IP_ADDRESS Ts fad Areva 5
JEVNISG_ERROR CANNOT CREATE, KA THREAD TH7 anne create Resp Alive thnead: Ere E
[FVNISG_ERROR_CANNOT CREATE LOGGER TREAD TTR annotate Logger teal Ear a1 E
ENIN_GS_TIMEDOUT_DO NOT USE SE 7
CNIN_GS_LINE_EVENT a0 et Seat ora ne vet T
NIN GS SERVICE STOP THT foetus goa op event 7
JEVISG_INFO_RPC MANAGER INTTALISED. TH RPC Manager Intalio 7
[EVNSG_INTO CALL MANAGER INITIALISED 12S Fall Manager inane 7
[EVISG_INTO-TICON MANAGER INITTALISED 726 icon ManaperTnialsed i
VNSG_INFO_MESSAGE 7 fl 7
SVMSG_ERROR_CANNOT_UPDATE_REGITRY THR anor pate ay E
[EVIISG_INFO_FICON INDEX 9 fcon index sett 7
JEVRISG_ERROR_CANNOT_CREATE_CALTNREAD 130 Feannot create Cal Manager ead E
VAIS FRROR CANNOT CREATE CM TESTER THREAD TET Frannot create Call Manager Tester ead =
[EVISG_INFO-TESTER THREAD SIGNALLED THE fie Tester vad anal caught by CRIME 7
[EVNSG_ERRORTESTING CURRENT UNDER TE Er etng cent momar E
JEVISG-ERROR LAYERT FAIL THY feayer dow E
TVNSG_ERROR_UNABLE_RABELAVER TBS Publ torake Layer wih Keep Ae =
VNISG_ERROR-BI_AT IDLE UNDER TEST TBO BT Remained ie dag est =
FVNISG_ERROR NUMBERS DIFFER TB Remote Adres dies fom Cured Nano =
JEVRISG_WARNING FRIACO_AT_DIALAROUND THE PRIACO i at Dal Around W
VNC ERROR INVALID NOMBER "Bo" [fhe following numbers val aPaPaT E
TVNSG_ERROR_ALL_ NUMBERS INVALID TOA Eicon clephone mbes areal E
TVNISG_WARNING_FAIL_MODE_TENP TAT are mods sto Temporary, Cause Cade Yo, Decipion 9 E
TVMSG_WARNING_FAIL_MODE_PERM THE are dsr to Permanent, Cause Code 01, Descon: 9 E
JEVNSG_WARNING FAIL NODE NONE Ti Pras modes stto None 7
JEViISG_WARNING FAIL_MODE UNKNOWN TAT Fare modes sett unknown, Cause Cole 7a, Depo T
JEVIISG_WARNING FAIL_ MODE LOsT_CONNECTION TES Fre ode esto Last Connection, Case Code 9, DeScpion oP E
JEVIISG_WARNING FAIL_MODE_FAILED_ONCE TS are odes oto Falled Once, Cause Code: SI, Desens E
JEVIISG_ERROR_CANNOT CREATE. KEEP-ALIVE THREAD I 447 [aot create Keep Alve teal Bor a E
JEVNISG_WARNING IDL MODULE_NOTINTIALISED. Tae PDT Nose Not itaised 7
VNISG_WARNING IDL MODULE INTTALISED Ty PDI Node Tatalsed T
[EVNISG_WARNING DIAPLMODULE_INTTALISED 150 PIAP Mode Tal 7
kEVRISG_WARNING_DIAPL_MODULE NOT INITIALSED. TT DIAPI Module Nor aloe 7
JEVIISG_ERRORNO_CALLPLAN 52 Ro Cal Pan He Tound =
JEVRISG_ERKOR READING CALLPLAN TEE for eadng Cal Pan E
TVNSG_INFO_NO_INP-TEST PASSED 5 [The aplenenation Tet has pot yl been passed 7
VNSC_INFO_INP-TEST PASSED Es Ld 7
JEVNSG_INTO TEST FAILED 756 fie Implementation Tet has been Faled E
JEVNSG_INTO_USING ISDN 157 Pane ISDN Names i
JEVISG_INFO_LINE_ CONNECTED IN DURING TEST TER [Te est ime out because ts Hine was Comneted a W
TVNSG_INFO_STARTING INP-TEST 155, arin Implementation Tet 7
[EVSG_INFO_APPLYING NONDER Tapping ol To Hison Cad, 9, Type 7
[EVNSG_INFO_WAMTING FOR LINEIDLE s i
[VNSG_INFO_LINE_DID_NOT_GO_IDLE AFTER X SECS Ta Pie did wot go Te afer ol seconds 7
EVNISG_INFO_NONBERNOT-TESTED 165 onber ol Not Teed 7
JEVRISG_INFO PINGING VPN SERVERS 761 Phang VPN Severs 7
EVNSG-INTO-PING REPLIED TGS fhe Png Roped 7
JEVRISG_INFO_PING_DID_NOT_REPLY Toe fie Png Dd No Rep 7
VNISG_INFO_NONDER PASSED ToT Raber St Passed 7
© 2006 Fujitsu Services
Company in Confidence
Page 213
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
FXNSG INFO NOMBER FAILED. Tae ber Fed i
[EVNISG_INFO-TEST ABANDONED os 7
YNSG_INFO_LNE IS IDLE Tid fine le 7
SVMSG_INFO_CHECKING RFC SERVICE STARTED THT iehing That RPC Service Has Sao 7
[EVNISG_INFO_RPC_SERVICE_HAS STARTED. TE RPC Sense Fis Sate 7
[EVNSG_INFO_NOMBER_TINED_OUT Tamer Sa Timed Or i
JFVNISG_INFO_CHECKING VPN SERVICE STARTED TT [ohecing Tha VPN Senco Ts Seated 7
[FVNISG_INFO_VPN SERVICE TIAS STARTED TS PRN Seve Tas Sate 7
FVNISG_ERRORTAVERILOK a 7
[EVNISG_INFO_SECONDS_TILL_END_OF-PERIOD 777 Fal Pan Period Wi End Tro Seconds 7
JEVAISG_INFO_PERM FAILURE SECONDS TTR Fare Mode Wil Be Set To Pranent In 91 Seconds 7
VRSG_INFOTESTTINER LENGHT T79-[reatng a Test Timer OF Fol Seconds 7
VNSG_INFO-RALUP Ta Reep Ane Up 7
[FVNSG_INFO_RA_DOWN Tar Resp Anes Dow 7
[EVNISG_ERROR_CANNOTCREATETACTTIREAD TEE Fant create Timer anaper tread Ear) =
VNSG_WARNING INVALID CACDATA TEE Warning: Tova Data From Connection Manager aT 7
TVMSG_WARNING_ADSI_ERROR_CODE TET [ADS Disconnection Code oT uP aDesepion 9D W
SVMSG_WARNING_NO_CMLRESPONSE TRS oanecton Manager did not espond io reset event 7
JFVNISG_WARNING_NETTVPE_ADSI TR” Nenwork connection changing to ADST 7
UNSG_WARNING NET TIPE SDN TET PRenwork connection changing To SDN 7
FXNSG_WARNING NET TVPE GM THR” PRenwork connection chaning fo GSM W
[EVNISG_WARNING_NELTVPE_NDIS TH Nenwork connection shanang to NDIS W
[EVNISG_INFO_NET_CHANGE SUCCESS Toa ework changed fom alto aT 7
[EVNISG_ERROR-NET_CHANGE FAIL THT Network Ted to ange om Solo Da =
JEVNISG_INFO_BACKUP-TEST THE Packap Tee 1 pings phe out oT 9: Perea 7
JFVNISG_INFO_PERM_FAILURE_CANCELLED 55 Permanent Fare Timer Canceled 7
[EVNISG_WARNING_NETTVPE_IDLE To Network connection changing toTDLE W
© 2006 Fujitsu Services
Company in Confidence
Page 214
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
CAUSE CODE DESCRIPTIONS
Cause ICause ICNIM Value
Code = ICode Description
(Dec) IHex
128 80 [00000080 0x80" Normal Disconnect”
129 si [00000081 ‘Ox81 "Unassigned (Unallocated number)”
130) 82 [00000082 ‘0x82 "No route to specified transit network”
131 83 [0000083 (0x83 "No route to destination”
132 fsa [00000084 Ox84 "Channel unacceptable (BT interim)"
133
134 86 [00000086 Ox86 "Channel unacceptable”
135 87 [00000087 Ox87 "Call awarded and being delivered in an established channel”
136
137
138
139
140
1a
142
143
144 90 [00000090 0x90 "Normal call clearing”
145 a [00000091 0x91 "User busy”
146 92 [0000092 (0x92 "No user responding”
147 93 [00000093 0x93 "User alerting, no answer”
148
149 95 [00000095 0x95 "Call rejected”
150 96 [00000096 0x96 "Number changed”
151
152
153
154 oa [00000094 OX9A "Non-selected user clearing”
155 9B [00000096 Ox9B "Destination out of order”
156 pc [0000009e Ox9C “Invalid number format”
157 9D jo00009a Ox9D "Facility rejected”
158 SE [0000009e ‘OX9E "Response to STATUS ENQUIRY”
159 oF [00000098 OXSF "Normal unspecified”
160
161
162 AZ [000000a2 OxA2 "No cireuit/channel available”
163
164
165
166 AG [000000a6 OxAG "Network out of order”
167
168
169 Aa [000000a9 OxA9 "Temporary failure”
170 AA [000000aa ‘OxAA "Switching equipment congestion”
171 AB [000000ab OKAB "Access information discarded”
172 AC [000000ae OAC "Requested circuit/channel not available”
© 2006 Fujitsu Services Company in Confidence Page 215
Fujitsu
Services
CNIM Low Level Design
COMPANY IN CONFIDENCE
FUJ00171956
FUJ00171956
Ref: RS/LLD/004
Version: 4.0
Date: 8/05/2006
173
174
175
AF
[000000ar°
‘OxAF "Resource unavailable, unspecified”
176
177
Br
[0000001
OxBI "Quality of service unavailable”
178)
B2
[00000062
OxB2 "Requested facility not subscribed”
179)
780
181
182
183
184
185)
[Bo
[00000069
OxB9 "Bearer capability not authorized”
186
BA
[000000ba
OxBA “Bearer capability not authorized”
187
188)
189)
190
191
BF
[oo0000br
OXBF "Service or option not available, unspecified”
192
193
cr
[000000e1
OxCI "Bearer capability not implemented”
194
cz
[000000e2
OxC2 "Channel type not implemented”
195
196
197
cs
[000000e5
OxC:
jequested facility not implemented”
198)
C6
[000000c6
‘OxC6 “Only restricted information bearer capability available”
199)
201
202
203
204
205
206
207
[000000eF
OxCF "Service or option not available, unspecified”
208
209
Di
[o00000di
OxDI “Invalid call reference value"
210
[D2
[00000042
OxD2 "Identified channel does not exis
211
D3
[00000043
‘OxD3 "A suspended call exists, but this identity does not”
D+
foooo00d4
OxD4 "Call identity in use”
213
Ds
[00000005
‘OxDS "No call suspended”
De
[00000006
‘OxD6 "Call having the requested call identity has been cleared”
D7
[00000047
OxD7 “Incompatible destination”
216
IDA
[000000da
OxDA "Destination address missing or incomplete”
DB
[000000db
‘OxDB “Invalid transit network selection”
© 2006 Fujitsu Services
Company in Confidence
Page 216
Fujitsu
Services
CNIM Low Level Design
COMPANY IN CONFIDENCE
FUJ00171956
FUJ00171956
Ref: RS/LLD/004
Version: 4.0
Date: 8/05/2006
DF
[o00000dF
OXDF "Invalid message, unspecified”
224
EO
/000000e0
OxEO "Mandatory Information Element is missing”
225
EI
[000000er
OXET "Message type non-existent or not implemented”
[226
ED
[000000e2
OxE2"
fessage not compatible with call state, or not implemented”
227
Es
[000000e3
OxE3 "Information Element non-existent or not implemented”
228
Ea
[000000e4
OxE4 "Invalid Information Element contents”
229
ES
[000000e5
OxES "Message not compatible with call state”
230
ES
[00000026
OxE6 "Recovery on time expiry”
233
234
235
239
EF
[000000er
OXEF "Protocol Error, unspecified”
240
241
242
243
244
253
255
FF
joooo008r
OxFF "Interworking, unspecified”
© 2006 Fujitsu Services
Company in Confidence
Page 217
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Appendix A5. RAS ERROR CODES
RAS error code are output by Connection Manager to registry and written directly to
QOS output by CNIM.
See Appendix A10 for RAS codes prior to S92.
Win 32 RAS Error ID Connection Description
Manager/
CNIM
Value
(Hex)
PENDING (00000258 [An operation is pending
ERROR INVALID PORT HANDLE (00000259 The port handle is invalid
ERROR PORT _ALREADY_OPEN (00000254 The port is already open
ERROR BUFFER TOO SMALL (00000258 (Caller’s buffer is too small
ERROR WRONG INFO SPECIFIED (0000025C [Wrong information specified
ERROR_CANNOT SET PORT INFO (0000025D [Cannot set port information
ERROR PORT NOT CONNECTED (00000255 The port is not connected
ERROR EVENT INVALID (0000025F The event is invalid
ERROR DEVICE DOES NOT EXIST (00000260 The device does not exist
ERROR _DEVICETYPE_DOES NOT EXIST [00000261 The device type does not exist
ERROR_BUFFER_INVALID (00000262 The buller is invalid
FRROR_ROUTE_NOT_AVAILABLE (00000263 The route is not available
ERROR ROUTE _NOT_ALLOCATED (00000264 The route is not allocated
ERROR _INVALID_COMPRESSION_SPECIFI
ED
(00000265 Invalid compression specified
ERROR_OUT_OF_BUFFERS (00000266 (Out of buffers
ERROR_PORT_NOT_FOUND (00000267 The port was not found
ERROR_ASYNC_REQUEST PENDING (00000268 [An asynchronous request is pending
ERROR_ALREADY_ DISCONNECTING (00000269 The port or device is already disconnecting
ERROR PORT _NOT_OPEN (0000026A The port is not open
ERROR PORT DISCONNECTED (00000268 The port is disconnected
ERROR_NO_ENDPOINTS (0000026C There are no endpoints
ERROR CANNOT OPEN PHONEBOOK — [0000026D [Cannot open the phone book file.%
IERROR_CANNOT_LOAD_PHONEBOOK }0000026E. (Cannot load the phone book file.%
ERROR_CANNOT_FIND_PHONEBOOK_EN I0000026F Cannot find the phone book entry.%
TRY,
ERROR_CANNOT WRITE PHONEBOOK — I00000270 ICannot write the phone book file.%
IERROR_CORRUPT_PHONEBOOK (00000271 Invalid information found in the phone book file.%
JIERROR_CANNOT_LOAD_ STRING, (00000272 Cannot load a string.
ERROR_KEY NOT FOUND (00000273 [Cannot find key
ERROR DISCONNECTION (00000274 The port was disconnected.
/ERROR_REMOTE_DISCONNECTION 00000275 The data link was terminated by the remote machine.
ERROR_HARDWARE_ FAILURE (00000276 The port was disconnected due to hardware failure.
JIERROR_USER_DISCONNECTION, (00000277 IThe port was disconnected by the user
JERROR_INVALID_SIZE 00000278 The structure size is incorrect
ERROR PORT NOT AVAILABLE (00000279 The port is already in use or is not configured for Remote
Access dial out
ERROR_CANNOT PROJECT CLIENT }0000027A. Cannot register your computer on on the remote network.%I
ERROR_UNKNOWN (00000278 [Unknown error
ERROR WRONG _DEVICE_ATTACHED _ [0000027C The wrong device is attached to the port
© 2006 Fujitsu Services
Company in Confidence
Page 218
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date:
IERROR_BAD_STRING }0000027D The string could not be converted.
ERROR_REQUEST_TIMEOUT }0000027E The request has timed out.
IERROR_CANNOT GET LANA }0000027F [No asynchronous net available
ERROR_NETBIOS_ERROR 100000280 IA NetBIOS error has occurred.%
IERROR_SERVER_OUT_OF RESOURCES 100000281 The server cannot allocate NetBIOS resources needed to
[support the client
ERROR_NAME_EXISTS_ON_NET (00000282 [One of your NetBIOS names is already registered on the
remote network
ERROR_SERVER_GENERAL NET _FAILUR I00000283 IA network adapter at the server failed
iE
WARNING MSG_ALIAS NOT_ADDED 00000284 You will not receive network message popups.
/ERROR_AUTH_INTERNAL (00000285 Internal authentication error
ERROR_RESTRICTED_LOGON HOURS [00000286 The account is not permitted to logon at this time of day
ERROR_ACCT_DISABLED 00000287 The account is disabled
IERROR_PASSWD_ EXPIRED 100000288 IThe password has expired.%
ERROR_NO_DIALIN_ PERMISSION 00000289 'The account does not have Remote Access permission
ERROR_SERVER_NOT_RESPONDING 0000028A_ IThe Remote Access server is not responding
ERROR_FROM_DEVICE (0000028B Your modem (or other connecting device) has reported an
error
ERROR_UNRECOGNIZED_RESPONS! }0000028C Unrecognized response from the device
ERROR_MACRO_NOT_FOUND }0000028D IA macro required by the device was not found in the device!
INF file section
ERROR MACRO NOT DEFINED (0000028E [A command or response in the device .INF file section
refers to an undefined macro
ERROR MESSAGE MACRO NOT FOUND 0000028F FThe <message> macro was not found in the device INF
file section
ERROR_DEFAULTOFF_MACRO_ NOT FOU [00000290 The <defaultoff> macro in the device .INF file section
IND contains an undefined macro
ERROR_FILE_COULD_NOT_BE_OPENED I00000291 IThe device .INF file could not be opened
ERROR_DEVICENAME_TOO_LONG 100000292 IThe device name in the device .INF or media .INI file is
{too long
IERROR_DEVICENAME_ NOT FOUND (00000293 'The media .INI file refers to an unknown device name
JERROR_NO_RESPONSES 00000294 IThe device .INF file contains no responses for the
jcommand.%
ERROR_NO_COMMAND FOUND 00000295 IThe device .INF file is missing a command.%
ERROR_WRONG KEY SPECIFIED. 00000296 Attempted to set a macro not listed in device .INF file
section
ERROR_UNKNOWN_DEVICE_TYPE 00000297 The media INI file refers to an unknown device type
ERROR_ALLOCATING_MEMORY 100000298 Cannot allocate memory
ERROR PORT NOT CONFIGURED 100000299 The port is not configured for Remote Access
ERROR_DEVICE_NOT_READY (00000294 Your modem (or other connecting device) is not
functioning
ERROR_READING_INI_FILE }0000029B Cannot read the media .INI file
ERROR_NO_ CONNECTION }0000029C The connection dropped
ERROR_BAD_USAGE_IN_INI_ FILE. (0000029D The usage parameter in the media .INI file is invalid
ERROR_READING SECTIONNAME }0000029E, (Cannot read the section name from the media .INI file
ERROR_READING_DEVICETYPE. }0000029F [Cannot read the device type from the media .INI file
ERROR_READING_DEVICENAME 000002A0 ICannot read the device name from the media .INI file
IERROR_READING USAGE }000002A1 Cannot read the usage from the media .INI file
IERROR_READING_MAXCONNECTBPS }000002A2 ICannot read the maximum connection BPS rate from the
media .INI file
ERROR_READING_MAXCARRIERBPS }000002A3 (Cannot read the maximum carrier BPS rate from the media
INI file
IERROR_LINE_ BUSY }000002A4 The line is busy
© 2006 Fujitsu Services
Company in Confidence
8/05/2006
Page 219
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
ERROR_VOICE_ANSWER }000002A5 IA person answered instead of a modem
ERROR_NO_ANSWER 000002A6, There is no answer.%
IERROR_NO CARRIER }000002A7 Cannot detect carrier
ERROR_NO_DIALTONE }000002A8 There is no dial tone.%
ERROR_IN_COMMAND. (0000029 IGeneral error reported by device.
ERROR_WRITING_SECTIONNAME (000002AA_ [ERROR_WRITING_SECTIONNAME,
ERROR_WRITING_DEVICETYPE 000002AB J/ERROR_WRITING_DEVICETYPE
ERROR_WRITING_DEVICENAME }000002AC IERROR_WRITING_DEVICENAME
ERROR_WRITING_MAXCONNECTBPS }000002AD_ IERROR_WRITING_MAXCONNECTBPS,
IERROR_WRITING_MAXCARRIERBPS }000002AE IERROR_WRITING_MAXCARRIERBPS
ERROR_WRITING_USAGE, }000002AF /ERROR_WRITING_USAGE
IERROR_WRITING_DEFAULTOFF }000002B0 ERROR_WRITING_DEFAULTOFF
/ERROR_READING_DEFAULTOFF }000002B1 ERROR_READING_DEFAULTOFF
ERROR_EMPTY_INI_FILE }000002B2 JIERROR_EMPTY_INI_ FILE
ERROR_AUTHENTICATION FAILURE }000002B3 Access denied because username and/or password is
invalid on the domain
ERROR_PORT_OR_DEVICE }000002B4 Hardware failure in port or attached device
ERROR_NOT_BINARY_MACRO- }000002B5 JERROR_NOT BINARY MACRO.
ERROR_DCB_NOT_FOUND }000002B6 IERROR_DCB_NOT_FOUND
ERROR_STATE_MACHINES_NOT_STARTE I000002B7 ERROR_STATE_MACHINES NOT STARTED
D
ERROR_STATE_ MACHINES _ALREADY_ST}000002B8 IERROR_STATE_MACHINES_ ALREADY STARTED
ARTED
IERROR_PARTIAL_RESPONSE_LOOPING }000002B9 IERROR_PARTIAL_RESPONSE_LOOPING
IERROR_UNKNOWN_RESPONSE_KEY 000002BA. IA response keyname in the device .INF file is not in the
expected format
ERROR_RECV_BUF_FULL (000002BB IThe device response caused buffer overflow.%
ERROR_CMD_TOO_LONG (000002BC The expanded command in the device .INF file is too long
ERROR_UNSUPPORTED BPS (000002BD_ The device moved to a BPS rate not supported by the
ICOM driver
ERROR_UNEXPECTED RESPONSE (000002BE [Device response received when none expected.%
ERROR_INTERACTIVE MODE 000002BF ‘The Application does not allow user interaction. The
connection requires interaction with the user to complete
successfully.
ERROR_BAD CALLBACK NUMBER }000002C0, IERROR_BAD_ CALLBACK NUMBER
ERROR_INVALID AUTH STATE. (000002C1 ERROR_INVALID_AUTH_STATE
ERROR_WRITING_INITBPS, }000002C2 ERROR_WRITING_INITBPS
ERROR_X25_DIAGNOSTIC }000002C3 IX.25 diagnostic indication. %
JERROR_ACCT_EXPIRED }000002C4 The account has expired
ERROR_CHANGING_PASSWORD (000002C5 [Error changing password on domain. The password may
Ibe too short or may match a previously used password
ERROR_OVERRUN }000002C6 Serial overrun errors were detected while communicating
with your modem
IERROR_RASMAN CANNOT INITIALIZE — I000002C7 [RasMan initialization failure. Check the event log
IERROR_BIPLEX_PORT_NOT_AVAILABLE I000002C8 Biplex port initializing. Wait a few seconds and redial
ERROR_NO_ACTIVE_ISDN_LINES }000002C9 No active ISDN lines are available
ERROR _NO ISDN CHANNELS AVAILABL I000002CA, INo ISDN channels are available to make the call
E
ERROR_TOO_MANY_LINE_ ERRORS }000002CB 'Too many errors occurred because of poor phone line
quality
ERROR_IP_CONFIGURATION }000002CC The Remote Access IP configuration is unusable
ERROR_NO_IP_ADDRESSES: }000002CD [No IP addresses are available in the static pool of Remote
I Access IP addresses
© 2006 Fujitsu Services Company in Confidence Page 220
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
ERROR_PPP_TIMEOUT }000002CE ‘Timed out waiting for a valid response from the remote
PPP peer
ERROR_PPP_REMOTE_TERMINATED }000002CF PPP terminated by remote machine
IERROR_PPP_NO_PROTOCOLS_CONFIGUR I000002D0 INo PPP control protocols configured
ED
ERROR_PPP_NO_ RESPONSE }000002D1 [Remote PPP peer is not responding
ERROR_PPP_INVALID_PACKET 000002D2 The PPP packet is invalid
ERROR_PHONE NUMBER TOO LONG — [000002D3 The phone number including prefix and suffix is too long
IERROR_IPXCP_NO_DIALOUT_CONFIGUR I000002D4 The IPX protocol cannot dial-out on the port because the
ED machine is an IPX router
ERROR_IPXCP_NO_DIALIN_ CONFIGURED I000002D5, The IPX protocol cannot dial-in on the port because the
IPX router is not installed
/ERROR_IPXCP_DIALOUT_ALREADY_ACTII000002D6 The IPX protocol cannot be used for dial-out on more than
VE lone port at a time
ERROR_ACCESSING_TCPCFGDLL (000002D7 [Cannot access TCPCFG.DLL_
ERROR_NO_IP_RAS ADAPTER }000002D8, Cannot find an IP adapter bound to Remote Access
ERROR_SLIP_REQUIRES_IP }000002D9 SLIP cannot be used unless the IP protocol is installed
ERROR PROJECTION NOT COMPLETE [000002DA [Computer registration is not complete
ERROR PROTOCOL NOT CONFIGURED I000002DB The protocol is not configured
ERROR_PPP_NOT_CONVERGING (000002DC The PPP negotiation is not converging
ERROR_PPP_CP_REJECTED }000002DD ‘The PPP control protocol for this network protocol is not
available on the server
ERROR_PPP_LCP_TERMINATED }000002DE_ The PPP link control protocol terminated
ERROR_PPP_REQUIRED_ADDRESS_REJEC I000002DF 'The requested address was rejected by the server
TED
ERROR _PPP_NCP_TERMINATED (000002E0 The remote computer terminated the control protocol
ERROR_PPP_LOOPBACK DETECTED }000002E1 Loopback detected
IERROR_PPP_NO_ADDRESS_ASSIGNED }000002E2 The server did not assign an address
ERROR CANNOT USE LOGON _CREDENT I000002E3 The authentication protocol required by the remote server
TAL! [cannot use the Windows NT encrypted password. Redial,
entering the password explicitly
ERROR_TAPI_CONFIGURATION }000002E4 Invalid TAPI configuration
ERROR_NO_LOCAL_ENCRYPTION (000002E5 The local computer does not support the required.
encryption type
ERROR_NO_REMOTE_ENCRYPTION [(000002E6 The remote computer does not support the required
encryption type
ERROR_REMOTE_REQUIRES_ENCRYPTIO I000002E7 The remote computer requires encryption:
iN
ERROR_IPXCP_NET_NUMBER_CONFLICT I000002E8 ICannot use the IPX network number assigned by remote
server. Check the event log
}ERROR_INVALID_SMM }000002E9 JERROR_INVALID_SMM
ERROR_SMM_UNINITIALIZED }000002EA IERROR_SMM_UNINITIALIZED
ERROR_NO_MAC_FOR PORT (000002EB ERROR_NO_MAC_FOR PORT
ERROR_SMM_TIMEOUT }000002EC IERROR_SMM_TIMEOUT
IERROR_BAD_ PHONE NUMBER }000002ED IERROR_BAD_PHONE_NUMBER-
ERROR_WRONG MODULE }000002EE /ERROR_ WRONG MODULE
ERROR_INVALID CALLBACK NUMBER — I000002EF Invalid callback number. Only the characters 0 to 9, T, P,
WW, (), =. @, and space are allowed in the number.
/ERROR_SCRIPT_SYNTAX (000002FO [A syntax error was encountered while processing a script
ERROR_HANGUP_FAILED }000002F 1 The connection could not be disconnected because it was
created by the Multi-Protocol Router
INVALID RAS_HANDLE. (00000000 The current RAS handle is invalid: Converted to 0x06ce
UNKNOWN, Code not set; Converted to Ox06ff
Table 118 RAS Error Codes and CNIM Equivalents
© 2006 Fujitsu Services Company in Confidence Page 221
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Appendix A6. CONNECTION MANAGER CAUSE CODES
The Connection Manager service will output the following two codes, State and Reason, into
registry. CNIM will combine these codes to obtain the Cause Code given in the table.
State Code Registry Reason Code Registry CNIM Code
Abbreviation Abbreviation
Connected Cc N/A N/A 0x00000400.
Not Connected 'N' N/A VA 0x00000401
Diallin, 'D N/A N/A 0x00000402
Failed to Connect_I 'F' Timed Out 'T 0x00000410
Failed to Connect_I 'F' Day D request 'D' 0x00000411
Failed to Connect_I 'F' Reset request 'R’ 0x00000412
Failed to Connect_I 'F' Service Stop request 's' 0x00000413
Failed to Connect_I 'F' Blackhole 'B’ 0x00000414
Disconnected 'Xt Day D request 'D' 0x00000421
Disconnected 'X Reset request 'R’ 0x00000422
Disconnected 'X Service Stop request 's! 0x00000423
Disconnected 'X Blackhole 'B’ 0x00000424
Table 119 Connection Manager Cause Codes
© 2006 Fujitsu Services Company in Confidence Page 222
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Appendix A7. I. FUJITSU DEFINED CAUSE CODES
These codes are defined within CNIM to cover those cases where a meaningful cause code is not
returned to CNIM by the any other interface. This may occur for a number of reasons and
includes Layer I failure that can be diagnosed and reported by the Eicon card.
User Defined Fault/ Network State CNIM Value Description
PING_SUCCESS_CODE 0x00000100 Ping Succeeded
LAYERIL DOWN_CODE 0x00000110 Layer 1 Down
PING_FAIL_ CODE 0x00000111 Ping has Failed
L2_STILL_ACTIVATING_CODE 0x00000112 Layer 2 did not finish activating due
to network fault
PING_UNKNOWN_CODE 0x00000113 Ping state is unknown
PING_WAITING_CODE 0x00000114 Ping state is waiting for ping reply
(when call closed)
SHORT_CALL 0x00000115 Call length less than MCDT or
Shorthold
UNKNOWN 0x000001fF Default code, should not be seen in
practise.
Table 120 Fujitsu Defined Cause Codes
© 2006 Fujitsu Services Company in Confidence Page 223
Fujitsu
Services
CNIM Low Level Design
COMPANY IN CONFIDENCE
FUJ00171956
FUJ00171956
Ref: RS/LLD/004
Version: 4.0
Date: 8/05/2006
Appendix A8. CNIM CAUSE CODES
If CNIM service changes state such that the call record is closed the value in the following table is
placed in the QOS record.
State Code
Cause Code Hex Value
Service Shutdown
0x00000500.
Table 121 CNIM Service State Codes
© 2006 Fujitsu Services
Company in Confidence
Page 224
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
Appendix A9. DIAPI INTERFACE
The NDIS driver is not able to directly interface to user mode applications. Therefore,
applications must be developed in user mode interfacing the DIAPI library. The diapi library is
developed in Kernel mode. The DIAPI DLL interfaces directly with the NDIS driver. The NDIS
driver interfaces with IDI (ISDN driver interface — Didd.sys) which contains the protocol stack.
IDI interfaces directly with the ISDN card. This package is intended to work on an ISDN BRI
line.
The table below shows the DIAPI functions available to CNIM.
Function Description
Di_InitQ The Di_Init () function initialises the internal data structures of the diapi library.
Di_Init () is the first command called. This function must be called before any
other function of the Eicon diapi library can be used.
Once called, any or many of the other functions may be called in any random
sequence. The last function to be called, however, must be Di_Close ( ) before
exiting the application.
Calling Di_Init () renders the line state as active (State = I_ACTIVE).
Di_Close( ) The Di_Close ( ) function is the last function to call. This function terminates
Diapi. Once Di_Close ( ) is called, the only two options are to exit the application
or re-initialise the diapi library. Calling Di_Init( ) is required to re-initialise the
diapi library.
int Di_Disable (int chan) The Di_Disable ( ) function completes afier receiving a RELEASE and
transmitting a RELEASE COMPLETE to the network layer Q.931. The Q.931
cause code for this function call is 80 90 - Normal Call Clearing. Subsequently,
Di_Enable () function must be called for data transfer to continue.
During a call setup or a ping, this is seen as a “hardware error”. This is because
calling Di_Disable ( ) renders the Eicon adapter inactive and unable to
communicate with the ISDN switch.
The line state for the Di_Disable ( ) function call is down (State = I DOWN).
Subsequent requests for call set-ups will be rejected unless Di_Enable ( ) is
issued.
int Di_Enable (int chan) The Di_Enable () function completes when a Q931 call setup message SETUP is
followed by a call proceeding of the channel id CALL PROC. The connection
with the peer is established when we receive a connect RX CONN and then
transmit a connect acknowledge CONN ACK. The DindisDiOut line state
changes from I_INIT to I CALLING (CALL PROC).
During a call setup or a ping, assuming PPP has been negotiated successfully, a
ping reply is the appropriate response.
If the Eicon adapter is in an inactive state (Ditrace may indicate this), the adapter
may be activated either through the diapi interface by calling Di_Enable ( ) and
then choosing a B channel or using dcontrol by clicking on enable.
Int Di_SaveNumbers The Di_SaveNumbers () function asks the user to enter the called party numbers,
(pdinumbers pnumbers) the destination subaddresses, the local origination address, and the local
origination subaddress. The user is asked to enter up to 4 called party numbers
and 4 destination subaddresses. This information is saved and written to the
registry instantaneously.
MSN stands for Multiple Subscriber Number, OAD for Origination address. This
is the ISDN number of the line the NDIS is attached to.
The NDIS driver uses this number to check that it is the destination for any
incoming call. With ISDN you can have several devices on the same ISDN line
© 2006 Fujitsu Services Company in Confidence Page 225
Fujitsu
Services
FUJ00171956
FUJ00171956
CNIM Low Level Design Ref: RS/LLD/004
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
and usually each is assigned a different number (MSN) so they can decide
whether or not to pick up incoming calls.
The default value of 0 would mean that incoming calls would only be picked up if
the ISDN number of the line ended in a zero (NDIS does a comparison starting
from the right digit).
In many installations this is not the case, and as the NDIS is the only device on
the ISDN line setting the MSN to Nul means that it will not care what the
destination number of an incoming call is, and so will pick the call up (subject to
CLI information above).
For called party numbers, the primary number is tried first. If this number fails,
then the second number is dialed. If the second number fails to connect then the
third number is dialed. If the third number fails to connect the fourth number is
dialed. If the fourth number fails to connect, the first number is retried and the
process continues in a round robin fashion.
Note: The fouth number entered should be the same as any one of the other 3
numbers, in order for the process to work in a round robin fashion.
Int Di_GetNumbers
(pdinumbers pnumbers)
The Di_GetNumbers ( ) fumction retrieves the called party number(s), the
destination subaddress(es), the local origination address, and the local origination
subaddress. The Di_GetNumbers ( ) function will retrieve the most recent
information that was stored in the registry using the Di_SaveNumbers ( )
function.
The Di_SaveNumbers ( ) function is, therefore, called at least once for entering
user data. Di_GetNumbers ( ) can then be called without having to call
Di_SaveNumbers ( ) first.
int Di_SavePwds (char
*pwd_inbound, char
*pwd_outbound,
char
*usr_inbound[MAX_USER
_NAME_CNT],
char *usr_outbound)
The function Di_SavePwds ( ) prompts the user to enter an outbound user id and
password, and an inbound user id and password.
The outbound user id and password is used for authentication on the remote
router. The Outbound User is the PPP username of the NDIS driver (and hence
PO Counter).
A user account must exist on the remote router. The inbound user id and
password is used for authentication on the Eicon Diva adapter. The Inbound user
array is a list of PPP usernames of the remote routers (each router can have a
different name).
The array size of MAX_USER_NAME._CNT is defined as 20 in diapi.h. This
means that there could be up to 20 inbound user ids configured to dial into the
Eicon NDIS adapter.
In Pathway’s case CHAP is used for PPP authentication so the Inbound and
Outbound Password are set to the same value — usually known as the CHAP
“Secret”.
If any of these values is changed it is used on the next time a connection is made
or received
When LCP is activated by a call, the password information is used to negotiate
CHAP.
CHAP requires that the same password (key) be used by both peers.
int Di_GetPwds (char
*pwd_inbound, char
*pwd_outbound,
char
*usr_inboundIMAX_USER
_NAME CNT],
char *usr_outbound)
The function Di_GetPwds ( ) function retrieves both outbound and inbound userid
and password information from the registry.
The Di_GetPwds ( ) function will retrieve the most recent information that was
stored in the registry using the Di_SavePwds () function. The Di_SavePwds ( )
function is, therefore, called at least once for entering user data. Di_GetPwds ( )
can then be called without having to call Di_SavePwds ( ) first.
The password information can only be obtained by calling Di_GetPwds ( ). The
© 2006 Fujitsu Services
Company in Confidence Page 226
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
password information in the registry is stored in encrypted form, and no password
information is present in the output of the Eicon supplied log file utilities such as
Ditrace.exe.
int Di_SetCommOpts The Di_SetCommOpts ( ) function prompts the user to turn broadcast on or off, to
(pdicommopts pcopts) enter a values for each of the backoff parameters (Alpha, Beta , M) and to enter a
reply timeout value.
The broadcast filter is designed to stop any IP packets with a broadcast address
from being transmitted over the ISDN line
The reason for this filter is that NT uses broadcast extensively to locate and
monitor network resources such as PDC's, drive letter assignments, remote
printers, etc. These broadcast packets are sent by NT on a regular basis over every
available interface and will result in an ISDN call being initiated or if a call is up
will result in the idle timer being reset so lengthening call times.
Therefore if you leave the broadcast filter turned off for any length of time you
will incur extra ISDN call charges but will also unnecessarily hold open the only
ISDN channel you have available for use so preventing other PO locations from
dialling in with configuration requests.
Also, if a broadcast packet is sent by NT in the time between setting broadcast on
and changing the number, a call will be initiated to the previously stored number
which although the call will probably fail, CHAP authentication is not desirable.
If you do need to leave the broadcast filter off for periods then an option would be
to look at explicitly filtering out the ports that NT uses for network traffic -
generally UDP port 137 and TCP port 139 and/or remove the bindings for WINS
from the NDIS interface.’
The alpha, beta and M backoff parameters are described in the algorithm below.
a, b and m variables for back off algorithm
Back off i.e. If the called number is busy at time TO then it is retried at times TO +
b, TO + ab, TO + a2b,,....,TO + am-1b, where a,b and m are supplied as profile
parameters.
The default action is to send all IP packets except those with a broadcast address
— this is to prevent Windows Networking broadcasts bringing the ISDN line up
unnecessarily.
The Shorthold timer indicates that if there is no data traffic or if the line is idle
for the amount of second specified, then issue a disconnect. The Shorthold timer
is in seconds format. When the Shorthold timer expires, a disconnect DISC will
be transmitted TX with a Q931 message of Normal call clearing with Cause 80
90.
The reply timer indicates that if the remote peer does not reply to a request (ex.
SETUP) then this timer will expire and a disconnect DISC will be transmitted
TX with a Q931 message of Normal call clearing with Cause 80 90.
The disconnect is issued because of a call time out.
int Di_GetCommOpts The Di_GetCommOpts () function will retrieve the most recent information that
(pdicommopts pcopts) was stored in the registry using the
Di_SetCommOpts ( ) function. The Di_SetCommOpts ( ) function is, therefore,
called at least once for entering user data.
Di_GetCommOpts ( ) can then be called without having to call Di_SetCommOpts
() first.
Table 122 DIAPI Functions
© 2006 Fujitsu Services Company in Confidence Page 227
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
© 2006 Fujitsu Services Company in Confidence Page 228
Fujitsu
Services
COMPANY IN CONFIDENCE
CNIM Low Level Design
FUJ00171956
FUJ00171956
Ref: RS/LLD/004
Version: 4.0
Date: 8/05/2006
Appendix A10. RAS ERROR CODES - PRE S92
RAS error code are output by Connection Manager to registry and mapped to QOS
output by CNIM.
Win 32 RAS Error ID ‘Win32 I Connection I CNIM Description
Value I Manager Value
(Dec) Value
(Hex)
PENDING (600 (00000258 (0600 ‘An operation is pending
ERROR INVALID _PORT HANDLE (601 (00000259 (0601 The port handle is invalid
ERROR PORT ALREADY OPEN (602 (00000254 (0602 The port is already open
ERROR BUFFER TOO SMALL (603 (00000258 (0603 (Callers buffer is too small
ERROR_WRONG_INFO_ SPECIFIED (604 (0000025C (0604 ‘Wrong information specified
ERROR_CANNOT SET PORT_INFO 605 (0000025D (0605 ICannot set port information
ERROR PORT NOT CONNECTED 606 (0000025 (0606 The port is not connected
ERROR _EVENT INVALID (607 (00000255 (0607 "The event is invalid
ERROR DEVICE DOES NOT EXIST (608 (00000260 (0608 The device does not exist
ERROR DEVICETYPE DOES NOT EXIST [609 (00000261 (0609 The device type does not exist
ERROR BUFFER INVALID 610 (00000262 060A The buffer is invalid
ERROR ROUTE _NOT_AVAILABLE 611 (00000263 (0608 The route is not available
ERROR ROUTE_NOT_ ALLOCATED 612 (00000264 (0606 The route is not allocated
ERROR _INVALID_COMPRESSION_SPECIFI[613 (00000265 (060D Tnvalid compression specified
ED
FRROR_OUT_OF BUFFERS 614 (00000266 060E (Out of bufers
ERROR PORT NOT FOUND 615 (00000267 (060F The port was not found
ERROR_ASYNC REQUEST PENDING 616 (00000268 (0610 [An asynchronous request is pending,
ERROR_ALREADY DISCONNECTING 617 (00000269 o6it The port or device is already disconnecting
ERROR PORT NOT_OPEN 618 (0000026A (0612 The port is not open
ERROR PORT DISCONNECTED (619 (00000268 (0613 The port is disconnected
ERROR_NO_ENDPOINTS (620 (0000026C (0614 There are no endpoints
ERROR CANNOT OPEN PHONEBOOK [621 (0000026D 0615 [Cannot open the phone book file.%
ERROR CANNOT LOAD PHONEBOOK [622 (0000026E (0616 [Cannot load the phone book file.%
ERROR_CANNOT FIND PHONEBOOK_EN [623 (0000026F (0617 [Cannot find the phone book entry.%
TRY
ERROR_CANNOT_WRITE PHONEBOOK — [624 (00000270 (0618 [Cannot write the phone book file.%
ERROR_CORRUPT_PHONEBOOK. (625 (00000271 (0619 Invalid information found in the phone book file.%
ERROR _CANNOT LOAD STRING (626 (00000272 Car (Cannot load a string.
ERROR_KEY NOT FOUND (627 (00000273 061B [Cannot find key
ERROR DISCONNECTION 628 (00000274 (061 The port was disconnected.
ERROR_REMOTE_DISCONNECTION (629 (00000275 061D The data link was terminated by the remote machine.
ERROR HARDWARE. FAILURE 630 (00000276 O61E The port was disconnected due to hardware failure.
ERROR USER DISCONNECTION (631 (00000277 (o61F The port was disconnected by the user
ERROR INVALID SIZE (632 (00000278 (0620 The structure size is incorrect
ERROR PORT NOT AVAILABLE (633 (00000279 0621 The port is already in use or is not configured for Remote
Access dial out
ERROR_CANNOT PROJECT CLIENT 634 (0000027 (0622 [Cannot register your computer on on the remote network.%I
ERROR_UNKNOWN (635 (00000278 (0623 Unknown error
ERROR WRONG DEVICE ATTACHED [636 (0000027C (0624 The wrong device is attached to the port
ERROR BAD STRING (637 (0000027 (0625 The string could not be converted.
ERROR_REQUEST TIMEOUT 638 (0000027 (0626 The request has timed out.
ERROR_CANNOT_GET_LANA 639 (0000027F (0627 [No asynchronous net available
© 2006 Fujitsu Services
Company in Confidence
Page 229
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
ERROR_NETBIOS_ERROR 640 100000280 0628 A NetBIOS error has occurred.%
JERROR_SERVER_OUT_OF_RESOURCES 641 00000281 0629 I The server cannot allocate NetBIOS resources needed to
support the client
IERROR_NAME_EXISTS_ON_NET 642 100000282 062A I One of your NetBIOS names is already registered on the
remote network
IERROR_SERVER_GENERAL NET FAILUR I643 00000283 062B A network adapter at the server failed
E
WARNING _MSG_ALIAS_NOT_ADDED 644 (00000284 (0620 ‘You will not receive network message popups
/ERROR_AUTH_INTERNAL 645, 00000285 (062D Internal authentication error
JIERROR_RESTRICTED_LOGON_ HOURS 646 00000286 (062E The account is not permitted to logon at this time of day
ERROR_ACCT_DISABLED 647 00000287 I062F The account is disabled
ERROR_PASSWD_EXPIRED 648, 100000288 10630 I The password has expired.%
ERROR_NO_DIALIN PERMISSION 1649 100000289 0631 IThe account does not have Remote Access permission
ERROR_SERVER_NOT_RESPONDING 1650 0000028A_ 10632 I The Remote Access server is not responding
JERROR_FROM_DEVICE 651 10000028B. 10633 Your modem (or other connecting device) has reported an_
error
IERROR_UNRECOGNIZED_RESPONSE 1652 }0000028C 10634 I Unrecognized response from the device
ERROR_MACRO_NOT_FOUND 1653 10000028D_ 10635 A macro required by the device was not found in the deviceI
INF file section
IERROR_MACRO_NOT_DEFINED 654 (0000028E_ 10636 I A command or response in the device .INF file section
refers to an undefined macro
ERROR_MESSAGE_MACRO_NOT_FOUND I655 (0000028F 0637 The <message> macro was not found in the device INF
file section
ERROR_DEFAULTOFF MACRO NOT FOU I656 (00000290 (0638 The <defaultoff> macro in the device .INF file section
Icontains an undefined macro
IERROR_FILE COULD NOT _BE OPENED I657 100000291 10639 The device .INF file could not be opened
ERROR_DEVICENAME_TOO_LONG 658 (00000292 (063A The device name in the device .INF or media .INT file is
too long
ERROR_DEVICENAME NOT FOUND 659 (00000293 (063B The media .INI file refers to an unknown device name
JERROR_NO_RESPONSES 1660, 00000294 1063C_ The device .INF file contains no responses for the
jcommand.%
ERROR_NO_ COMMAND FOUND 661 (00000295 (063D The device .INF file is missing a command.%
IERROR_WRONG_KEY_ SPECIFIED 662 100000296 (063E I Attempted to set a macro not listed in device .INF file
section
ERROR_UNKNOWN_DEVICE_TYPE 663 00000297 }063F The media .INI file refers to an unknown device type
IERROR_ALLOCATING_ MEMORY 664 100000298 10640 Cannot allocate memory
ERROR_PORT_NOT_CONFIGURED 665, 100000299 0641 IThe port is not configured for Remote Access
ERROR_DEVICE_NOT_READY 666 0000029A_ 0642 Your modem (or other connecting device) is not
functioning
ERROR_READING_INI_FILE 1667 }0000029B 0643, ‘Cannot read the media .INI file
ERROR_NO_CONNECTION 668 10000029C 0644 The connection dropped
ERROR_BAD_USAGE_IN_INI FILE 669 }0000029D 0645, The usage parameter in the media .INI file is invalid
ERROR_READING_SECTIONNAME 1670 0000029 10646 Cannot read the section name from the media .INI file
ERROR_READING_DEVICETYPE 671 (0000029F 0647 ‘Cannot read the device type from the media .INI file
ERROR_READING_DEVICENAME 672 000002A0 0648 ICannot read the device name from the media .INI file
IERROR_READING_ USAGE 1673 }000002A1 0649 Cannot read the usage from the media .INI file
IERROR_READING MAXCONNECTBPS 674 }000002A2 064A ICannot read the maximum connection BPS rate from the
media .INI file
JERROR_READING MAXCARRIERBPS 1675 (0000023 064B Cannot read the maximum carrier BPS rate from the media
INI file
IERROR_LINE_BUSY 1676 1000002A4 064C IThe line is busy
/ERROR_VOICE_ANSWER 677 }000002A5 064D IA person answered instead ofa modem
ERROR_NO_ANSWER 678 }000002A6, 064E There is no answer.%
ERROR_NO_ CARRIER 679 (000002A7 064F ‘Cannot detect carrier
© 2006 Fujitsu Services
Company in Confidence
Page 230
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
ERROR_NO_DIALTONE 1680 000002A8 0650 There is no dial tone.%
IERROR_IN_-COMMAND 681 000002A9 10651 IGeneral error reported by device.%
ERROR_WRITIN¢ ;IECTIONNAME 682 }000002AA_ (0652 ERROR_WRITING. (CTIONNAME
ERROR_WRITING_DEVICETYPE, 683, 000002AB 10653, ERROR_WRITING_DEVICETYPE
IERROR_WRITING_DEVICENAME 684 }000002AC 10654 ERROR_WRITING_DEVICENAME
ERROR_WRITING MAXCONNECTBPS [685 (000002AD___Iooss ERROR_WRITING_MAXCONNECTBPS
ERROR_WRITING_MAXCARRIERBPSI 686, }000002AE 10656 ERROR_WRITING_MAXCARRIERBPS
ERROR WRITING USAGE 687 (o00002AF [0657 ERROR WRITING USAGE
ERROR_WRITING_DEFAULTOFF 688 000002B0, 0658 ERROR_WRITING_DEFAULTOFF
ERROR_READING_DEFAULTOFF 689 00000281 (0659 ERROR_READING_DEFAULTOFF
/ERROR_EMPTY_INI_ FILE 1690 }000002B2 065A. ERROR_EMPTY_INI_ FILE
/ERROR_AUTHENTICATION_ FAILURE 691 1000002B3 065B I Access denied because username and/or password is
invalid on the domain
ERROR PORT OR DEVICE 1692 000002B4 065C_ I Hardware failure in port or attached device
ERROR_NOT_BINARY_MACRO- 1693 (000002B5 (065D ERROR_NOT_BINARY_MACRO-
ERROR_DCB_NOT FOUND 694 (00000286 (065E ERROR_DCB_NOT_FOUND
ERROR_STATE_MACHINES_NOT_STARTE I695, }000002B7 I065F ERROR_STATE_MACHINES NOT STARTED
iD
ERROR_STATE_MACHINES_ALREADY_STI696 000002B8 0660 ERROR_STATE_MACHINES_ALREADY_ STARTED
IARTED
JIERROR_PARTIAL_RESPONSE_LOOPING — I697 }000002B9 0661 ERROR_PARTIAL_ RESPONSE LOOPING
ERROR_UNKNOWN_RESPONSE_KEY 698 000002BA. 10662 A response keyname in the device .INF file is not in the
/expected format
ERROR_RECV_BUF_ FULL 1699 (000002BB 10663 The device response caused buffer overflow.%
JERROR_CMD_TOO_LONG 700 1000002BC 10664 The expanded command in the device .INF file is too long
ERROR_UNSUPPORTED BPS 701 000002BD_ 0665, I The device moved to a BPS rate not supported by the
ICOM driver
IERROR_UNEXPECTED_RESPONSE 702 1000002BE_ 10666 I Device response received when none expected.%
ERROR_INTERACTIVE_MODE 703 000002BF 0667 IThe Application does not allow user interaction. The
[connection requires interaction with the user to complete
successfully.
ERROR_BAD_CALLBACK_NUMBER. 704 000002C0, 0668 ERROR_BAD_CALLBACK_ NUMBER
ERROR_INVALID_AUTH_STATE. 705 }000002C1 0669 ERROR_INVALID_AUTH_STATE
ERROR_WRITING_INITBPS, 706 }000002C2 066A ERROR_WRITING_INITBPS
IERROR_X25_DIAGNOSTIC 707 }000002C3 0668 }X.25 diagnostic indication.%
ERROR_ACCT_EXPIRED 708, }000002C4 066C The account has expired
ERROR_CHANGING PASSWORD 709) (000002CS (066D_ Error changing password on domain. ‘The password may
[be too short or may match a previously used password
ERROR_OVERRUN 710 }000002C6 (066E Serial overrun errors were detected while communicating
with your modem
ERROR _RASMAN CANNOT INITIALIZE [711 (00000207 066F RasMan initialization failure. Check the event log
IERROR_BIPLEX_PORT_NOT_AVAILABLE I712 1000002C8. 10670 Biplex port initializing, Wait a few seconds and redial
IERROR_NO_ACTIVE_ISDN_LINES 713 1000002C9 10671 No active ISDN lines are available
IERROR_NO_ISDN_CHANNELS_AVAILABL I714 000002CA 0672 INo ISDN channels are available to make the call
ERROR_TOO_MANY_LINE_ERRORS. 715 (000002CB (0673 Too many errors occurred because of poor phone line
quality
ERROR_IP_CONFIGURATION 716 }000002CC 10674 IThe Remote Access IP configuration is unusable
ERROR_NO_IP_ADDRESS! TT (000002CD_ 0675, No IP addresses are available in the static pool of Remote
I Access IP addresses
/ERROR_PPP_TIMEOUT 718 }000002CE, 10676 Timed out waiting for a valid response from the remote
PPP peer
JERROR_PPP_REMOTE_TERMINATED 719 }000002CF 10677 PPP terminated by remote machine
ERROR _PPP_NO_ PROTOCOLS _CONFIGUR I720 }000002D0_ 10678 No PPP control protocols configured
© 2006 Fujitsu Services
Company in Confidence
Page 231
FUJ00171956
FUJ00171956
Fujitsu CNIM Low Level Design Ref: RS/LLD/004
Services
Version: 4.0
COMPANY IN CONFIDENCE Date: 8/05/2006
ED
ERROR_PPP_NO RESPONSE 721 (000002D1 (0679 Remote PPP peer is not responding
ERROR_PPP_INVALID_PACKET 722 (000002D2 067A, The PPP packet is invalid
/ERROR_PHONE_NUMBER_TOO LONG 723 (000002D3 (067B The phone number including prefix and suffix is too long
IERROR_IPXCP_NO_DIALOUT_CONFIGUR I724 (000002D4 067C IThe IPX protocol cannot dial-out on the port because the
ED machine is an IPX router
IERROR_IPXCP_NO_DIALIN_CONFIGURED I725 }000002D5 (067D The IPX protocol cannot dial-in on the port because the
IPX router is not installed
IERROR_IPXCP_DIALOUT ALREADY _ACTII726 1000002D6 (067E The IPX protocol cannot be used for dial-out on more than
VE [one port ata time
ERROR_ACCESSING_TCPCFGDLL 727 }000002D7 067F Cannot access TCPCFG.DLL
ERROR_NO_IP_RAS_ ADAPTER 728 000002D8, 0680 Cannot find an IP adapter bound to Remote Access
ERROR_SLIP_REQUIRES_IP 729 000002D9 0681 ‘SLIP cannot be used unless the IP protocol is installed
ERROR PROJECTION NOT COMPLETE — I730 }000002DA_ 0682 I Computer registration is not complete
IERROR_ PROTOCOL NOT CONFIGURED {731 (000002DB 0683, The protocol is not configured
IERROR_PPP_NOT CONVERGING 732 1000002DC 0684 I The PPP negotiation is not converging
ERROR_PPP_CP_REJECTED 733 }000002DD 0685 IThe PPP control protocol for this network protocol is not
available on the server
ERROR_PPP_LCP_TERMINATED 734 }000002DE 10686 IThe PPP link control protocol terminated
IERROR_PPP_REQUIRED_ADDRESS_REJEC I735 }000002DF 0687 IThe requested address was rejected by the server
TED
ERROR_PPP_NCP_TERMINATED 736 1000002E0 0688 IThe remote computer terminated the control protocol
ERROR_PPP_LOOPBACK DETECTED 737 000002E1 0689 Loopback detected
ERROR_PPP_NO_ADDRESS_ASSIGNED 738 }000002E2 068A. The server did not assign an address
IERROR_CANNOT_USE_LOGON_CREDENT I739 }000002E3 068B The authentication protocol required by the remote server
TALS Icannot use the Windows NT enerypted password. Redial,
entering the password explicitly
ERROR_TAPI_CONFIGURATION 740, }000002E4 068C_ Invalid TAPI configuration
ERROR _NO LOCAL ENCRYPTION 741 (000002E5 068D_ The local computer does not support the required
encryption type
ERROR_NO_REMOTE_ENCRYPTION 742, }000002E6 (068E. The remote computer does not support the required
encryption type
ERROR REMOTE REQUIRES ENCRYPTIOI743 (00000257 [06sF The remote computer requires encryption
ERROR_IPXCP_NET_NUMBER_CONFLICT I744 }000002E8 0690 Cannot use the IPX network number assigned by remote
server. Check the event log
JERROR_INVALID_SMM 745 (000002E9- 0691 ERROR_INVALID_ SMM
ERROR_SMM_UNINITIALIZED 746 }000002EA 0692 ERROR_SMM_UNINITIALIZED
ERROR_NO MAC FOR PORT 747 (000002EB 0693 ERROR_NO_MAC FOR PORT
ERROR_SMM_TIMEOUT 748 }000002EC 0694 ERROR_SMM_TIMEOUT
ERROR_BAD PHONE NUMBER 749 (000002ED 0695, ERROR_BAD PHONE NUMBER
ERROR_WRONG_MODULE 750 (000002EE [0696 ERROR_WRONG_MODULE
ERROR_INVALID_CALLBACK NUMBER I751 (000002EF 0697 Invalid callback number. Only the characters 0 to 9, T, P,
'W, (,), -, @, and space are allowed in the number.
ERROR_SCRIPT_SYNTAX 752 (000002FO (0698 /A syntax error was encountered while processing a script
ERROR_HANGUP_FAILED 753 }000002F 1 10699 The connection could not be disconnected because it was.
‘created by the Multi-Protocol Router
INVALID RAS_HANDLE. 0 (00000000 Ox06ee The current RAS handle is invalid
UNKNOWN, Oxo6ir Code not set
© 2006 Fujitsu Services Company in Confidence Page 232