emolero commited on
Commit
681b011
·
verified ·
1 Parent(s): 745a900

Add files using upload-large-folder tool

Browse files
This view is limited to 50 files because it contains too many changes.   See raw diff
Files changed (50) hide show
  1. marked/Rel-10/32_series/32101/raw.md +0 -0
  2. marked/Rel-10/32_series/32102/raw.md +0 -0
  3. marked/Rel-10/32_series/32103/raw.md +888 -0
  4. marked/Rel-10/32_series/32111-1/raw.md +623 -0
  5. marked/Rel-10/32_series/32111-2/raw.md +0 -0
  6. marked/Rel-10/32_series/32111-6/raw.md +0 -0
  7. marked/Rel-10/32_series/32121/raw.md +183 -0
  8. marked/Rel-10/32_series/32122/raw.md +983 -0
  9. marked/Rel-10/32_series/32126/raw.md +1109 -0
  10. marked/Rel-10/32_series/32140/raw.md +0 -0
  11. marked/Rel-10/32_series/32141/raw.md +356 -0
  12. marked/Rel-10/32_series/32150/raw.md +487 -0
  13. marked/Rel-10/32_series/32151/raw.md +705 -0
  14. marked/Rel-10/32_series/32152/raw.md +1024 -0
  15. marked/Rel-10/32_series/32153/raw.md +1259 -0
  16. marked/Rel-10/32_series/32154/raw.md +379 -0
  17. marked/Rel-10/32_series/32155/raw.md +187 -0
  18. marked/Rel-10/32_series/32171/raw.md +135 -0
  19. marked/Rel-10/32_series/32172/raw.md +0 -0
  20. marked/Rel-10/32_series/32176/raw.md +1856 -0
  21. marked/Rel-10/32_series/32181/raw.md +637 -0
  22. marked/Rel-10/32_series/32182/raw.md +620 -0
  23. marked/Rel-10/32_series/32240/raw.md +0 -0
  24. marked/Rel-10/32_series/32250/raw.md +0 -0
  25. marked/Rel-10/32_series/32252/raw.md +0 -0
  26. marked/Rel-10/32_series/32270/raw.md +0 -0
  27. marked/Rel-10/32_series/32271/raw.md +933 -0
  28. marked/Rel-10/32_series/32272/raw.md +0 -0
  29. marked/Rel-10/32_series/32273/raw.md +0 -0
  30. marked/Rel-10/32_series/32274/raw.md +1011 -0
  31. marked/Rel-10/32_series/32275/raw.md +0 -0
  32. marked/Rel-10/32_series/32280/raw.md +0 -0
  33. marked/Rel-10/32_series/32295/raw.md +1201 -0
  34. marked/Rel-10/32_series/32296/raw.md +0 -0
  35. marked/Rel-10/32_series/32297/raw.md +893 -0
  36. marked/Rel-10/32_series/32300/raw.md +929 -0
  37. marked/Rel-10/32_series/32301/raw.md +207 -0
  38. marked/Rel-10/32_series/32302/raw.md +933 -0
  39. marked/Rel-10/32_series/32306/raw.md +0 -0
  40. marked/Rel-10/32_series/32311/raw.md +196 -0
  41. marked/Rel-10/32_series/32312/raw.md +477 -0
  42. marked/Rel-10/32_series/32316/raw.md +987 -0
  43. marked/Rel-10/32_series/32321/raw.md +342 -0
  44. marked/Rel-10/32_series/32322/raw.md +0 -0
  45. marked/Rel-10/32_series/32326/raw.md +1463 -0
  46. marked/Rel-10/32_series/32331/raw.md +288 -0
  47. marked/Rel-10/32_series/32332/raw.md +1049 -0
  48. marked/Rel-10/32_series/32336/raw.md +0 -0
  49. marked/Rel-10/32_series/32341/raw.md +249 -0
  50. marked/Rel-10/32_series/32342/raw.md +715 -0
marked/Rel-10/32_series/32101/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
marked/Rel-10/32_series/32102/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
marked/Rel-10/32_series/32103/raw.md ADDED
@@ -0,0 +1,888 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+
4
+
5
+
6
+
7
+ # Contents
8
+
9
+ | | |
10
+ |----------------------------------------------------------------------------|-----------|
11
+ | Foreword ..... | 4 |
12
+ | Introduction ..... | 4 |
13
+ | 1 Scope..... | 5 |
14
+ | 2 References..... | 5 |
15
+ | 3 Definitions and abbreviations ..... | 5 |
16
+ | 3.1 Definitions..... | 5 |
17
+ | 3.2 Abbreviations ..... | 5 |
18
+ | 4 IRP Framework..... | 6 |
19
+ | 4.1 Introduction ..... | 6 |
20
+ | 4.2 IRP Framework Highlights ..... | 6 |
21
+ | 4.2.1 IRP Concept..... | 6 |
22
+ | 4.2.2 Interface IRP vs. NRM IRP..... | 7 |
23
+ | 4.2.3 IRP Development Principles ..... | 7 |
24
+ | 4.2.4 IRP Specification Structure ..... | 8 |
25
+ | 4.2.5 Essential IRP Definitions [2]..... | 8 |
26
+ | 4.3 IRP related High-level Requirements & Architecture Specifications..... | 9 |
27
+ | 5 Interface IRP's..... | 10 |
28
+ | 5.1 Interface IRP Overview..... | 10 |
29
+ | 5.2 Generic/Common Interface IRP's ..... | 10 |
30
+ | 5.3 FM related Interface IRP's ..... | 11 |
31
+ | 5.4 CM related Interface IRP's ..... | 11 |
32
+ | 5.5 PM & Trace related Interface IRP's ..... | 12 |
33
+ | 5.6 Special-purpose related Interface IRP's ..... | 12 |
34
+ | 6 NRM IRP's..... | 13 |
35
+ | 6.1 NRM IRP Overview..... | 13 |
36
+ | 6.2 Common NRM IRP's ..... | 13 |
37
+ | 6.3 Access Network (AN) related NRM IRP's..... | 14 |
38
+ | 6.4 Core/IMS related NRM IRP's ..... | 14 |
39
+ | 6.5 H(e)NB related NRM IRP's ..... | 14 |
40
+ | 6.6 Service Management related NRM IRP's and UDC specifications ..... | 15 |
41
+ | 6.7 Special-purpose related NRM IRPs ..... | 16 |
42
+ | 7 Measurement & Trace Definitions..... | 17 |
43
+ | 7.1 Performance Measurements..... | 17 |
44
+ | 7.1.1 Overview and relationships to IRP Framework ..... | 17 |
45
+ | 7.1.2 Performance Measurement Specifications ..... | 18 |
46
+ | 7.2 Trace Specifications..... | 20 |
47
+ | 7.2.1 Overview and relationships to IRP Framework ..... | 20 |
48
+ | 7.2.2 Trace Specifications ..... | 20 |
49
+ | 8 Relationships between IRPs..... | 21 |
50
+ | 9 SON Functions..... | 22 |
51
+ | <b>Annex A (Informative): IRP Packaging Suggestions .....</b> | <b>25</b> |
52
+ | A.1 Overview & Purpose ..... | 25 |
53
+ | Annex B (informative): Change history..... | 26 |
54
+
55
+ # --- Foreword
56
+
57
+ This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP).
58
+
59
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
60
+
61
+ Version x.y.z
62
+
63
+ where:
64
+
65
+ - x the first digit:
66
+ - 1 presented to TSG for information;
67
+ - 2 presented to TSG for approval;
68
+ - 3 or greater indicates TSG approved document under change control.
69
+ - y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
70
+ - z the third digit is incremented when editorial only changes have been incorporated in the document.
71
+
72
+ # --- Introduction
73
+
74
+ This specification provides the IRP Overview for 3GPP specifications, addressing Interface IRPs, NRM IRPs, Measurement / Trace /SON specifications, as well as their relationships with each other.
75
+
76
+ # --- 1 Scope
77
+
78
+ The present document gives an overview about 3GPP's management interface capabilities and related functionality. It provides high-level information about IRP Framework, available IRP's as well as their relationship with each other. This document is intended to be a guide into the world of 3GPP management specifications, enabling also non-subject matter experts to gain an understanding about 3GPP's management solutions.
79
+
80
+ In addition Annex A provides IRP packaging suggestions, intended to guide service providers as well as equipment and solutions providers to identify and choose suitable standardized management interface capabilities.
81
+
82
+ # --- 2 References
83
+
84
+ The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
85
+
86
+ - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
87
+ - For a specific reference, subsequent revisions do not apply.
88
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
89
+ - [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications".
90
+ - [2] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions".
91
+ - [3] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements".
92
+ - [4] 3GPP TS 32.102: "Telecommunication management; Architecture".
93
+ - [5] 3GPP TS 32.111-1: "Telecommunication management; Fault Management; Part 1: 3G fault management requirements".
94
+ - [6] 3GPP TS 32.111-2: "Telecommunication management; Fault Management; Part 2: Alarm Integration Reference Point (IRP): Information Service (IS)".
95
+ - [7] 3GPP TS 32.111-6: "Telecommunication management; Fault Management; Part 6: Alarm Integration Reference Point (IRP): Solution Set (SS) definitions".
96
+ - [8] 3GPP TS 32.121: "Telecommunication management; Advanced Alarm Management (AAM) Integration Reference Point (IRP): Requirements".
97
+ - [9] 3GPP TS 32.122: "Telecommunication management; Advanced Alarm Management (AAM) Integration Reference Point (IRP): Information Service (IS)".
98
+ - [10] 3GPP TS 32.126: "Telecommunication management; Advanced Alarm Management (AAM) Integration Reference Point (IRP); Solution Set (SS) definitions".
99
+ - [11] 3GPP TS 32.140: "Telecommunication management; Subscription Management (SuM) requirements".
100
+ - [12] 3GPP TS 32.141: "Telecommunication management; Subscription Management (SuM) architecture".
101
+ - [13] 3GPP TS 32.151: "Telecommunication management; Integration Reference Point (IRP) Information Service (IS) template".
102
+ - [14] 3GPP TS 32.152: "Telecommunication management; Integration Reference Point (IRP) Information Service (IS) Unified Modelling Language (UML) repertoire".
103
+
104
+ - [15] 3GPP TS 32.153: "Telecommunication management; Integration Reference Point (IRP) technology specific templates, rules and guidelines".
105
+ - [16] 3GPP TS 32.154: "Telecommunication management; Backward and Forward Compatibility (BFC); Concept and definitions".
106
+ - [17] 3GPP TS 32.155: "Telecommunication management; Requirements template".
107
+ - [18] 3GPP TS 32.171: "Telecommunication management; Subscription Management (SuM) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements".
108
+ - [19] 3GPP TS 32.172: "Telecommunication management; Subscription Management (SuM) Network Resource Model (NRM) Integration Reference Point (IRP): Information Service (IS)".
109
+ - [20] 3GPP TS 32.176: "Telecommunication management; Subscription Management (SuM) Network Resource Model (NRM) Integration Reference Point (IRP); Common Object Request Broker Architecture (CORBA) Solution Set (SS) definitions".
110
+ - [21] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects".
111
+ - [22] 3GPP TS 32.301: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP); Requirements".
112
+ - [23] 3GPP TS 32.302: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP); Information Service (IS)".
113
+ - [24] 3GPP TS 32.306: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP): Solution Set (SS) definitions".
114
+ - [25] 3GPP TS 32.311: "Telecommunication management; Generic Integration Reference Point (IRP) management; Requirements".
115
+ - [26] 3GPP TS 32.312: "Telecommunication management; Generic Integration Reference Point (IRP) management; Information Service (IS)".
116
+ - [27] 3GPP TS 32.316: "Telecommunication management; Generic Integration Reference Point (IRP) management; Solution Set (SS) definitions".
117
+ - [28] 3GPP TS 32.321: "Telecommunication management; Test management Integration Reference Point (IRP); Requirements".
118
+ - [29] 3GPP TS 32.322: "Telecommunication management; Test management Integration Reference Point (IRP); Information Service (IS) ".
119
+ - [30] 3GPP TS 32.326: "Telecommunication management; Test management Integration Reference Point (IRP): Solution Set (SS) definitions".
120
+ - [31] 3GPP TS 32.331: "Telecommunication management; Notification Log (NL) Integration Reference Point (IRP); Requirements",
121
+ - [32] 3GPP TS 32.332: "Telecommunication management; Notification Log (NL) Integration Reference Point (IRP); Information Service (IS)".
122
+ - [33] 3GPP TS 32.336: "Telecommunication management; Notification Log (NL) Integration Reference Point (IRP): Solution Set (SS) definitions".
123
+ - [34] 3GPP TS 32.341: "Telecommunication management; File Transfer (FT) Integration Reference Point (IRP); Requirements".
124
+ - [35] 3GPP TS 32.342: "Telecommunication management; File Transfer (FT) Integration Reference Point (IRP); Information Service (IS)".
125
+ - [36] 3GPP TS 32.346: "Telecommunication management; File Transfer (FT) Integration ReferencePoint (IRP): Solution Set (SS) definitions".
126
+
127
+ - [37] 3GPP TS 32.351: "Telecommunication management; Communication Surveillance (CS) Integration Reference Point (IRP); Requirements".
128
+ - [38] 3GPP TS 32.352: "Telecommunication management; Communication Surveillance (CS) Integration Reference Point (IRP); Information Service (IS)".
129
+ - [39] 3GPP TS 32.356: "Telecommunication management; Communication Surveillance (CS) Integration Reference Point (IRP); Solution Set (SS) definitions".
130
+ - [40] 3GPP TS 32.361: "Telecommunication management; Entry Point (EP) Integration Reference Point (IRP); Requirements".
131
+ - [41] 3GPP TS 32.362: "Telecommunication management; Entry Point (EP) Integration Reference Point (IRP); Information Service (IS)".
132
+ - [42] 3GPP TS 32.366: "Telecommunication management; Entry Point (EP) Integration Reference Point (IRP); Solution Set (SS) definitions".
133
+ - [43] 3GPP TS 32.381: "Telecommunication management; Partial Suspension of Itf-N Integration Reference Point (IRP); Requirements".
134
+ - [44] 3GPP TS 32.382: "Telecommunication management; Partial Suspension of Itf-N Integration Reference Point (IRP); Information Service (IS)".
135
+ - [45] 3GPP TS 32.386: "Telecommunication management; Partial Suspension of Itf-N Integration Reference Point (IRP); Solution Set (SS) definitions".
136
+ - [46] 3GPP TS 32.391: "Telecommunication management; Delta synchronization Integration Reference Point (IRP); Requirements".
137
+ - [47] 3GPP TS 32.392: "Telecommunication management; Delta synchronization Integration Reference Point (IRP); Information Service (IS)".
138
+ - [48] 3GPP TS 32.396: "Telecommunication management; Delta synchronization Integration Reference Point (IRP); Solution Set (SS) definitions".
139
+ - [49] 3GPP TS 32.401: "Telecommunication management; Performance Management (PM); Concept and requirements".
140
+ - [50] 3GPP TS 32.405: "Telecommunication management; Performance Management (PM); Performance measurements; Universal Terrestrial Radio Access Network (UTRAN)".
141
+ - [51] 3GPP TS 32.406: "Telecommunication management; Performance Management (PM); Performance measurements; Core Network (CN) Packet Switched (PS) domain".
142
+ - [52] 3GPP TS 32.407: "Telecommunication management; Performance Management (PM); Performance measurements; Core Network (CN) Circuit Switched (CS) domain; UMTS and combined UMTS/GSM".
143
+ - [53] 3GPP TS 32.408: "Telecommunication management; Performance Management (PM); Performance measurements; Teleservice".
144
+ - [54] 3GPP TS 32.409: "Telecommunication management; Performance Management (PM); Performance measurements; IP Multimedia Subsystem (IMS)".
145
+ - [55] 3GPP TS 32.410: "Telecommunication management; Key Performance Indicators (KPI) for UMTS and GSM".
146
+ - [56] 3GPP TS 32.411: "Telecommunication management; Performance Management (PM) Integration Reference Point (IRP); Requirements".
147
+ - [57] 3GPP TS 32.412: "Telecommunication management; Performance Management (PM) Integration Reference Point (IRP); Information Service (IS)".
148
+ - [58] 3GPP TS 32.416: "Telecommunication management; Performance Management (PM) Integration Reference Point (IRP); Solution Set (SS) definitions".
149
+
150
+ - [59] 3GPP TS 32.421: "Telecommunication management; Subscriber and equipment trace; Trace concepts and requirements".
151
+ - [60] 3GPP TS 32.422: "Telecommunication management; Subscriber and equipment trace; Trace control and configuration management".
152
+ - [61] 3GPP TS 32.423: "Telecommunication management; Subscriber and equipment trace; Trace data definition and management
153
+ - [62] 3GPP TS 32.425: "Telecommunication management; Performance Management (PM); Performance measurements Evolved Universal Terrestrial Radio Access Network (E-UTRAN)".
154
+ - [63] 3GPP TS 32.426: "Telecommunication management; Performance Management (PM); Performance measurements Evolved Packet Core (EPC) network".
155
+ - [64] 3GPP TS 32.432: "Telecommunication management; Performance measurement: File format definition".
156
+ - [65] 3GPP TS 32.435: "Telecommunication management; Performance measurement; eXtensible Markup Language (XML) file format definition".
157
+ - [66] 3GPP TS 32.436: "Telecommunication management; Performance measurement: Abstract Syntax Notation 1 (ASN.1) file format definition".
158
+ - [67] 3GPP TS 32.441: "Telecommunication management; Trace Management Integration Reference Point (IRP); Requirements".
159
+ - [68] 3GPP TS 32.442: "Telecommunication management; Trace Management Integration Reference Point (IRP); Information Service (IS)".
160
+ - [69] 3GPP TS 32.446: "Telecommunication management; Trace Management Integration Reference Point (IRP); Solution Set (SS) definitions".
161
+ - [70] 3GPP TS 32.451: "Telecommunication management; Key Performance Indicators (KPI) for Evolved Universal Terrestrial Radio Access Network (E-UTRAN); Requirements".
162
+ - [71] 3GPP TS 32.452: "Telecommunication management; Performance Management (PM); Performance measurements Home Node B (HNB) Subsystem (HNS)".
163
+ - [72] 3GPP TS 32.453: "Telecommunication management; Performance Management (PM); Performance measurements Home enhanced Node B (HeNB) Subsystem (HeNS)".
164
+ - [73] 3GPP TS 32.454: "Telecommunication management; Key Performance Indicators (KPI) for the IP Multimedia Subsystem (IMS); Definitions".
165
+ - [74] 3GPP TS 32.455: "Telecommunication management; Key Performance Indicators (KPI) for the Evolved Packet Core (EPC); Definitions".
166
+ - [75] 3GPP TS 32.500: "Telecommunication management; Self-Organizing Networks (SON); Concepts and requirements".
167
+ - [76] 3GPP TS 32.501: "Telecommunication management; Self-configuration of network elements; Concepts and requirements".
168
+ - [77] 3GPP TS 32.502: "Telecommunication management; Self-configuration of network elements Integration Reference Point (IRP); Information Service (IS)".
169
+ - [78] 3GPP TS 32.506: "Telecommunication management; Self-configuration of network elements Integration Reference Point (IRP); Solution Set (SS) definitions".
170
+ - [79] 3GPP TS 32.511: "Telecommunication management; Automatic Neighbour Relation (ANR) management; Concepts and requirements".
171
+ - [80] 3GPP TS 32.521: "Telecommunication management; Self-Organizing Networks (SON) Policy Network Resource Model (NRM) Integration Reference Point (IRP); Requirements".
172
+
173
+ - [81] 3GPP TS 32.522: "Telecommunication management; Self-Organizing Networks (SON) Policy Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)".
174
+ - [82] 3GPP TS 32.526: "Telecommunication management; Self-Organizing Networks (SON); Policy Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions".
175
+ - [83] 3GPP TS 32.531: "Telecommunication management; Software management (SwM); Concepts and Integration Reference Point (IRP) Requirements".
176
+ - [84] 3GPP TS 32.532: "Telecommunication management; Software management (SwM); Integration Reference Point (IRP); Information Service (IS)".
177
+ - [85] 3GPP TS 32.536: "Telecommunication management; Software management Integration Reference Point (IRP); Solution Set (SS) definitions".
178
+ - [86] 3GPP TS 32.541: "Telecommunication management; Self-Organizing Networks (SON); Self-healing concepts and requirements".
179
+ - [87] 3GPP TS 32.551: "Telecommunication management; Energy Saving Management (ESM); Concepts and requirements".
180
+ - [88] 3GPP TS 32.600: "Telecommunication management; Configuration Management (CM); Concept and high-level requirements".
181
+ - [89] 3GPP TS 32.601: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP); Requirements".
182
+ - [90] 3GPP TS 32.602: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP); Information Service (IS)".
183
+ - [91] 3GPP TS 32.606: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP); Solution Set (SS) definitions".
184
+ - [92] 3GPP TS 32.611: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP); Requirements".
185
+ - [93] 3GPP TS 32.612: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP); Information Service (IS)".
186
+ - [94] 3GPP TS 32.616: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP); Solution Set (SS) definitions".
187
+ - [95] 3GPP TS 32.621: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Requirements".
188
+ - [96] 3GPP TS 32.622: "Telecommunication management; Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)".
189
+ - [97] 3GPP TS 32.626: "Telecommunication management; State management data definition Integration Reference Point (IRP); Solution Set (SS) definitions".
190
+ - [98] 3GPP TS 32.631: "Telecommunication management; Configuration Management (CM); Core network resources Integration Reference Point (IRP); Requirements".
191
+ - [99] 3GPP TS 32.632: "Telecommunication management; Configuration Management (CM); Core Network Resources Integration Reference Point (IRP); Network Resource Model (NRM)".
192
+ - [100] 3GPP TS 32.636: "Telecommunication management; Configuration Management (CM); Core network resources Integration Reference Point (IRP); Solution Set (SS) Definitions".
193
+ - [101] 3GPP TS 32.641: "Telecommunication management; Configuration Management (CM); UTRAN network resources Integration Reference Point (IRP); Requirements".
194
+ - [102] 3GPP TS 32.642: "Telecommunication management; Configuration Management (CM); UTRAN network resources Integration Reference Point (IRP); Network Resource Model (NRM)".
195
+
196
+ - [103] 3GPP TS 32.646: "Telecommunication management; Configuration Management (CM); UTRAN network resources Integration Reference Point (IRP); Solution Set (SS) definitions".
197
+ - [104] 3GPP TS 32.651: "Telecommunication management; Configuration Management (CM); GERAN network resources Integration Reference Point (IRP); Requirements".
198
+ - [105] 3GPP TS 32.652: "Telecommunication management; Configuration Management (CM); GERAN network resources Integration Reference Point (IRP); Network Resource Model (NRM)".
199
+ - [106] 3GPP TS 32.656: "Telecommunication management; Configuration Management (CM); GERAN network resources Integration Reference Point (IRP); Solution Set (SS) definitions".
200
+ - [107] 3GPP TS 32.661: "Telecommunication management; Configuration Management (CM); Kernel CM Requirements".
201
+ - [108] 3GPP TS 32.662: "Telecommunication management; Configuration Management (CM); Kernel CM Information Service (IS)".
202
+ - [109] 3GPP TS 32.671: "Telecommunication management; Configuration Management (CM); State Management Integration Reference Point (IRP); Requirements".
203
+ - [110] 3GPP TS 32.672: "Telecommunication management; Configuration Management (CM); State Management Integration Reference Point (IRP); Information Service (IS)".
204
+ - [111] 3GPP TS 32.673: "Telecommunication management; Configuration Management (CM); State Management Integration Reference Point (IRP); Common Object Request Broker Architecture (CORBA) Solution Set (SS)".
205
+ - [112] 3GPP TS 32.690: "Telecommunication management; Inventory Management (IM); Requirements".
206
+ - [113] 3GPP TS 32.691: "Telecommunication management; Inventory Management (IM) network resources Integration Reference Point (IRP); Requirements".
207
+ - [114] 3GPP TS 32.692: "Telecommunication management; Inventory Management (IM) network resources Integration Reference Point (IRP); Network Resource Model (NRM)".
208
+ - [115] 3GPP TS 32.696: "Telecommunication management; Inventory Management (IM) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions".
209
+ - [116] 3GPP TS 32.711: "Telecommunication management; Configuration Management (CM); Transport Network (TN) interface Network Resource Model (NRM) Integration Reference Point (IRP); Requirements".
210
+ - [117] 3GPP TS 32.712: "Telecommunication management; Configuration Management (CM); Transport Network (TN) interface Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)".
211
+ - [118] 3GPP TS 32.716: "Telecommunication management; Configuration Management (CM); Transport Network (TN) interface Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions".
212
+ - [119] 3GPP TS 32.721: "Telecommunication management; Configuration Management (CM); Repeater network resources Integration Reference Point (IRP); Requirements".
213
+ - [120] 3GPP TS 32.722: "Telecommunication management; Configuration Management (CM); Repeater network resources Integration Reference Point (IRP); information Service (IS)".
214
+ - [121] 3GPP TS 32.726: "Telecommunication management; Configuration Management (CM); Repeater network resources Integration Reference Point (IRP); Solution Set (SS) definitions".
215
+ - [122] 3GPP TS 32.731: "Telecommunication management; IP Multimedia Subsystem (IMS) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements".
216
+ - [123] 3GPP TS 32.732: "Telecommunication management; IP Multimedia Subsystem (IMS) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)".
217
+
218
+ - [124] 3GPP TS 32.736: "Telecommunication management; IP Multimedia Subsystem (IMS) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions".
219
+ - [125] 3GPP TS 32.741: "Telecommunication management; Configuration Management (CM); Signalling Transport Network (STN) interface Network Resource Model (NRM) IntegrationReference Point (IRP); Requirements".
220
+ - [126] 3GPP TS 32.742: "Telecommunication management; Configuration Management (CM); Signalling Transport Network (STN) interface Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)".
221
+ - [127] 3GPP TS 32.746: "Telecommunication management; Configuration Management (CM); Signalling Transport Network (STN) interface Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions".
222
+ - [128] 3GPP TS 32.751: "Telecommunication management; Evolved Packet Core (EPC) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements".
223
+ - [129] 3GPP TS 32.752: "Telecommunication management; Evolved Packet Core (EPC) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)".
224
+ - [130] 3GPP TS 32.756: "Telecommunication management; Evolved Packet Core (EPC) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) Definitions".
225
+ - [131] 3GPP TS 32.761: "Telecommunication management; Evolved Universal Terrestrial Radio Access Network (E-UTRAN) Network Resource Model (NRM) Integration Reference Point (IRP); Requirements".
226
+ - [132] 3GPP TS 32.762: "Telecommunication management; Evolved Universal Terrestrial Radio Access Network (E-UTRAN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)".
227
+ - [133] 3GPP TS 32.766: "Telecommunication management; Evolved Universal Terrestrial RadioAccess Network (E-UTRAN) Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions".
228
+ - [134] 3GPP TS 32.771: "Telecommunication management; Home Node B (HNB) Subsystem (HNS); Network Resource Model (NRM); Integration Reference Point (IRP); Requirements".
229
+ - [135] 3GPP TS 32.772: "Telecommunication management; Home Node B (HNB) Subsystem (HNS); Network Resource Model (NRM); Integration Reference Point (IRP); Information Service (IS)".
230
+ - [136] 3GPP TS 32.776: "Telecommunication management; Home Node B (HNB) Subsystem (HNS); Network Resource Model (NRM); Integration Reference Point (IRP); Solution Set (SS) definitions".
231
+ - [137] 3GPP TS 32.781: "Telecommunication management; Home enhanced Node B (HeNB) Subsystem (HeNS); Network Resource Model (NRM); Integration Reference Point (IRP); Requirements".
232
+ - [138] 3GPP TS 32.782: "Telecommunication management; Home enhanced Node B (HeNB) Subsystem (HeNS); Network Resource Model (NRM); Integration Reference Point (IRP); Information Service (IS)".
233
+ - [139] 3GPP TS 32.786: "Telecommunication management; Home enhanced Node B (HeNB) Subsystem (HeNS); Network Resource Model (NRM); Integration Reference Point (IRP); Solution Set (SS) definitions".
234
+ - [140] 3GPP TS 32.402: "Telecommunication management; Performance Management (PM); Performance measurements – GSM".
235
+ - [141] 3GPP TS 32.181: "Telecommunication management; User Data Convergence (UDC); Framework for Model Handling and Management".
236
+ - [142] 3GPP TS 32.182: "Telecommunication management; User Data Convergence (UDC); Common baseline information model (CBIM)".
237
+
238
+ # --- 3 Definitions and abbreviations
239
+
240
+ ## 3.1 Definitions
241
+
242
+ For the purposes of the present document, the terms and definitions given in TR 21.905 [1], TS 32.150 [2].
243
+
244
+ ## 3.2 Abbreviations
245
+
246
+ For the purposes of the present document, the abbreviations given in TR 21.905 [1] apply.
247
+
248
+ # 4 IRP Framework
249
+
250
+ ## 4.1 Introduction
251
+
252
+ For the purpose of management interface development 3GPP has developed an interface concept known as Integration Reference Point (IRP) to promote the wider adoption of standardized management interfaces in telecommunication networks. The IRP concept and associated methodology employs model-driven development, protocol and technology neutral modelling methods as well as protocol specific solution sets to achieve its goals.
253
+
254
+ IRP Framework and Methodology related 3GPP specifications:
255
+
256
+ - 32.150 [2]: Integration Reference Point (IRP) Concept and definitions
257
+ - 32.151 [13]: IRP Information Service (IS) template
258
+ - 32.152 [14]: IRP IS Unified Modeling Language (UML) repertoire
259
+ - 32.153 [15]: IRP technology specific templates, rules and guidelines
260
+ - 32.154 [16]: Backward and Forward Compatibility Concept and definitions
261
+ - 32.155[17]: Requirements template
262
+
263
+ ## 4.2 IRP Framework Highlights
264
+
265
+ ### 4.2.1 IRP Concept
266
+
267
+ IRP specifications are specified using a 3-level approach: Requirements, IS-level and SS-level.
268
+
269
+ ![Diagram of the IRP 3-Level Specifications Approach](704082cc3e11776bda29595c76411362_img.jpg)
270
+
271
+ The diagram illustrates the IRP 3-Level Specifications Approach, showing three levels of specifications and their relationship to three IRP categories.
272
+
273
+ **Level 1: Requirements / Use Cases** (Top level, green background). It contains three categories: **Interface IRP's**, **NRM IRP's**, and **Data Definition IRP's**. A blue arrow points to this level with the text "Relative stable over long period of time".
274
+
275
+ **Level 2: Information Service Definitions (UML)** (Middle level, green background). It contains three categories: **Interface IRP's**, **NRM IRP's**, and **Data Definition IRP's**. A blue arrow points to this level with the text "Changes only with respect to addition and extensions".
276
+
277
+ **Level 3: Solution Set Definitions (CORBA, SOAP, XML, CMIP)** (Bottom level, green background). It contains three categories: **Interface IRP's**, **NRM IRP's**, and **Data Definition IRP's**. A blue arrow points to this level with the text "Changes with new/better Technologies".
278
+
279
+ **Information Service Definitions (UML) details:**
280
+
281
+ - Interface IRP's:** Notification IRP, Alarm IRP, BulkCM IRP, KernelCM IRP, BasicCM IRP, etc.
282
+ - NRM IRP's:** Generic NRM, CoreNW NRM, UMTS NRM's, CDMA NRM's, Inventory NRM, etc.
283
+ - Data Definition IRP's:** State Mgmt IRP, etc.
284
+
285
+ **Solution Set Definitions (other/future e.g. JAVA, SNMP)** (Bottom-most level, green background).
286
+
287
+ Diagram of the IRP 3-Level Specifications Approach
288
+
289
+ Figure 4.2-1: The IRP 3-Level Specifications Approach combined with the three IRP categories [2].
290
+
291
+ #### Requirements-level:
292
+
293
+ The "Requirements-level" intends to provide conceptual and use cases definitions for a specific management interface aspect as well as defining subsequent requirements for this IRP.
294
+
295
+ #### IS-level:
296
+
297
+ - The "IS-level" provides the technology independent specification of an IRP.
298
+
299
+ #### SS-level:
300
+
301
+ The "SS-level" finally provides the mapping of IS definitions into one or more technology-specific Solution Sets. This concept provides support for multiple interface technologies as applicable on a vendor and/or network type basis and also enables accommodation of future interface technologies - without the need to redefine requirements and IS-level definitions.
302
+
303
+ ### 4.2.2 Interface IRP vs. NRM IRP
304
+
305
+ There are three categories of IRP specifications:
306
+
307
+ - Interface IRPs
308
+ - NRM IRPs
309
+ - Data Definition IRPs
310
+
311
+ Each category is partitioned into Requirements, IS-level and SS-level specifications.
312
+
313
+ ![Diagram illustrating the relationship between Interface IRP and NRM IRP. At the top, a yellow oval labeled 'Network Management' contains icons of a person at a computer, a laptop, and a server. Below it, a central 'Itf-N' interface is shown. To the left, a blue oval labeled 'NRM IRP's' (Defining WHAT can be managed (Object Models)) points to an 'EMS' box, which is connected to a 'Core/IM NW' oval containing server icons. To the right, a green oval labeled 'Interface IRP's' (Defining HOW Information is shared (Operations & Notifications)) points to the 'Itf-N' interface. Below the 'Itf-N' interface, another 'EMS' box is connected to a 'Radio Access NW' oval containing a radio tower icon. Further right, a third 'EMS' box is connected to a 'User Equipment' oval containing mobile device icons. A dashed green line connects the 'Itf-N' interface to the third 'EMS' box. A third blue oval labeled 'NRM IRP's' points to this third 'EMS' box.](e4c6fa93821e3546ee9fcae897ae2771_img.jpg)
314
+
315
+ Diagram illustrating the relationship between Interface IRP and NRM IRP. At the top, a yellow oval labeled 'Network Management' contains icons of a person at a computer, a laptop, and a server. Below it, a central 'Itf-N' interface is shown. To the left, a blue oval labeled 'NRM IRP's' (Defining WHAT can be managed (Object Models)) points to an 'EMS' box, which is connected to a 'Core/IM NW' oval containing server icons. To the right, a green oval labeled 'Interface IRP's' (Defining HOW Information is shared (Operations & Notifications)) points to the 'Itf-N' interface. Below the 'Itf-N' interface, another 'EMS' box is connected to a 'Radio Access NW' oval containing a radio tower icon. Further right, a third 'EMS' box is connected to a 'User Equipment' oval containing mobile device icons. A dashed green line connects the 'Itf-N' interface to the third 'EMS' box. A third blue oval labeled 'NRM IRP's' points to this third 'EMS' box.
316
+
317
+ Figure 4.2-2: Relationship Interface IRP vs NRM IRP
318
+
319
+ ### 4.2.3 IRP Development Principles
320
+
321
+ **NRM IRP Extensibility** - Enabling Technology, Organizational & Vendor-specific NRM extensions via
322
+
323
+ - Rule-based NRM Extensions (e.g. Sub-classing)
324
+ - vsDataContainer
325
+
326
+ **Interface IRP Flexibility** - Enabling: wide applicability, phased introduction capabilities & broad industry adoption (not just for wireless) via
327
+
328
+ - Flexible use of qualifiers "mandatory", "optional", "conditional" for operation, notifications and/or parameters
329
+ - NRM/Technology-neutrality & avoiding competing procedures
330
+
331
+ ### 4.2.4 IRP Specification Structure
332
+
333
+ All IRP's follow a uniform specification structure:
334
+
335
+ - xx1: xyz IRP Requirements
336
+ - xx2: xyz IRP IS
337
+ - xx3: xyz IRP CORBA SS (*merged into xx6 after R9*)
338
+ - xx4: xyz IRP CMIP SS (*retired after R6*)
339
+ - xx5: xyz IRP XML Definitions (*applicable for NRM's & notification emitting IRP's - merged into xx6 after R9*)
340
+ - xx6: xyz IRP SS (since R10, containing all technology specific Solution Set definitions)
341
+ - xx7: xyz IRP SOAP SS (*merged into xx6 after R9*)
342
+
343
+ ### 4.2.5 Essential IRP Definitions [2]
344
+
345
+ **Data Definition IRP:** 3GPP publishes IRP specifications relating to commonly used data definitions that can be imported for use by Interface IRP and/or NRM IRP. This term represents all such specifications. An example of a Data Definition IRP is the State Management IRP (32.671 [109], 32.672 [110], 32.673 [111], etc).
346
+
347
+ **Integration Reference Point (IRP):** An architectural concept that is described by a set of specifications for definition of a certain aspect of a management interface, comprising a **Requirements** specification, an **Information Service** specification, and one or more **Solution Set** specifications.
348
+
349
+ **Interface IRP:** 3GPP publishes a number of IRP specifications each of which is related to a set of operations and notifications for a specific telecom management domain such as alarm management, configuration management, etc. Interface IRPs also contain definitions of Support IOCs. This term represents all such specifications. An example of an Interface IRP is the Basic CM IRP (the set of TSs 32.601 [894], 32.602 [90], 32.606 [91], etc.).
350
+
351
+ **IRP Agent:** Encapsulates a well-defined subset of network (element) functions. It interacts with IRPManagers using one or more IRPs. From the IRPManager's perspective, the IRP Agent behaviour is only visible via the IRP(s).
352
+
353
+ **Information Service (IS):** an IRP Information Service describes the information related to the entities (either network resources or support objects) to be managed and the way that the information may be managed for a certain functional area (e.g. the Alarm IRP Information Service in the fault management area). Information Services are defined for all IRPs.
354
+
355
+ **IRP Manager:** Models a user of IRP Agent(s) and it interacts directly with the IRP Agent(s) using IRP(s). Since the IRP Manager represents an IRP Agent user, it gives a clear picture of what the IRP Agent is supposed to do. From the IRP Agent perspective, the IRP Manager behaviour is only visible via the IRP.
356
+
357
+ **Network Resource Model (NRM):** An Information Service describing Information Object Classes representing the manageable aspects of network resources, e.g. an RNC or NodeB.
358
+
359
+ **NRM IRP:** 3GPP publishes a number of IRP specifications each of which is related to a particular NRM (Network Resource Model) as defined in 3GPP TS 32.101 [3]. NRM IRPs do not define any operations or notifications. This term represents all such specifications. Note: In some NRM IRP titles, for historic reasons, they are named "...network resources IRP"). An example of an NRM IRP is the Generic NRM IRP (32.621 [95], 32.622 [96], 32.623 [97], etc.).
360
+
361
+ **Solution Set (SS):** contains a mapping of the IRP Information Service (IS) defined entities (that are technology-agnostic) to technology specific termed entities. It does not contain specification of the entities' semantics. The semantics can be found in the corresponding IS. It is noted that one IS can be mapped to one or several SSs.
362
+
363
+ ## 4.3 IRP related High-level Requirements & Architecture Specifications
364
+
365
+ The IRP Framework has been developed in response to management requirements documented in the following specifications:
366
+
367
+ - 32.101 [3]: Principles and high level requirements
368
+ - 32.102[4]: Architecture
369
+ - 32.111-1 [5]: 3G fault management requirements
370
+ - 32.140 [11], 32.141 [12]: SuM requirements / SuM architecture
371
+ - 32.300 [21]: Name convention for Managed Objects
372
+ - 32.401[49]: PM Concept and requirements
373
+ - 32.500 [75]: SON Concepts and requirements
374
+ - 32.511 [79]: ANR management Concepts and requirements
375
+ - 32.521 [80]: Self-optimization Concepts and requirements
376
+ - 32.541 [86]: Self-healing Concepts and requirements
377
+ - 32.551 [87]: Energy Saving Management (ESM) Concepts and requirements
378
+ - 32.600 [88]: CM Concept and high-level requirements
379
+
380
+ # 5 Interface IRP's
381
+
382
+ ## 5.1 Interface IRP Overview
383
+
384
+ ![Diagram showing the overview of Interface IRP's in 3GPP R10, categorized into Common, FM-related, CM-related, PM-related, Supporting, and Other IRP's.](9cd90f495b95ad2116ff780248c26d95_img.jpg)
385
+
386
+ ```
387
+ graph TD; Common[Common IF IRP's: Notification IRP (32.30x), Generic IRP (32.31x)]; FM[FM-related IF IRP's: Alarm IRP (32.111-x), AAM IRP (32.12x), Test Mgmt IRP (32.32x)]; CM[CM-related IF IRP's: Basic CM IRP (32.60x), Bulk CM IRP (32.61x), Kernel CM IRP (32.66x), SC IRP (32.50x), SWM IRP (32.53x)]; PM[PM-related IF IRP's: PM IRP (32.41x), Trace Mgmt (32.44x)]; Support[Supporting IF IRP's: NL IRP (32.33x), FT IRP (32.34x), CS IRP (32.35x), EP IRP (32.35x)]; Other[Other IF IRP's: Partial Suspension of Itf-N IRP (32.38x), Delta synchronization (32.39x)];
388
+ ```
389
+
390
+ **Common IF IRP's:**
391
+
392
+ - Notification IRP (32.30x)
393
+ - Generic IRP (32.31x)
394
+
395
+ **FM-related IF IRP's:**
396
+
397
+ - Alarm IRP (32.111-x)
398
+ - AAM IRP (32.12x)
399
+ - Test Mgmt IRP (32.32x)
400
+
401
+ **CM-related IF IRP's:**
402
+
403
+ - Basic CM IRP (32.60x)
404
+ - Bulk CM IRP (32.61x)
405
+ - Kernel CM IRP (32.66x)
406
+ - SC IRP (32.50x)
407
+ - SWM IRP (32.53x)
408
+
409
+ **PM-related IF IRP's:**
410
+
411
+ - PM IRP (32.41x)
412
+ - Trace Mgmt (32.44x)
413
+
414
+ **Supporting IF IRP's:**
415
+
416
+ - NL IRP (32.33x)
417
+ - FT IRP (32.34x)
418
+ - CS IRP (32.35x)
419
+ - EP IRP (32.35x)
420
+
421
+ **Other IF IRP's:**
422
+
423
+ - Partial Suspension of Itf-N IRP (32.38x)
424
+ - Delta synchronization (32.39x)
425
+
426
+ Diagram showing the overview of Interface IRP's in 3GPP R10, categorized into Common, FM-related, CM-related, PM-related, Supporting, and Other IRP's.
427
+
428
+ Figure 5.1-1: Interface IRP's 3GPP R10
429
+
430
+ ## 5.2 Generic/Common Interface IRP's
431
+
432
+ **Notification IRP – 32.300 [21], 32.301[22], 32.302[23], 32.306[24]**
433
+
434
+ The purpose of the Notification IRP is to define an interface through which an IRPManager can subscribe to an IRPAgent for receiving notifications, manage these subscriptions, and optionally set filters.
435
+
436
+ **Generic IRP – 32.311 [25], 32.312 [26], 32.316 [27]**
437
+
438
+ This IRP defines common services supported by all IRPs such as AlarmIRP. With this common service supported by all IRPs, an IRPManager can retrieve the profile of operations and notifications supported by a given IRP name-contained by an IRPAgent. An IRPManager can also retrieve the IRPVersions supported by a given IRP.
439
+
440
+ ## 5.3 FM related Interface IRP's
441
+
442
+ ### **Alarm IRP – 32.111-1 [5], 32.111-2 [6], 32.111-6[7]**
443
+
444
+ The Alarm (IRP) addresses the alarm surveillance aspects of Fault Management (FM), applied to Itf-N. It defines alarm semantics & syntax as well as alarm management related operations and notifications.
445
+
446
+ ### **Advanced Alarm Management IRP – 32.121 [8], 32.122 [9], 32.126 [10]**
447
+
448
+ The purpose of Advanced Alarm Management (AAM) IRP is to define an interface through which an IRPManager can categorize alarm notifications. It defines, for the purpose of categorizing alarm notifications, the information observable and controlled by management system's client and it also specifies the semantics of the interactions used to carry this information.
449
+
450
+ ### **Test management IRP – 32.321 [28], 32.322 [29], 32.326[30]**
451
+
452
+ The purpose of the Test management IRP is to define an interface through which an IRPManager can manage and monitor tests in NE's, as well as methods to receive test results.
453
+
454
+ ## 5.4 CM related Interface IRP's
455
+
456
+ ### **Self-Configuration IRP – 32.500 [75], 32.501 [76], 32.502 [77], 32.506 [78]**
457
+
458
+ The Self-Configuration provides methods to allow automatic configuration of eNBs, which are brought newly into a network.
459
+
460
+ ### **Software Management IRP – 32.531 [83], 32.532 [84], 32.536 [85]**
461
+
462
+ The Software Management IRP provides an IRPManager with capabilities to automate software management via Itf-N.
463
+
464
+ ### **Basic CM IRP – 32.600 [88], 32.601[89], 32.602 [90], 32.606 [91]**
465
+
466
+ Using this IRP, an IRPAgent can communicate basic Configuration Management related information to one or several IRPManagers. The function of this Basic CM IRP Information Service is to define an interface for the retrieval and modification of Configuration Management Information.
467
+
468
+ ### **Bulk CM IRP – 32.611 [92], 32.612 [93], 32.616 [94]**
469
+
470
+ Using the Bulk CM IRP an IRPAgent can communicate CM related information to one or several IRPManagers using bulk data transfer methods.
471
+
472
+ - BulkCM SimpleUpload, enabling upload of resource information by the IRPManager without explicit session control
473
+ - BulkCM Controlled Upload, enabling a session controlled upload of resource information by the IRPManager
474
+ - BulkCM Controlled Upload & Provisioning, enabling a session controlled upload and provisioning of resource information by the IRPManager
475
+
476
+ ### **Kernel CM IRP – 32.661 [107], 32.662 [108]**
477
+
478
+ The function of this Kernel CM IRP Information Service is to define an interface that provides essential CM notification services. While it is not expected that the Kernel CM IRP alone will provide adequate CM capabilities, the Kernel CM IRP is expected to provide the common supporting CM notifications required for other CM IRPs such as the Basic CM IRP or the Bulk CM IRP, each of which require the Kernel CM IRP.
479
+
480
+ ## 5.5 PM & Trace related Interface IRP's
481
+
482
+ ### **Performance Management IRP – 32.410 [55], 32.411[56], 32.412 [57], 32.416 [58]**
483
+
484
+ The Performance Management IRP is defines an interface through which an IRPManager can manage measurement jobs as well threshold values.
485
+
486
+ ### **Trace Management IRP – 32.441 [67], 32.442 [68], 32.446 [69]**
487
+
488
+ The Trace Management IRP is defines an interface through which an IRPManager can activate and manage equipment and subscriber trace jobs.
489
+
490
+ ## 5.6 Special-purpose related Interface IRP's
491
+
492
+ ### **Notification Log IRP – 32.331[31], 32.332[32], 32.336[33]**
493
+
494
+ The purpose of the Notification Log IRP is to define an interface through which an IRPManager can manage a Notification Log, as well as methods for retrieval of logged notifications.
495
+
496
+ ### **File Transfer IRP – 32.341[34], 32.342[35], 32.346[36]**
497
+
498
+ The purpose of the File Transfer IRP is to define a generic tools set supporting the management of file transfers between IRPManager and IRPAgent. Currently the following management data types are supported by this IRP:
499
+
500
+ - performance data files
501
+ - configuration & inventory files
502
+ - test result files
503
+ - call trace files
504
+ - notification log files
505
+ - charging files
506
+
507
+ ### **Communication Surveillance IRP – 32.351 [37], 32.352 [38], 32.356[39]**
508
+
509
+ The purpose of the Communication Surveillance IRP is to provide an IRPManager with the capability to monitor the health of the communications link towards an IRPAgent.
510
+
511
+ ### **Entry Point IRP – 32.361 [40], 32.362[41], 32.366 [42]**
512
+
513
+ The purpose of the Entry Point IRP is to provide an IRPManager with discovery and entry point capabilities towards an IRPAgent and its supported IRP's.
514
+
515
+ ### **Partial Suspension of Itf-N IRP – 32.381 [43], 32.382 [44], 32.386 [45]**
516
+
517
+ The purpose of Partial Suspension of Itf-N IRP is to define an interface through which an IRPManager can suspend the forwarding of notifications via Itf-N which were generated in parts of the managed systems.
518
+
519
+ ### **Delta synchronization IRP – 32.391 [46], 32.392 [47], 32.396 [48]**
520
+
521
+ The purpose of Delta Synchronization IRP is to define an interface through which an IRPManager can request only those data that have changed (i.e. changed, were created or deleted) from a synchronization point onwards.
522
+
523
+ # 6 NRM IRP's
524
+
525
+ ## 6.1 NRM IRP Overview
526
+
527
+ ![Diagram showing the overview of NRM IRP's in 3GPP R10, categorized into Common, Services related, 3GPP AN, 3GPP Core NW, 3GPP H(e)NS, and Supporting NRM IRP's.](a24e89a6fe9bb70c83f8bf5202baba95_img.jpg)
528
+
529
+ ```
530
+ graph TD; Common[Common NRM IRP's] --- CommonList[Generic NRM IRP (32.62x)]; Services[Services related NRM IRP's] --- ServicesList[SuM NRM IRP (32.17x), UDC CBIM NRM IRP IS (32.182)]; AN[3GPP AN NRM IRP's] --- ANList[UTRAN NRM IRP (32.64x), GERAN NRM IRP (32.65x), E-UTRAN NRM IRP (32.76x)]; Core[3GPP Core NW NRM IRP's] --- CoreList[Core NRM IRP (32.63x), IMS NRM IRP (32.73x), Evolved Packet Core NRM IRP (32.75x)]; HNS[3GPP H(e)NS NRM IRP's] --- HNSList[HNS NRM IRP (32.77x), HeNS NRM IRP (32.78x)]; Supporting[Supporting NRM IRP's] --- SupportingList[Inventory Management NRM IRP (32.69x), Transport Network NRM IRP (32.71x), Repeater NRM IRP (3.72x), Signalling Transport NW IF NRM IRP (32.74x), SON Policy NRM IRP (32.52x)];
531
+ ```
532
+
533
+ **Common NRM IRP's:**
534
+
535
+ - Generic NRM IRP (32.62x)
536
+
537
+ **Services related NRM IRP's:**
538
+
539
+ - SuM NRM IRP (32.17x)
540
+ - *UDC CBIM NRM IRP IS (32.182)*
541
+
542
+ **3GPP AN NRM IRP's:**
543
+
544
+ - UTRAN NRM IRP (32.64x)
545
+ - GERAN NRM IRP (32.65x)
546
+ - E-UTRAN NRM IRP (32.76x)
547
+
548
+ **3GPP Core NW NRM IRP's:**
549
+
550
+ - Core NRM IRP (32.63x)
551
+ - IMS NRM IRP (32.73x)
552
+ - Evolved Packet Core NRM IRP (32.75x)
553
+
554
+ **3GPP H(e)NS NRM IRP's:**
555
+
556
+ - HNS NRM IRP (32.77x)
557
+ - HeNS NRM IRP (32.78x)
558
+
559
+ **Supporting NRM IRP's:**
560
+
561
+ - Inventory Management NRM IRP (32.69x)
562
+ - Transport Network NRM IRP (32.71x)
563
+ - Repeater NRM IRP (3.72x)
564
+ - Signalling Transport NW IF NRM IRP (32.74x)
565
+ - SON Policy NRM IRP (32.52x)
566
+
567
+ Diagram showing the overview of NRM IRP's in 3GPP R10, categorized into Common, Services related, 3GPP AN, 3GPP Core NW, 3GPP H(e)NS, and Supporting NRM IRP's.
568
+
569
+ Figure 6.1-1: NRM IRP's 3GPP R10
570
+
571
+ ## 6.2 Common NRM IRP's
572
+
573
+ Generic NRM IRP – 32.621 [95], 32.622 [96], 32.626 [97]
574
+
575
+ The Generic NRM IRP provides the generic network resources information that can be communicated between an IRP Agent and one or several IRP Managers for network management purposes.
576
+
577
+ ## 6.3 Access Network (AN) related NRM IRP's
578
+
579
+ ### **UTRAN NRM IRP – 32.641 [101] , 32.642 [102], 32.646 [103]**
580
+
581
+ The UTRAN NRM IRP defines an IRP through which an IRP Agent can communicate Configuration Management information to one or several IRP Managers concerning UTRAN specific network resource, by reusing relevant parts of the Generic NRM IRP in 32.621 [95], 32.622 [96], 32.626 [97] series.
582
+
583
+ ### **GERAN NRM IRP – 32.651 [104], 32.652 [105], 32.656 [106]**
584
+
585
+ The GERAN NRM IRP defines an IRP through which an IRP Agent can communicate Configuration Management information to one or several IRP Managers concerning GERAN specific network resource, by reusing relevant parts of the Generic NRM IRP in 32.621 [95], 32.622 [96], 32.626 [97] series.
586
+
587
+ ### **EUTRAN NRM IRP – 32.761 [131], 32.762 [132], 32.766 [133]**
588
+
589
+ The EUTRAN NRM IRP defines an IRP through which an IRP Agent can communicate Configuration Management information to one or several IRP Managers concerning EUTRAN specific network resource, by reusing relevant parts of the Generic NRM IRP in 32.621 [95], 32.622 [96], 32.626 [97] series.
590
+
591
+ ## 6.4 Core/IMS related NRM IRP's
592
+
593
+ ### **Core NRM IRP – 32.631 [98], 32.632 [99], 32.636 [100]**
594
+
595
+ The Core NRM IRP defines an IRP through which an IRP Agent can communicate Configuration Management information to one or several IRP Managers concerning core network specific resource, by reusing relevant parts of the Generic NRM IRP in 32.621 [95], 32.622 [96], 32.626 [97] series.
596
+
597
+ ### **IMS NRM IRP – 32.731 [122], 32.732 [123], 32.736 [124]**
598
+
599
+ The IMS NRM IRP defines an IRP through which an IRP Agent can communicate Configuration Management information to one or several IRP Managers concerning IP MultiMedia Subsystem specific network resource, by reusing relevant parts of the Generic NRM IRP in 32.621 [95], 32.622 [96], 32.626 [97] series.
600
+
601
+ ### **EPC NRM IRP – 32.751 [128], 32.752 [129], 32.756 [130]**
602
+
603
+ The EPC NRM IRP defines an IRP through which an IRP Agent can communicate Configuration Management information to one or several IRP Managers concerning Evolved Packet Core specific network resource, by reusing relevant parts of the Generic NRM IRP in 32.621 [95], 32.622 [96], 32.626 [97] series.
604
+
605
+ ## 6.5 H(e)NB related NRM IRP's
606
+
607
+ ### **HNS NRM IRP – 32.771 [134], 32.772 [135], 32.776 [136]**
608
+
609
+ The HNS NRM IRP defines an IRP through which an IRP Agent can communicate Configuration Management information to one or several IRP Managers concerning Home NodeB Subsystem specific network resource, by reusing relevant parts of the Generic NRM IRP in 32.621 [95], 32.622 [96], 32.626 [97] series.
610
+
611
+ ### **HeNS NRM IRP – 32.781 [137], 32.782 [138], 32.786 [139]**
612
+
613
+ The HeNS NRM IRP defines an IRP through which an IRP Agent can communicate Configuration Management information to one or several IRP Managers concerning Home enhanced NodeB Subsystem specific network resource, by reusing relevant parts of the Generic NRM IRP in 32.621 [95], 32.622 [96], 32.626 [97] series.
614
+
615
+ ## 6.6 Service Management related NRM IRP's and UDC specifications
616
+
617
+ ### **SuM NRM IRP – 32.171 [18], 32.172 [19], 32.176 [20]**
618
+
619
+ Subscription Management is a feature that permits Service Providers, Value Added Service Providers and Mobile Operators to provision services for a specific subscriber. The SuM NRM IRP defines the Subscription Management specific network resource information between an IRP Agent and one or several IRP Managers.
620
+
621
+ ### **UDC – 32.181 [141], 32.182 [142]**
622
+
623
+ User Data Convergence (UDC) presents a layered architecture where user data is accessible at a logically unique repository called User Data Repository (UDR). The UDC CBIM defines a Common Baseline Information Model for UDC, which denotes an abstract, formal representation of entity types that are common to many applications using the UDR.
624
+
625
+ ## 6.7 Special-purpose related NRM IRPs
626
+
627
+ ### **Inventory Management NRM IRP – 32.690 [112], 32.691[113], 32.692 [114], 32.696 [115]**
628
+
629
+ Inventory Management (IM) provides the operator with the ability to assure correct and effective operation of the telecom network as it evolves. IM actions have the objective to monitor the actual configuration on the Network Elements (NEs) and Network Resources (NRs). The Inventory Management NRM IRP defines the inventory specific network resource information between an IRP Agent and one or several IRP Managers.
630
+
631
+ ### **SON Policy NRM IRP – 32.521 [80], 32.522 [81], 32.526 [82]**
632
+
633
+ The SON Policy NRM IRP defines an IRP through which an IRP Agent can communicate Configuration Management information to one or several IRP Managers concerning Self-Organizing Networks Policies. Currently the following SON use cases are supported by this NRM IRP:
634
+
635
+ - SON Self-Optimization Management (requirements determined by TS 32.521[80])
636
+ - SON Self-Healing Management (requirements determined by TS 32.541[86])
637
+ - Energy Saving Management (requirements determined by TS 32.551[87])
638
+
639
+ ### **Transport Network NRM IRP – 32.711 [116], 32.712 [117], 32.716 [118]**
640
+
641
+ The Transport Network NRM IRP defines an IRP through which an IRP Agent can communicate Configuration Management information to one or several IRP Managers concerning Transport resources, by reusing relevant parts of the Generic NRM IRP in 32.621 [95], 32.622 [96], 32.626 [97] series.
642
+
643
+ ### **Repeater NRM IRP – 32.721 [119], 32.722 [120], 32.726 [121]**
644
+
645
+ The Repeater NRM IRP defines an IRP through which an IRP Agent can communicate Configuration Management information to one or several IRP Managers concerning Repeater resources, by reusing relevant parts of the Generic NRM IRP in 32.621 [95], 32.622 [96], 32.626 [97] series.
646
+
647
+ ### **Signalling Transport NW IF NRM IRP – 32.741 [125], 32.742 [126], 32.746 [127]**
648
+
649
+ The Signalling Transport NW IF NRM IRP defines an IRP through which an IRP Agent can communicate Configuration Management information to one or several IRP Managers concerning Signalling Transport resources, by reusing relevant parts of the Generic NRM IRP in 32.621[95], 32.622 [96], 32.626 [97] series.
650
+
651
+ # 7 Measurement & Trace Definitions
652
+
653
+ ## 7.1 Performance Measurements
654
+
655
+ ### 7.1.1 Overview and relationships to IRP Framework
656
+
657
+ ![Diagram showing PM-related Specifications 3GPP R10. It consists of five boxes: 'Requirements and templates' (blue border), 'Core measurement specifications' (yellow border), 'Radio measurement specifications' (yellow border), 'KPI specifications' (yellow border), and 'PM File Format (32.43x)' (yellow border).](2734e7f9be3e1dc046f14be2e6c9a085_img.jpg)
658
+
659
+ **Requirements and templates:**
660
+
661
+ - Concept and requirements (32.401)
662
+ - Definitions and template (32.404)
663
+
664
+ **Core measurement specifications**
665
+
666
+ - CS core (32.407)
667
+ - PS core (32.406)
668
+ - IMS (32.409)
669
+ - EPC (32.426)
670
+ - Services (32.408)
671
+
672
+ **Radio measurement specifications**
673
+
674
+ - GSM (52.402)
675
+ - UTRAN (32.405)
676
+ - E-UTRAN (32.425)
677
+ - HNB (32.452)
678
+ - HeNB (32.453)
679
+
680
+ **KPI specifications**
681
+
682
+ - UMTS and GSM (32.410)
683
+ - E-UTRAN – (32.450/451)
684
+ - IMS (32.454)
685
+ - EPC (32.455)
686
+
687
+ **PM File Format (32.43x)**
688
+
689
+ Diagram showing PM-related Specifications 3GPP R10. It consists of five boxes: 'Requirements and templates' (blue border), 'Core measurement specifications' (yellow border), 'Radio measurement specifications' (yellow border), 'KPI specifications' (yellow border), and 'PM File Format (32.43x)' (yellow border).
690
+
691
+ Figure 7.1.1-1: PM-related Specifications 3GPP R10
692
+
693
+ ### 7.1.2 Performance Measurement Specifications
694
+
695
+ #### **PS core Performance Measurements – 32.406 [51]**
696
+
697
+ The purpose of this specification is to define performance measurements specific to Core Network Packet Switched Domain in a UMTS network or combined UMTS/GSM network. The standardized measurements result in comparability of measurement data produced in a multi-vendor network.
698
+
699
+ #### **CS core Performance Measurements – 32.407 [52]**
700
+
701
+ The purpose of this specification is to define performance measurements specific to Core Network Circuit Switched Domain in a UMTS network or combined UMTS/GSM network. The standardized measurements result in comparability of measurement data produced in a multi-vendor network.
702
+
703
+ #### **Services Performance Measurements – 32.408 [53]**
704
+
705
+ The purpose of this specification is to define performance measurements specific to teleservices(categorized by Multimedia Messaging Service, Short Message Service, Multimedia Calls, Voice Call and Intelligent Services) in a UMTS network or combined UMTS/GSM network, . The standardized measurements result in comparability of measurement data produced in a multi-vendor network.
706
+
707
+ #### **IMS Performance Measurements – 32.409 [54]**
708
+
709
+ The purpose of this specification is to define performance measurements specific to an IMS (IP Multimedia Subsystem) network. The standardized measurements result in comparability of measurement data produced in a multi-vendor network.
710
+
711
+ #### **EPC Performance Measurements – 32.426 [63]**
712
+
713
+ The purpose of this specification is to define performance measurements specific to an EPC network or combined EPC/UMTS/GSM network. The standardized measurements result in comparability of measurement data produced in a multi-vendor network.
714
+
715
+ #### **GSM Performance Measurements – 52.402 [140]**
716
+
717
+ The purpose of this specification is to define performance measurements specific to a GSM system. The standardized measurements result in comparability of measurement data produced in a multi-vendor network.**UTRAN Performance Measurements – 32.405 [50]**
718
+
719
+ The purpose of this specification is to define performance measurements specific to a UTRAN in UMTS network or combined UMTS/GSM network. The standardized measurements result in comparability of measurement data produced in a multi-vendor network.
720
+
721
+ #### **E-UTRAN Performance Measurements – 32.425 [62]**
722
+
723
+ The purpose of this specification is to define performance measurements specific to an E-UTRAN network. The standardized measurements result in comparability of measurement data produced in a multi-vendor network.**HNB Performance Measurements – 32.452 [71]**
724
+
725
+ The purpose of this specification is to define performance measurements specific to Home NodeB Subsystem(consists of HNB and HNB-GW). The standardized measurements result in comparability of measurement data produced in a multi-vendor network.
726
+
727
+ #### **HeNB Performance Measurements – 32.453 [72]**
728
+
729
+ The purpose of this specification is to define performance measurements specific to Home enhanced NodeB Subsystem(consists of HeNB and optionally HeNB-GW). The standardized measurements result in comparability of measurement data produced in a multi-vendor network.
730
+
731
+ #### **UMTS & GSM KPI's – 32.410 [55]**
732
+
733
+ The purpose of this specification is to define Key Performance Indicators (KPIs) for GSM and UMTS. KPI definitions include high level KPIs that are a) common across GSM and UMTS networks; and b) **specific** to network techniques such as GSM and UMTS networks.
734
+
735
+ #### **E-UTRAN KPI's – 32.451 [70]**
736
+
737
+ This specification defines requirements (business level requirements, specification level requirements and use case descriptions) related to KPIs for E-UTRAN.
738
+
739
+ #### **IMS KPI's – 32.454 [73]**
740
+
741
+ This specification defines KPIs for the IP Multimedia Subsystem (IMS).
742
+
743
+ #### **EPC KPI's – 32.455 [74]**
744
+
745
+ This specification defines KPIs for the Evolved Packet Core(EPC).network.
746
+
747
+ #### **PM File Format – 32.432 [64], 32.435 [65], 32.436 [66]**
748
+
749
+ This set of specifications describe the general semantics of performance measurement result and collection. It defines the report file format, report file conventions, and the file transfer procedure.
750
+
751
+ ## 7.2 Trace Specifications
752
+
753
+ ### 7.2.1 Overview and relationships to IRP Framework
754
+
755
+ ![A yellow-bordered box titled 'Trace specifications:' containing a bulleted list of three items: 'Concept and requirements (32.421)', 'Trace control and configuration management (32.422)', and 'Trace data definition (32.423)'.](759c7d62402f0b4651ddce292be5bdef_img.jpg)
756
+
757
+ Trace specifications:
758
+
759
+ - Concept and requirements (32.421)
760
+ - Trace control and configuration management (32.422)
761
+ - Trace data definition (32.423)
762
+
763
+ A yellow-bordered box titled 'Trace specifications:' containing a bulleted list of three items: 'Concept and requirements (32.421)', 'Trace control and configuration management (32.422)', and 'Trace data definition (32.423)'.
764
+
765
+ **Figure 7.2.1-2: Trace-related Specifications 3GPP R10**
766
+
767
+ ### 7.2.2 Trace Specifications
768
+
769
+ #### **Trace Control & Configuration – 32.422 [60]**
770
+
771
+ This specification describes the mechanisms used for the control and configuration of the Trace functionality at the EMs, NEs and UEs. It covers the triggering events for starting/stopping of subscriber/UE activity traced over 3GPP standardized signalling interfaces, the types of trace mechanisms, configuration of a trace, level of detail available in the trace data, the generation of Trace results in the Network Elements (NEs) and User Equipment (UE) and the transfer of these results to one or more EM(s) and/or Network Manager(s) (NM(s)).
772
+
773
+ #### **Trace Data Definitions – 32.423 [61]**
774
+
775
+ This specification describes Trace data definition and management. It covers the trace records content, their format and transfer.
776
+
777
+ # --- 8 Relationships between IRPs
778
+
779
+ Relationships between Interface IRP's:
780
+
781
+ - All Interface IRP's utilizing the functionality of the Generic IRP
782
+ - All Notification emitting Interface IRP's utilizing the functionality of the Notification IRP
783
+
784
+ Relationships between NRM IRP's:
785
+
786
+ - All NRM IRP's utilizing the functionality of the Generic NRM IRP
787
+ - All function-specific NRM IRP (e.g. Core NRM IRP) utilizing the functionality of the Inventory NRM IRP
788
+
789
+ # 9 SON Functions
790
+
791
+ In order to reduce the operating expenses (OPEX) associated with the management of increasing number of nodes from more than one vendor the concept of the Self-Organizing Network (SON) was introduced. Automation of some network planning, configuration and optimisation processes via the use of SON functions can help the network operator to reduce OPEX by reducing manual involvement in such tasks.
792
+
793
+ TS 32.500 [75] identifies the following SON use cases in context of LTE network for standardization:
794
+
795
+ - Self-establishment of an eNodeB: Related requirements are defined in TS 32.501 [76];
796
+ - Automatic Neighbour Relation Management: Related requirements are defined in TS 32.511 [79];
797
+ - Self-Optimisation Management: Related requirements are defined in TS 32.521 [80];
798
+ - Self-Healing Management: Related requirements are defined in TS 32.541 [86];
799
+ - Energy Saving Management: Related requirements are defined in TS 32.551 [87];
800
+ - Minimization of Drive Tests: Related requirements are defined in TS 32.421 [59] and TS 32.441 [67].
801
+
802
+ Each SON use case can involve multiple IRPs when corresponding management scenarios are applied. The IRP relationships of SON functions are addressed case by case as follows,
803
+
804
+ ## Self-establishment of an eNodeB
805
+
806
+ - Generic IRP (32.311[25], 32.312 [26], 32.316 [27] )
807
+ - Alarm IRP (32.111-1 [5], 32.111-2 [6], 32.111-6 [7])
808
+ - Test Management IRP (32.321[28], 32.322[29], 32.326 [30] )
809
+ - Basic CM IRP (32.600 [88], 32.601 [89], 32.602 [90], 32.606 [91]) or Bulk CM IRP (32.611 [92], 32.612 [93], 32.616 [94])
810
+ - Kernel CM IRP (32.661 [107], 32.662 [108] )
811
+ - SC IRP (32.500 [75], 32.501 [76], 32.502 [77], 32.506 [78] )
812
+ - Software Management IRP (32.531 [83], 32.532 [84], 32.536 [85])
813
+ - Notification IRP (32.300 [21], 32.301[22], 32.302 [23], 32.306 [24] )
814
+ - File Transfer IRP (for ARCF data download) (32.341[34], 32.342[35], 32.346[36])
815
+ - Generic NRM IRP (32.621 [95], 32.622 [96], 32.626 [97])
816
+ - EUTRAN NRM IRP (32.761 [131], 32.762 [132], 32.766 [133])
817
+
818
+ ## Automatic Neighbour Relation Management
819
+
820
+ - Alarm IRP (32.111-1 [5], 32.111-2 [6], 32.111-6 [5])
821
+ - Basic CM IRP (32.600 [88], 32.601 [89], 32.602 [90], 32.606 [91]) or Bulk CM IRP (32.611 [92], 32.612 [93], 32.616 [94])
822
+ - Kernel CM IRP (32.661 [107], 32.662 [108])
823
+ - Notification IRP (32.300 [21], 32.301 [22], 32.302 [23], 32.306 [24] )
824
+ - Generic NRM IRP (32.621 [95], 32.622 [96], 32.626 [97]) EUTRAN NRM IRP (32.761 [131], 32.762 [132], 32.766 [133])
825
+
826
+ ## Self-Optimisation Management
827
+
828
+ - Alarm IRP (32.111-1 [5], 32.111-2 [6], 32.111-6 [7] )
829
+
830
+ - PM IRP (32.410 [55], 32.411 [56], 32.412 [57], 32.416 [58] )
831
+ - File Transfer IRP (for PM data upload) (32.341[34], 32.342[35], 32.346[36] Basic CM IRP (32.600 [88], 32.601 [89], 32.602 [90], 32.606 [91]) or Bulk CM IRP (32.611 [92], 32.612 [93], 32.616 [94])
832
+ - Kernel CM IRP (32.661 [107], 32.662 [108])
833
+ - Notification IRP (32.300 [21], 32.301 [22], 32.302 [23], 32.306 [24]) NRM IRP (32.521[80], 32.522 [81], 32.526 [82] )
834
+ - Generic NRM IRP (32.621 [95], 32.622 [96], 32.626 [97])
835
+ - EUTRAN NRM IRP (32.761 [131], 32.762 [132], 32.766 [133])
836
+ - EUTRAN Performance Measurements (32.425 [62])
837
+
838
+ ## **Self-Healing Management**
839
+
840
+ - Alarm IRP (32.111-1 [5], 32.111-2 [6], 32.111-6 [7])
841
+ - Basic CM IRP (32.600 [88], 32.601 [89], 32.602 [90], 32.606 [91] ) or Bulk CM IRP (32.611 [92], 32.612 [93], 32.616 [94])
842
+ - Kernel CM IRP (32.661 [107], 32.662 [108])
843
+ - Notification IRP (32.300 [21], 32.301 [22], 32.302 [23], 32.306 [24] )
844
+ - SON Policy NRM IRP (32.521[80], 32.522 [81], 32.526 [82] Generic NRM IRP (32.621 [95], 32.622 [96], 32.626 [97])
845
+ - EUTRAN NRM IRP (32.761 [131], 32.762 [132], 32.766 [133])
846
+
847
+ ## **Energy Saving Management**
848
+
849
+ - PM IRP (32.410 [55], 32.411 [56], 32.412 [57], 32.416 [58] )
850
+ - File Transfer IRP (for PM data upload) (32.341[34], 32.342[35], 32.346[36])
851
+ - Basic CM IRP (32.600 [88], 32.601 [89], 32.602 [90], 32.606 [91]) or Bulk CM IRP (32.611 [92], 32.612 [93], 32.616 [94])
852
+ - Kernel CM IRP (32.661 [107], 32.662 [108])
853
+ - Notification IRP (32.300 [21], 32.301 [22], 32.302 [23], 32.306 [24] )
854
+ - SON Policy NRM IRP (32.521 [80], 32.522 [81], 32.526 [82])
855
+ - Generic NRM IRP (32.621 [95], 32.622 [96], 32.626 [97])
856
+ - EUTRAN NRM IRP (32.761 [131], 32.762 [132], 32.766 [133]) EUTRAN Performance Measurements (32.425 [62])
857
+
858
+ ## **Minimization of Drive Tests**
859
+
860
+ - Basic CM IRP (32.600 [88], 32.601 [89], 32.602 [90], 32.606 [91]) or Bulk CM IRP (32.611 [92], 32.612 [93], 32.616 [94])
861
+ - Kernel CM IRP (32.661 [107], 32.662 [108])
862
+ - Trace Management IRP (32.441 [67], 32.442 [68], 32.446 [69] )
863
+ - Trace Control and Configuration Management IRP (32.421 [59], 32.422 [60], 32.423 [61])
864
+ - Generic NRM IRP (32.621[95], 32.622 [96], 32.626 [97] )
865
+ - UTRAN NRM IRP (32.641[101], 32.642 [102], 32.646 [103] )
866
+ - EUTRAN NRM IRP (32.761 [131], 32.762 [132], 32.766 [133])
867
+
868
+ # --- Annex A (Informative): IRP Packaging Suggestions
869
+
870
+ ## A.1 Overview & Purpose
871
+
872
+ This Annex provides IRP packaging suggestions, intended to guide service providers as well as equipment and solutions providers to identify and choose suitable standardized management interface capabilities.
873
+
874
+ Note: No IRP Packaging Suggestions are identified for the present document.
875
+
876
+ # Annex B (informative): Change history
877
+
878
+ | Change history | | | | | | | | | |
879
+ |----------------|-------|-----------|----|-----|------------------------------------|--|--|-------|--------|
880
+ | Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | | | Old | New |
881
+ | 2010-12 | SP-50 | SP-100764 | -- | -- | Submitted to SA#50 for Information | | | 0.1.0 | 1.0.0 |
882
+ | 2011-05 | SP-52 | SP-110272 | -- | -- | Submitted to SA#52 for Approval | | | 1.2.0 | 2.0.0 |
883
+ | 2011-06 | SP-52 | -- | -- | -- | Publication | | | 2.0.0 | 10.0.0 |
884
+
885
+ | Change history | | | | | | | | |
886
+ |----------------|---------|-----------|------|-----|-----|----------------------------------------------------------------------------|--|-------------|
887
+ | Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | | New version |
888
+ | 2020-09 | SA#89E | SP-200728 | 0019 | - | F | Correction of reference list and adding references throughout the document | | 10.1.0 |
marked/Rel-10/32_series/32111-1/raw.md ADDED
@@ -0,0 +1,623 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+ # **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; Fault Management; Part 1: 3G fault management requirements (Release 10)** ---
4
+
5
+ ![LTE Advanced logo](935eed7aa61f7777f62cfc032e11bee9_img.jpg)
6
+
7
+ The logo for LTE Advanced, featuring the word "lte" in bold lowercase letters with a red signal icon above the "l", and the word "ADVANCED" in smaller uppercase letters to the right. A trademark symbol (TM) is at the bottom right.
8
+
9
+ LTE Advanced logo
10
+
11
+ ![3GPP logo](30a26f2d17ca95672702bf50fb4f0242_img.jpg)
12
+
13
+ The 3GPP logo, consisting of the letters "3GPP" in a stylized, bold font with a red signal icon below the "P", and a trademark symbol (TM) at the top right.
14
+
15
+ 3GPP logo
16
+
17
+ Keywords
18
+ UMTS, management, alarm
19
+
20
+ ## **3GPP**
21
+
22
+ Postal address
23
+
24
+ ---
25
+
26
+ 3GPP support office address
27
+
28
+ ---
29
+
30
+ 650 Route des Lucioles - Sophia Antipolis
31
+ Valbonne - FRANCE
32
+ Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
33
+
34
+ Internet
35
+
36
+ ---
37
+
38
+ <http://www.3gpp.org>
39
+
40
+ ## **Copyright Notification**
41
+
42
+ No part may be reproduced except as authorized by written permission.
43
+ The copyright and the foregoing restriction extend to reproduction in all media.
44
+
45
+ © 2015, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
46
+ All rights reserved.
47
+
48
+ UMTS™ is a Trade Mark of ETSI registered for the benefit of its members
49
+ 3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
50
+ LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
51
+ GSM® and the GSM logo are registered and owned by the GSM Association
52
+
53
+ # --- Contents
54
+
55
+ | | |
56
+ |------------------------------------------------------------------------------|----|
57
+ | Foreword ..... | 4 |
58
+ | Introduction ..... | 4 |
59
+ | 1 Scope..... | 6 |
60
+ | 2 References..... | 6 |
61
+ | 3 Definitions and abbreviations ..... | 7 |
62
+ | 3.1 Definitions..... | 7 |
63
+ | 3.2 Abbreviations ..... | 8 |
64
+ | 4 Fault Management concept and requirements ..... | 8 |
65
+ | 4.0 Introduction ..... | 8 |
66
+ | 4.1 Faults and alarms..... | 8 |
67
+ | 4.1.0 Introduction ..... | 8 |
68
+ | 4.1.1 Fault detection ..... | 9 |
69
+ | 4.1.2 Generation of alarms ..... | 10 |
70
+ | 4.1.3 Clearing of alarms ..... | 10 |
71
+ | 4.1.4 Alarm forwarding and filtering ..... | 11 |
72
+ | 4.1.5 Storage and retrieval of alarms in/from the NE..... | 12 |
73
+ | 4.1.6 Fault Recovery..... | 12 |
74
+ | 4.1.7 Configuration of Alarms..... | 13 |
75
+ | 4.1.8 Correlation of Alarms and Events ..... | 13 |
76
+ | 4.1.9 Root Cause Analysis..... | 13 |
77
+ | 4.2 State Management..... | 14 |
78
+ | 4.2.0 Introduction ..... | 14 |
79
+ | 4.2.1 Propagation of state change..... | 14 |
80
+ | 4.3 Test management..... | 15 |
81
+ | 5 Fault Management over Itf-N ..... | 15 |
82
+ | 5.1 Fault Management concept ..... | 15 |
83
+ | 5.2 Management of alarm event reports..... | 16 |
84
+ | 5.2.1 Mapping of alarm and related state change event reports ..... | 16 |
85
+ | 5.2.2 Real-time forwarding of event reports..... | 16 |
86
+ | 5.2.3 Alarm clearing ..... | 16 |
87
+ | 5.3 Retrieval of alarm information ..... | 17 |
88
+ | 5.3.0 Introduction ..... | 17 |
89
+ | 5.3.1 Retrieval of current alarm information on NM request..... | 17 |
90
+ | 5.3.2 Logging and retrieval of alarm history information on NM request ..... | 17 |
91
+ | 5.4 Co-operative alarm acknowledgement on the Itf-N..... | 18 |
92
+ | 5.5 Overview of IRPs related to Fault Management (FM) ..... | 18 |
93
+ | Annex A (informative): Change history..... | 19 |
94
+
95
+ # --- Foreword
96
+
97
+ This Technical Specification (TS) has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP).
98
+
99
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
100
+
101
+ Version x.y.z
102
+
103
+ where:
104
+
105
+ - x the first digit:
106
+ - 1 presented to TSG for information;
107
+ - 2 presented to TSG for approval;
108
+ - 3 or greater indicates TSG approved document under change control.
109
+ - y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
110
+ - z the third digit is incremented when editorial only changes have been incorporated in the document.
111
+
112
+ # --- Introduction
113
+
114
+ The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project: Technical Specification Group Services and System Aspects; Telecommunication management; as identified below:
115
+
116
+ **32.111-1 "Fault Management; Part 1: 3G fault management requirements".**
117
+
118
+ 32.111-2 "Fault Management; Part 2: Alarm Integration Reference Point (IRP): Information Service (IS)".
119
+
120
+ 32.111-3 "Fault Management; Part 3: Alarm Integration Reference Point (IRP): Common Object Request Broker Architecture (CORBA) Solution Set (SS)".
121
+
122
+ 32.111-6 "Fault Management; Part 6: Alarm Integration Reference Point (IRP): Solution Set (SS) definitions".
123
+
124
+ The present document is part of a TS-family, which describes the requirements and information model necessary for the Telecommunication Management (TM) of 3G systems. The TM principles and TM architecture are specified in 3GPP TS 32.101 [2] and 3GPP TS 32.102 [3].
125
+
126
+ A 3G system is composed of a multitude of Network Elements (NE) of various types and, typically, different vendors, which inter-operate in a co-ordinated manner in order to satisfy the network users' communication requirements. The occurrence of failures in a NE may cause a deterioration of this NE's function and/or service quality and will, in severe cases, lead to the complete unavailability of the respective NE. In order to minimize the effects of such failures on the Quality of Service (QoS) as perceived by the network users it is necessary to:
127
+
128
+ - detect failures in the network as soon as they occur and alert the operating personnel as fast as possible;
129
+ - isolate the failures (autonomously or through operator intervention), i.e. switch off faulty units and, if applicable, limit the effect of the failure as much as possible by reconfiguration of the faulty NE/adjacent NEs;
130
+ - if necessary, determine the cause of the failure using diagnosis and test routines; and,
131
+ - repair/eliminate failures in due time through the application of maintenance procedures.
132
+
133
+ This aspect of the management environment is termed "Fault Management" (FM). The purpose of FM is to detect failures as soon as they occur and to limit their effects on the network Quality of Service (QoS) as far as possible. The latter is achieved by bringing additional/redundant equipment into operation, reconfiguring existing equipment/NEs, or by repairing/eliminating the cause of the failure.
134
+
135
+ Fault Management (FM) encompasses all of the above functionalities except commissioning/decommissioning of NEs and potential operator triggered reconfiguration (these are a matter of Configuration Management (CM), cf. [1]). FM also includes associated features in the Operations System (OS), such as the administration of a pending alarms list, the presentation of operational state information of physical and logical devices/resources/functions, and the provision and analysis of the alarm and state history of the network.
136
+
137
+ # --- 1 Scope
138
+
139
+ The present document specifies the overall requirements for 3G Fault Management (FM) as it applies to the Network Elements (NE), Element Manager (EM) and Network Manager (NM).
140
+
141
+ Clause 4 defines the FM concept and functional requirements for the detection of faults and the generation, collection and presentation of alarms, operational state data and test results across 3G systems. These functions are described on a non-formal level since the formal standardization of these functions across the different vendors' equipment is not required. The functional areas specified in the present document cover:
142
+
143
+ - fault surveillance and detection in the NEs;
144
+ - notification of alarms (including alarm cease) and operational state changes;
145
+ - retrieval of current alarms from the NEs;
146
+ - fault isolation and defence mechanisms in the NEs;
147
+ - alarm filtering;
148
+ - management of alarm severity levels;
149
+ - alarm and operational state data presentation and analysis at the Operations System (OS);
150
+ - retention of alarm and operational state data in the NEs and the OS; and
151
+ - the management of tests.
152
+
153
+ Any (re)configuration activity exerted from the EM as a consequence of faults will not be subject of the present document. These are described in [1].
154
+
155
+ Clause 5 of the present document defines the functional requirements for the standard Itf-N, for the purpose of Fault Management of 3G networks, as seen from the Network Manager (NM). The Itf-N is fully standardized so as to connect systems of any vendor to the NM via this interface.
156
+
157
+ # --- 2 References
158
+
159
+ The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
160
+
161
+ - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
162
+ - For a specific reference, subsequent revisions do not apply.
163
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
164
+
165
+ - [1] 3GPP TS 32.601: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP); Requirements".
166
+ - [2] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements".
167
+ - [3] 3GPP TS 32.102: "Telecommunication management; Architecture".
168
+ - [4] 3GPP TS 32.401: "Telecommunication management; Performance Management (PM); Concept and requirements".
169
+ - [5] ITU-T Recommendation X.710: "Information technology - Open Systems Interconnection - Common Management Information Service".
170
+
171
+ - [6] ITU-T Recommendation X.711: "Managed objects for diagnostic information of public switched telephone network connected V-series modem DCE's".
172
+ - [7] ITU-T Recommendation X.721: "Information technology - Open Systems Interconnection - Structure of management information: Definition of management information".
173
+ - [8] ITU-T Recommendation X.731: "Information technology - Open Systems Interconnection - Systems Management: State management function".
174
+ - [9] ITU-T Recommendation X.733: "Information technology - Open Systems Interconnection - Systems Management: Alarm reporting function".
175
+ - [10] ITU-T Recommendation X.734: "Information technology - Open Systems Interconnection - Systems Management: Event report management function".
176
+ - [11] ITU-T Recommendation X.735: "Information technology - Open Systems Interconnection - Systems Management: Log control function".
177
+ - [12] ITU-T Recommendation X.745: "Information technology - Open Systems Interconnection - Systems Management: Test management function".
178
+ - [13] 3GPP TS 32.111-2: "Telecommunication management; Fault Management; Part 2: Alarm Integration Reference Point (IRP); Information Service (IS)".
179
+ - [14] 3GPP TS 32.111-3: "Telecommunication management; Fault Management; Part 3: Alarm Integration Reference Point (IRP); Common Object Request Broker Architecture (CORBA) Solution Set (SS)".
180
+ - [15] Void.
181
+ - [16] ISO 8571: "File Transfer, Access and Management".
182
+ - [17] 3GPP TS 32.111-7: "Telecommunication management; Fault Management; Alarm Integration Reference Point (IRP); SOAP Solution Set (SS)".
183
+ - [18] 3GPP TS 21.905: "Vocabulary for 3GPP Specifications".
184
+
185
+ # --- 3 Definitions and abbreviations
186
+
187
+ ## 3.1 Definitions
188
+
189
+ For the purposes of the present document, the terms and definitions in 3GPP TS 32.101 [2], 3GPP TS 32.102 [3], 3GPP TS 21.905 [18] and the following apply:
190
+
191
+ **active alarm:** an alarm that has not been cleared and which is active until the fault that caused the alarm is corrected and a "clear alarm" is generated.
192
+
193
+ **ADAC Faults:** faults that are "Automatically Detected and Automatically Cleared" by the system when they occur and when they are repaired.
194
+
195
+ **ADMC Faults:** faults that are Automatically Detected by the system when they occur and Manually Cleared by the operator when they are repaired.
196
+
197
+ **alarm:** abnormal network entity condition, which categorizes an event as a fault.
198
+
199
+ **alarm notification:** notification used to inform the recipient about the occurrence of an alarm.
200
+
201
+ **clear alarm:** alarm where the severity value is set to "cleared".
202
+
203
+ **event:** this is a generic term for any type of occurrence within a network entity.
204
+
205
+ NOTE: A notification or event report may be used to inform one or more OS(s) about the occurrence of the event.
206
+
207
+ **fault:** a deviation of a system from normal operation, which may result in the loss of operational capabilities of the element or the loss of redundancy in case of a redundant configuration.
208
+
209
+ **Itf-N:** Management interface defined in 3GPP TS 32.101 [2] subclause 5.1.2.2 and 3GPP TS 32.102 [3] subclause 7.3.2.
210
+
211
+ **notification:** information message originated within a network entity to inform one or more OS(s) about the occurrence of an event.
212
+
213
+ ## 3.2 Abbreviations
214
+
215
+ For the purposes of the present document, the abbreviations given in 3GPP TS 32.101 [2], 3GPP TS 32.102 [3], 3GPP TS 21.905 [18] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in 3GPP TS 32.101 [2], 3GPP TS 32.102 [3] and 3GPP TS 21.905 [18], in that order.
216
+
217
+ | | |
218
+ |------|--------------------------------------------------|
219
+ | ADAC | Automatically Detected and Automatically Cleared |
220
+ | ADMC | Automatically Detected and Manually Cleared |
221
+ | CM | Configuration Management |
222
+ | EM | Element Manager |
223
+ | FM | Fault Management |
224
+ | ISO | International Standards Organisation |
225
+ | IRP | Integration Reference Point |
226
+ | MMI | Man-Machine Interface |
227
+ | MOC | Managed Object Class |
228
+ | MOI | Managed Object Instance |
229
+ | NE | Network Element |
230
+ | NM | Network Manager |
231
+ | OS | Operations System |
232
+ | QoS | Quality of Service |
233
+ | TMN | Telecommunications Management Network |
234
+
235
+ # --- 4 Fault Management concept and requirements
236
+
237
+ ## 4.0 Introduction
238
+
239
+ Any evaluation of the NEs' and the overall network health status require the detection of faults in the network and, consequently, the notification of alarms to the OS (EM and/or NM). Depending on the nature of the fault, it may be combined with a change of the operational state of the logical and/or physical resource(s) affected by the fault.
240
+
241
+ Detection and notification of these state changes is as essential as it is for the alarms. A list of active alarms in the network and operational state information as well as alarm/state history data are required by the system operator for further analysis. Additionally, test procedures can be used in order to obtain more detailed information if necessary, or to verify an alarm or state or the proper operation of NEs and their logical and physical resources.
242
+
243
+ The following clauses explain the detection of faults, the handling of alarms and state changes and the execution of tests.
244
+
245
+ Only those requirements covered by clause 5 and related IRPs shall be considered as valid requirements for compliance to the standard defined by the present document.
246
+
247
+ ## 4.1 Faults and alarms
248
+
249
+ ### 4.1.0 Introduction
250
+
251
+ Faults that may occur in the network can be grouped into one of the following categories:
252
+
253
+ - Hardware failures, i.e. the malfunction of some physical resource within a NE.
254
+ - Software problems, e.g. software bugs, database inconsistencies.
255
+
256
+ - Functional faults, i.e. a failure of some functional resource in a NE and no hardware component can be found responsible for the problem.
257
+ - Loss of some or all of the NE's specified capability due to overload situations.
258
+ - Communication failures between two NEs, or between NE and OS, or between two OSs.
259
+
260
+ In any case, as a consequence of faults, appropriate alarms related to the physical or logical resource(s) affected by the fault(s), shall be generated by the network entities.
261
+
262
+ The following clauses focus on the aspects of fault detection, alarm generation and storage, fault recovery and retrieval of stored alarm information.
263
+
264
+ ### 4.1.1 Fault detection
265
+
266
+ When any type of fault described above occurs within a 3G network, the affected network entities shall be able to detect them immediately.
267
+
268
+ The network entities accomplish this task using autonomous self-check circuits/procedures, including, in the case of NEs, the observation of measurements, counters and thresholds. The threshold measurements may be predefined by the manufacturer and executed autonomously in the NE, or they may be based on performance measurements administered by the EM, cf. [4]. The fault detection mechanism as defined above shall cover both active and standby components of the network entities.
269
+
270
+ The majority of the faults should have well-defined conditions for the declaration of their presence or absence, i.e. fault occurrence and fault clearing conditions. Any such incident shall be referred to in the present document as an ADAC fault. The network entities should be able to recognize when a previously detected ADAC fault is no longer present, i.e. the clearing of the fault, using similar techniques as they use to detect the occurrence of the fault. For some faults, no clearing condition exists. For the purpose of the present document, these faults shall be referred to as ADMC faults. An example of this is when the network entity has to restart a software process due to some inconsistencies, and normal operation can be resumed afterwards. In this case, although the inconsistencies are cleared, the cause of the problem is not yet corrected. Manual intervention by the system operator shall always be necessary to clear ADMC faults since these, by definition, cannot be cleared by the network entity itself.
271
+
272
+ For some faults there is no need for any short-term action, neither from the system operator nor from the network entity itself, since the fault condition lasted for a short period of time only and then disappeared. An example of this is when a NE detects the crossing of some observed threshold, and in the next sampling interval, the observed value stays within its limits.
273
+
274
+ For each fault, the fault detection process shall supply the following information:
275
+
276
+ - the device/resource/file/functionality/smallest replaceable unit as follows:
277
+ - for hardware faults, the smallest replaceable unit that is faulty;
278
+ - for software faults, the affected software component, e.g. corrupted file(s) or databases or software code;
279
+ - for functional faults, the affected functionality;
280
+ - for faults caused by overload, information on the reason for the overload;
281
+ - for all the above faults, wherever applicable, an indication of the physical and logical resources that are affected by the fault if applicable, a description of the loss of capability of the affected resource.
282
+ - the type of the fault (communication, environmental, equipment, processing error, QoS) according to ITU-T Recommendation X.733 [9];
283
+ - the severity of the fault (indeterminate, warning, minor, major, critical), as defined in ITU-T Recommendation X.733 [9];
284
+ - the probable cause of the fault;
285
+ - the time at which the fault was detected in the faulty network entity;
286
+
287
+ - the nature of the fault, e.g. ADAC or ADMC;
288
+ - any other information that helps understanding the cause and the location of the abnormal situation (system/implementation specific).
289
+
290
+ For some faults, additional means, such as test and diagnosis features, may be necessary in order to obtain the required level of detail. See clause 4.3 for details.
291
+
292
+ ### 4.1.2 Generation of alarms
293
+
294
+ For each detected fault, appropriate alarms shall be generated by the faulty network entity, regardless of whether it is an ADAC or an ADMC fault. Such alarms shall contain all the information provided by the fault detection process as described in clause 4.1.1.
295
+
296
+ In order to ease the fault localization and repair, the faulty network entity should generate for each single fault, one single alarm, also in the case where a single fault causes a degradation of the operational capabilities of more than one physical or logical resource within the network entity. An example of this is a hardware fault, which affects not only a physical resource but also degrades the logical resource(s) that this hardware supports. In this case the network entity should generate one single alarm for the faulty resource (i.e. the resource which needs to be repaired) and a number of events related to state management (cf. clause 4.2) for all the physical/logical resources affected by the fault, including the faulty one itself.
297
+
298
+ In case a network entity is not able to recognize that a single fault manifests itself in different ways, the single fault is detected as multiple faults and originates multiple alarms. In this case however, when the fault is repaired the network entity should be able to detect the repair of all the multiple faults and clear the related multiple alarms.
299
+
300
+ When a fault occurs on the connection media between two NEs or between a NE and an OS, and affects the communication capability between such NE/OS, each affected NE/OS shall detect the fault as described in clause 4.1.1 and generate its own associated communication alarm toward the managing OS. In this case it is the responsibility of the OS to correlate alarms received from different NEs/OSs and localize the fault in the best possible way.
301
+
302
+ Within each NE, all alarms generated by that NE shall be input into a list of active alarms. The NEs shall be able to provide such a list of active alarms to the OS when requested.
303
+
304
+ ### 4.1.3 Clearing of alarms
305
+
306
+ The alarms originated in consequence of faults need to be cleared. To clear an alarm it is necessary to repair the corresponding fault. The procedures to repair faults are implementation dependent and therefore they are out of the scope of the present document, however, in general:
307
+
308
+ - the equipment faults are repaired by replacing the faulty units with working ones;
309
+ - the software faults are repaired by means of partial or global system initializations, by means of software patches or by means of updated software loads;
310
+ - the communication faults are repaired by replacing the faulty transmission equipment or, in case of excessive noise, by removing the cause of the noise;
311
+ - the QoS faults are repaired either by removing the causes that degraded the QoS or by improving the capability of the system to react against the causes that could result in a degradation of the QoS;
312
+ - Solving the environmental problem repairs the environment faults (high temperature, high humidity, etc.).
313
+
314
+ It is also possible that an ADAC fault is spontaneously repaired, without the intervention of the operator (e.g. a threshold crossed fault). In this case the NE behaves as for the ADAC faults repaired by the operator.
315
+
316
+ In principle, the NE uses the same mechanisms to detect that a fault has been repaired, as for the detection of the occurrence of the fault. However, for ADMC faults, manual intervention by the operator is always necessary to clear the fault. Practically, various methods exist for the system to detect that a fault has been repaired and clear alarms and the faults that triggered them. For example:
317
+
318
+ - The system operator implicitly requests the NE to clear a fault, e.g. by initializing a new device that replaces a faulty one. Once the new device has been successfully put into service, the NE shall clear the fault(s). Consequently, the NE shall clear all related alarms.
319
+ - The system operator explicitly requests the clearing of one or more alarms. Once the alarm(s) has/have been cleared, the fault management system (within EMS and/or NE) should reissue those alarms (as new alarms) in case the fault situation still persists.
320
+ - The NE detects the exchange of a faulty device by a new one and initializes it autonomously. Once the new device has been successfully put into service, the NE shall clear the fault(s). Consequently, the NE shall clear all related alarms.
321
+ - The NE detects that a previously reported threshold crossed alarm is no longer valid. It shall then clear the corresponding active alarm and the associated fault, without requiring any operator intervention. The details for the administration of thresholds and the exact condition for the NE to clear a threshold crossed alarm are implementation specific and depend on the definition of the threshold measurement, see also clause 4.1.1.
322
+ - ADMC faults/alarms can, by definition, not be cleared by the NE autonomously. Therefore, in any case, system operator functions shall be available to request the clearing of ADAC alarms/faults in the NE. Once an ADMC alarm/fault has been cleared, the NE shall clear the associated ADAC fault/alarm.
323
+
324
+ Details of these mechanisms are system/implementation specific.
325
+
326
+ Each time an alarm is cleared the NE shall generate an appropriate clear alarm event. A clear alarm is defined as an alarm, as specified in clause 3.1, except that its severity is set to "cleared". The relationship between the clear alarm and the active alarm is established:
327
+
328
+ - by re-using a set of parameters that uniquely identify the active alarm (see clause 4.1.1); or
329
+ - by including a reference to the active alarm in the clear alarm.
330
+
331
+ When a clear alarm is generated the corresponding active alarm is removed from the active alarm list.
332
+
333
+ ### 4.1.4 Alarm forwarding and filtering
334
+
335
+ As soon as an alarm is entered into or removed from the active alarms list Alarm notifications shall be forwarded by the NE, in the form of unsolicited notifications;
336
+
337
+ If forwarding is not possible at this time, e.g. due to communication breakdown, then the notifications shall be sent as soon as the communication capability has been restored. The storage space is limited. The storage capacity is Operator and implementation dependent. If the number of delayed notifications exceeds the storage space then an alarm synchronization procedure shall be run when the communication capability has been restored.
338
+
339
+ The OS shall detect the communication failures that prevent the reception of alarms and raise an appropriate alarm to the operator.
340
+
341
+ If the Itf-N is implemented in the NE, then the destination of the notifications is the NM, and the interface shall comply with the stipulations made in clause 5. If the Itf-N resides in the EM, proprietary means may be employed to forward the notifications to the EM. Note that, even if the Itf-N is implemented in the NE, the EM may still also receive the notifications by one of the above mechanisms. However, the present document does not explicitly require the NEs to support the EM as a second destination.
342
+
343
+ The event report shall include all information defined for the respective event (see clauses 4.1.1, 4.1.2 and 4.1.3), plus an identification of the NE that generated the report.
344
+
345
+ The system operator shall be able to allow or suppress alarm reporting for each NE. As a minimum, the following criteria shall be supported for alarm filtering:
346
+
347
+ - the NE that generated the alarm, i.e. all alarm messages for that NE shall be suppressed;
348
+ - the device/resource/function to which the alarm relates;
349
+ - the severity of the alarm;
350
+
351
+ - the time at which the alarm was detected, i.e. the alarm time; and,
352
+ - any combination of the above criteria.
353
+
354
+ The result of any command to modify the forwarding criteria shall be confirmed by the NE to the requesting operator.
355
+
356
+ ### 4.1.5 Storage and retrieval of alarms in/from the NE
357
+
358
+ For Fault Management (FM) purposes, each NE shall have to store and retain the following information:
359
+
360
+ - a list of all active alarms, i.e. all alarms that have not yet been cleared; and
361
+ - alarm history information, i.e. all notifications related to the occurrence and clearing of alarms.
362
+
363
+ It shall be possible to apply filters when active alarm information is retrieved by the Manager and when the history information is stored by the NE and retrieved by the Manager.
364
+
365
+ The storage space for alarm history in the NE is limited. Therefore it shall be organized as a circular buffer, i.e. the oldest data item(s) shall be overwritten by new data if the buffer is full. Further "buffer full" behaviours, e.g. those defined in ITU-T Recommendation X.735 [11], may be implemented as an option. The storage capacity itself, and thus the duration, for which the data can be retained, shall be Operator and implementation dependent.
366
+
367
+ ### 4.1.6 Fault Recovery
368
+
369
+ After a fault has been detected and the replaceable faulty units have been identified, some management functions are necessary in order to perform system recovery and/or restoration, either automatically by the NE and/or the EM, or manually by the operator.
370
+
371
+ The fault recovery functions are used in various phases of the Fault Management (FM):
372
+
373
+ - 1) Once a fault has been detected, the NE shall be able to evaluate the effect of the fault on the telecommunication services and autonomously take recovery actions in order to minimize service degradation or disruption.
374
+ - 2) Once the faulty unit(s) has (have) been replaced or repaired, it shall be possible from the EM to put the previously faulty unit(s) back into service so that normal operation is restored. This transition should be done in such a way that the currently provided telecommunication services are not, or only minimally, disturbed.
375
+ - 3) At any time the NE shall be able to perform recovery actions if requested by the operator. The operator may have several reasons to require such actions; e.g. he has deduced a faulty condition by analysing and correlating alarm reports, or he wants to verify that the NE is capable of performing the recovery actions (proactive maintenance).
376
+
377
+ The recovery actions that the NE performs (autonomously or on demand) in case of faults depend on the nature and severity of the faults, on the hardware and software capabilities of the NE and on the current configuration of the NE.
378
+
379
+ Faults are distinguished in two categories: software faults and hardware faults. In the case of software faults, depending on the severity of the fault, the recovery actions may be system initializations (at different levels), activation of a backup software load, activation of a fallback software load, download of a software unit etc. In the case of hardware faults, the recovery actions depend on the existence and type of redundant (i.e. back-up) resources. Redundancy of some resources may be provided in the NE in order to achieve fault tolerance and to improve system availability.
380
+
381
+ If the faulty resource has no redundancy, the recovery actions shall be:
382
+
383
+ - a) Isolate and remove from service the faulty resource so that it cannot disturb other working resources;
384
+ - b) Remove from service the physical and functional resources (if any) which are dependent on the faulty one. This prevents the propagation of the fault effects to other fault-free resources;
385
+ - c) State management related activities for the faulty resource and other affected/dependent resources cf. clause 4.2;
386
+ - d) Generate and forward appropriate notifications to inform the OS about all the changes performed.
387
+
388
+ If the faulty resource has redundancy, the NE shall perform action a), c) and d) above and, in addition, the recovery sequence that is specific to that type of redundancy. Several types of redundancy exist (e.g. hot standby, cold standby, duplex, symmetric/asymmetric, N plus one or N plus K redundancy, etc.), and for each one, there is a specific sequence
389
+
390
+ of actions to be performed in case of failure. The present document specifies the Fault Management aspects of the redundancies, but it does not define the specific recovery sequences of the redundancy types.
391
+
392
+ In the case of a failure of a resource providing service, the recovery sequence shall start immediately. Before or during the changeover, a temporary and limited loss of service shall be acceptable. In the case of a management command, the NE should perform the changeover without degradation of the telecommunication services.
393
+
394
+ The detailed definition of the management of the redundancies is out of the scope of the present document. If a fault causes the interruption of ongoing calls, then the interrupted calls shall be cleared, i.e. all resources allocated to these calls shall immediately be released by the system.
395
+
396
+ ### 4.1.7 Configuration of Alarms
397
+
398
+ It shall be possible to configure the alarm actions, thresholds and severities by means of commands, according to the following requirements:
399
+
400
+ - the operator shall be able to configure any threshold that determines the declaration or clearing of a fault. If a series of thresholds are defined to generate alarms of various severities, then for each alarm severity the threshold values shall be configurable individually.
401
+ - it shall be possible to modify the severity of alarms defined in the system, e.g. from major to critical. This capability should be implemented on the manager, however, in case it is implemented on the NE, the alarms forwarded by the NE to the OS and the alarms displayed on the local MMI shall have the same severity.
402
+
403
+ The NE shall confirm such alarm configuration commands and shall notify the results to the requesting system operator.
404
+
405
+ ### 4.1.8 Correlation of Alarms and Events
406
+
407
+ A single network fault may result in the generation of multiple alarms and events from affected entities over time and spread over a wide geographical area. If possible, the OS should indicate which alarms and events are correlated to each other.
408
+
409
+ Alarms may be correlated in view of certain rules such as alarm propagation path, specific geographical area, specific equipment, or repeated alarms from the same source. The alarms are partitioned into sets where alarms within one correlated set have a high probability of being caused by the same network fault. A correlated set may also contain events. These events are considered having a high probability of being related to the same network fault.
410
+
411
+ The correlation describes relations between network events (e.g. current alarms as those captured in AlarmList, historical alarms as those captured in NotificationLog, network configuration changes).
412
+
413
+ ### 4.1.9 Root Cause Analysis
414
+
415
+ For a set of correlated alarms, one alarm may relate to the fault which is the root cause of all the correlated alarms and events. If possible, the OS should perform a Root Cause Analysis to identify and indicate the Root Cause Alarm.
416
+
417
+ Root Cause Analysis is a process that can determine and identify the network condition (e.g. fault, mis-configuration) causing the alarms. The determination may be based on the following (for example):
418
+
419
+ - Information carried in alarm(s);
420
+ - Information carried in correlated alarm sets;
421
+ - Information carried in network notifications;
422
+ - Network configuration information;
423
+ - Operators' network management experience.
424
+
425
+ ## 4.2 State Management
426
+
427
+ ### 4.2.0 Introduction
428
+
429
+ The State Management is a common service defined within Configuration Management [1] and used by several management areas, including Fault Management. In this clause, some detailed requirements on State Management as they apply to the Fault Management are defined.
430
+
431
+ From the point of view of Fault Management, only two of the three primary state attributes are really important: the Administrative state and the Operational state. In addition the resources may have some secondary "status" attributes which give further detailed information about the reason of the primary state.
432
+
433
+ The Administrative state is used by the Operator to make a resource available for service, or to remove a resource from service. For example:
434
+
435
+ - for fault correction the Administrative state can be used to isolate a faulty resource;
436
+ - in case of redundancy the Administrative state can be used to lock the active resource and let the standby resource to become active (preventive maintenance);
437
+ - for Test management the Administrative state can be used to put a resource out of service to run an intrusive test on it.
438
+
439
+ The Operational state gives the information about the real capability of a resource to provide or not provide service.
440
+
441
+ - The operational state is "enabled" when the resource is able to provide service, "disabled" when the resource cannot provide service.
442
+ - A resource can lose the capability to provide service because of a fault or because another resource on which it depends is out of service (e.g. disabled or locked).
443
+ - In case a resource does not lose completely its capability to provide service, the Operational state shall be "enabled" and the Availability status shall be "degraded".
444
+
445
+ The changes of the state and status attributes of a resource shall be notified to the relative manager(s) as specified in [1].
446
+
447
+ When a state change is originated by a failure, the alarm notification and the related state change notifications shall be correlated to each other by means of explicit relationship information.
448
+
449
+ ### 4.2.1 Propagation of state change
450
+
451
+ Within a managed element, when for any reason a resource changes its state, the change shall be propagated, in a consistent way, to all the other resources that are functionally dependent on the first one. Therefore:
452
+
453
+ - In case of a fault occurring on a resource makes that resource completely out of service, if the current operational state is "enabled", it shall be changed to "disabled" and a state change notification shall be generated. Then, all the dependent resources (following the fault dependency diagram specific to that managed element) shall be checked and, in case they are "enabled" they shall be changed to "disabled". In this process, also the secondary status shall be changed consistently, in a way that it shall be possible to distinguish whether an object is disabled because it is faulty or because of it is functionally dependent on another object which is disabled.
454
+ - In case a faulty resource is repaired, the Operational state of that resource is changed from "disabled" to "enabled" and all the dependent resources are turned back to "enabled" (this is the simple case). In more complex cases, some of the objects may be disabled for different causes (different faults or faults plus locks on different superior resources), in this cases the repaired resource can be turned "enabled" only when all the causes are cleared (i.e. faults are repaired and superior resources are unlocked). Also in this process the secondary status shall be changed consistently.
455
+ - In case the operator locks a resource, the process of the state change propagation is similar to the first case (resource failure) except for the locked resource which does not change its operational state but only the administrative state from "unlocked" to "locked". The dependent resources are processed as in the first case.
456
+
457
+ - In case the operator unlocks a resource, the process of the state change propagation is similar to the second case (fault reparation) except for the first resource (the unlocked one) which does not change its operational state but only the administrative state from "locked" to "unlocked". The dependent resources are processed as in the first case.
458
+
459
+ ## 4.3 Test management
460
+
461
+ This management function provides capabilities that can be used in different phases of the Fault Management (FM). For example:
462
+
463
+ - when a fault has been detected and if the information provided through the alarm report is not sufficient to localize the faulty resource, tests can be executed to better localize the fault;
464
+ - during normal operation of the NE, tests can be executed for the purpose of detecting faults;
465
+ - once a faulty resource has been repaired or replaced, before it is restored to service, tests can be executed on that resource to be sure that it is fault free.
466
+
467
+ However, regardless of the context where the testing is used, its target is always the same: verify if a system's physical or functional resource performs properly and, in case it happens to be faulty, provide all the information to help the operator to localize and correct the faults.
468
+
469
+ Testing is an activity that involves the operator, the managing system (the OS) and the managed system (the NE). Generally the operator requests the execution of tests from the OS and the managed NE autonomously executes the tests without any further support from the operator.
470
+
471
+ In some cases, the operator may request that only a test bed is set up (e.g. establish special internal connections, provide access test points, etc.). The operator can then perform the real tests, which may require some manual support to handle external test equipment. Since the "local maintenance" and the "inter NE testing" are out of the scope of the present document, this aspect of the testing is not treated any further.
472
+
473
+ The requirements for the test management service are based on ITU-T Recommendation X.745 [12], where the testing description and definitions are specified.
474
+
475
+ # --- 5 Fault Management over Itf-N
476
+
477
+ ## 5.1 Fault Management concept
478
+
479
+ An operations system on the network management layer (i.e. the NM) provides fault management services and functions required by the 3G operator on top of the element management layer.
480
+
481
+ The Itf-N may connect the Network Management (NM) system either to Element Managers (EMs) or directly to the Network Elements (NEs). This is done by means of Integration Reference Points (IRPs). In the following, the term "subordinate entities" defines either EMs or NEs, which are in charge of supporting the Itf-N.
482
+
483
+ This clause describes the properties of an interface enabling a NM to supervise a 3G-telecommunication network including - if necessary - the managing EMs. To provide to the NM the Fault Management capability for the network implies that the subordinate entities have to provide information about:
484
+
485
+ - events and failures occurring in the subordinate entities;
486
+ - events and failures of the connections towards the subordinate entities and also of the connections within the 3G network;
487
+ - the network configuration (due to the fact that alarms and related state change information are always originated by network resources, see [1]). This is, however, not part of the FM functionality.
488
+
489
+ Therefore, for the purpose of FM the subordinate entities send notifications to a NM indicating:
490
+
491
+ - alarm reports (indicating the occurrence or the clearing of failures within the subordinate entities), so that the related alarm information can be updated;
492
+
493
+ - state change event reports, so that the related (operational) state information can be updated. This is, however, not part of the FM functionality.
494
+
495
+ The forwarding of these notifications is controlled by the NM operator using adequate filtering mechanisms within the subordinate entities.
496
+
497
+ The Itf-N provides also means to allow the NM operator the storage ("logging") and the later evaluation of desired information within the subordinate entities.
498
+
499
+ The retrieval capability of alarm-related information concerns two aspects:
500
+
501
+ - retrieval of "dynamic" information (e.g. alarms, states), which describes the momentary alarm condition in the subordinate entities and allows the NM operator a synchronization of its alarm overview data;
502
+ - retrieval of "history" information from the logs (e.g. active/clear alarms and state changes occurred in the past), which allows the evaluation of events that may have been lost, e.g. after an Itf-N interface failure or a system recovery.
503
+
504
+ As a consequence of the requirements described above, both the NM and the subordinate entity shall be able to initiate the communication.
505
+
506
+ ## 5.2 Management of alarm event reports
507
+
508
+ ### 5.2.1 Mapping of alarm and related state change event reports
509
+
510
+ The alarm and state change reports received by the NM relate to functional objects in accordance with the information model of Itf-N. This information model tailored for a multi-vendor capability is different from the information model of the EM-NE interface (if an EM is available) or from the internal resource modelling within the NE (in case of direct NM-NE interface). Thus a mapping of alarm and related state change event reports is performed by a mediation function within the subordinate entity.
511
+
512
+ The mediation function translates the original alarm/state change event reports (which may contain proprietary parameters or parameter values) taking into account the information model of the Itf-N.
513
+
514
+ The following examples describe potential mediation function behaviour:
515
+
516
+ - Alarm notifications generated by a functional object in a subordinate entity can be mapped to alarm reports of the corresponding ("equivalent") functional object at the Itf-N. If the functional object generating the original alarm notification has not a direct corresponding object at the Itf-N, the mediation functions maps the alarm to the next superior functional object in accordance with the containment tree of the Itf-N.
517
+ - State change notifications generated by a functional object in a subordinate entity can be mapped to state change reports of the corresponding ("equivalent") functional object at the Itf-N. If the functional object generating the original state change notification has not a direct corresponding object at the Itf-N, the mediation functions maps the alarm to the next superior functional object in accordance with the containment tree of the Itf-N.
518
+
519
+ Every alarm notification generated by a manufacturer-specific, equipment-related object in the subordinate entity is mapped to an alarm report of a generic logical object, which models the corresponding equipment-related resource.
520
+
521
+ ### 5.2.2 Real-time forwarding of event reports
522
+
523
+ If the Itf-N is in normal operation (the NM connection to the subordinate entities is up), alarm reports are forwarded in real-time to the NM via appropriate filtering located in the subordinate entity. These filters may be controlled either locally or remotely by the managing NM (via Itf-N) and ensure that only the event reports which fulfil pre-defined criteria can reach the superior NM. In a multi-NM environment each NM shall have an own filter within every subordinate entity which may generate notifications.
524
+
525
+ ### 5.2.3 Alarm clearing
526
+
527
+ On the Itf-N, alarm reports containing the value "cleared" of the parameter perceivedSeverity are used to clear the alarms. The correlation between the clear alarm and the related active alarms is performed by means of unambiguous identifiers.
528
+
529
+ This clearing mechanism ensures the correct clearing of alarms, independently of the (manufacturer-specific) implementation of the mapping of alarms/state change events in accordance with the information model of the Itf-N.
530
+
531
+ The IRP manager may also clear alarms manually.
532
+
533
+ ## 5.3 Retrieval of alarm information
534
+
535
+ ### 5.3.0 Introduction
536
+
537
+ The retrieval of alarm information comprises two aspects:
538
+
539
+ - Retrieval of current information:
540
+
541
+ This mechanism shall ensure data consistency about the current alarm information between the NM and its subordinate entities and is achieved by means of a so-called synchronization ("alignment") procedure, triggered by the NM. The synchronization is required after every start-up of the Itf-N, nevertheless the NM may trigger it at any time.
542
+
543
+ - Logging and retrieval of history information:
544
+
545
+ This mechanism offers to the NM the capability to get the alarm information stored within the subordinate entities for later evaluation.
546
+
547
+ ### 5.3.1 Retrieval of current alarm information on NM request
548
+
549
+ The present document defines a flexible, generic synchronization procedure, which fulfils the following requirements:
550
+
551
+ - The alarm information provided by means of the synchronization procedure shall be the same (at least for the mandatory parameters) as the information already available in the alarm list. The procedure shall be able to assign the received synchronization-alarm information to the correspondent requests, if several synchronization procedures triggered by one NM run at the same time.
552
+ - The procedure shall allow the NM to trigger the start at any time and to recognize unambiguously the end and the successful completion of the synchronization.
553
+ - The procedure shall allow the NM to discern easily between an "on-line" (spontaneous) alarm report and an alarm report received as consequence of a previously triggered synchronization procedure.
554
+ - The procedure shall allow the NM to specify filter criteria in the alignment request (e.g. for a full network or only a part of it).
555
+ - The procedure shall support connections to several NM and route the alignment-related information only to the requesting NM.
556
+ - During the synchronization procedure new ("real-time") alarms may be sent at any time to the managing NM.
557
+ - If the EM loses confidence to its alarm list and rebuilds it, then the EM shall indicate to the NM that the alarm list have been rebuilt. If the rebuild of the alarm list only concerns alarms for e.g. one NE then the EM may indicate that it is only that part of the alarm list that has been rebuilt. In the latter case the NM may use the knowledge that only a specific subset of the alarm list have been rebuilt to perform a partial resynchronization using filters.
558
+
559
+ If applicable, an alarm synchronization procedure may be aborted by the requesting NM.
560
+
561
+ ### 5.3.2 Logging and retrieval of alarm history information on NM request
562
+
563
+ The alarm history information may be stored in the subordinate entities. The NM is able to create logs for alarm reports and to define the criteria for storage of alarm information according to ITU-T Recommendation X.735 [11].
564
+
565
+ Nevertheless these particular requirements are not specific for alarm or state change information.
566
+
567
+ The alarm history information should be returned by files when IRP agent finished collecting all the alarm history information that NM requested.
568
+
569
+ ## 5.4 Co-operative alarm acknowledgement on the Itf-N
570
+
571
+ The acknowledgement of an alarm is a maintenance function that aids the operators in his day-to-day management activity of his network. An alarm is acknowledged by the operator to indicate he has started the activity to resolve this specific problem. In general a human operator performs the acknowledgement, however a management system (NM or EM) may automatically acknowledge an alarm as well.
572
+
573
+ The alarm acknowledgement function requires that:
574
+
575
+ - a) All involved OSs have the same information about the alarms to be managed (including the current responsibility for alarm handling).
576
+ - b) All involved OSs have the capability to send and to receive acknowledgement messages associated to previous alarm reports.
577
+
578
+ A co-operative alarm acknowledgement means that the acknowledgement performed at EM layer is notified at NM layer and vice versa, thus the acknowledgement-related status of this alarm is the same across the whole management hierarchy. The OSs often gives the operator(s) a possibility to add a comment to an alarm. An OS can have the capability to record more than one comment for each alarm. To make the same alarm look the same in all OSs subscribing to the alarm, it should be possible to distribute the recorded comments in the same way as for the acknowledgement information.
579
+
580
+ The co-operative alarm acknowledgement on Itf-N shall fulfil the following requirements:
581
+
582
+ - Acknowledgement messages may be sent in both directions between EMs and NM, containing the following information:
583
+ - Correlation information to the alarm just acknowledged.
584
+ - Acknowledgement history data, including the current alarm state (active | cleared), the time of alarm acknowledgement and, as configurable information, the management system (EM | NM) and the operator in charge of acknowledgement (the parameter operator name or, in case of auto-acknowledgement, a generic system name).
585
+ - Acknowledgement notifications sent to NM shall be filtered with the same criteria applied to the alarms.
586
+ - Taking into account the acknowledgement functionality, the above described synchronization procedure for retrieval of current alarm information on NM request may be extended. Additionally to the requirements defined in clause 5.3.1, this extended synchronization procedure relates not only to the active, but also to the "cleared and not acknowledged" alarms, which have still to be managed by the EM.
587
+
588
+ ## 5.5 Overview of IRPs related to Fault Management (FM)
589
+
590
+ The Itf-N is built up by a number of IRPs. The basic structure of the IRPs is defined in 3GPP TS 32.101 [2] and 3GPP TS 32.102 [3].
591
+
592
+ For the purpose of FM, the following IRPs are needed:
593
+
594
+ - Alarm IRP, see 3GPP TS 32.111-2 [13];
595
+ - Notification IRP, see [1]; and
596
+ - Log IRP.
597
+
598
+ NOTE: The Log IRP is not part of Release 1999, therefore the requirements related to the log functionality are not valid for Release 1999).
599
+
600
+ # Annex A (informative): Change history
601
+
602
+ | Change history | | | | | | | |
603
+ |----------------|-------|-----------|-----|-----|-------------------------------------------------------------------------------------------------------------------------------------------|--------|--------|
604
+ | Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New |
605
+ | Mar 2000 | SA 07 | SP-000013 | -- | -- | 32.111 Approved at TSG SA#7 and placed under Change Control | 2.0.0 | 3.0.0 |
606
+ | Mar 2000 | -- | -- | -- | -- | cosmetic | 3.0.0 | 3.0.1 |
607
+ | Jun 2000 | SA 08 | SP-000247 | 001 | -- | Split of TS 32.111 - Part 1: Main part of spec – Requirements | 3.0.1 | 3.1.0 |
608
+ | Jun 2000 | SA 08 | SP-000248 | 002 | -- | Split of TS 32.111- Part 1: Merged Clause X into Clause 4 | 3.0.1 | 3.1.0 |
609
+ | Jun 2000 | SA_08 | SP-000249 | 003 | -- | Split of TS 32.111 - Part 1: Alignment of FM requirements with IRP, etc | 3.0.1 | 3.1.0 |
610
+ | Sep 2000 | SA 09 | SP-000437 | 001 | -- | Clarification On Mediation Function Algorithms | 3.1.0 | 3.2.0 |
611
+ | Sep 2000 | SA 09 | SP-000437 | 002 | -- | Clarification On Clear Alarm Suppression | 3.1.0 | 3.2.0 |
612
+ | Jun 2001 | SA_12 | SP-010282 | 003 | -- | Added two new features 'partial resynchronization' or 'ltf-N distribution of comments associated to faults'. | 3.2.0 | 4.0.0 |
613
+ | Mar 2002 | SA 15 | -- | -- | -- | Automatic upgrade to Rel-5 (no Rel-5 CR) | 4.0.0 | 5.0.0 |
614
+ | Sep 2002 | SA 17 | SP-020477 | 004 | -- | Add requirements for new clearAlarms() operation in Alarm IRP | 5.0.0 | 5.1.0 |
615
+ | Dec 2002 | -- | -- | -- | -- | Updated references & cosmetics | 5.1.0 | 5.1.1 |
616
+ | Dec 2003 | SA 22 | SP-030631 | 005 | -- | Add retrieval of alarm history information requirement | 5.1.1 | 6.0.0 |
617
+ | Jun 2005 | -- | -- | -- | -- | Foreword, Introduction update : added 32.111-5 new TS-family member | 6.0.0 | 6.0.1 |
618
+ | Jun 2007 | SA_36 | -- | -- | -- | Automatic upgrade to Rel-7 (no CR) at freeze of Rel-7. Deleted reference to CMIP SS, discontinued from R7 onwards. Cleaned-up references. | 6.0.1 | 7.0.0 |
619
+ | Mar 2009 | SA 43 | SP-090207 | 006 | -- | Include reference to SOAP Solution Set specification | 7.0.0 | 8.0.0 |
620
+ | Dec 2009 | SA 46 | -- | -- | -- | Upgrade to Rel-9 | 8.0.0 | 9.0.0 |
621
+ | Mar 2011 | - | - | - | - | Update to Rel-10 version (MCC) | 9.0.0 | 10.0.0 |
622
+ | Sep 2011 | SA 53 | SP-110534 | 007 | - | Add concepts for Alarm Correlation and Root Cause Analysis | 10.0.0 | 10.1.0 |
623
+ | Mar 2015 | SA 67 | SP-150060 | 014 | 1 | Replacement of obsolete term "N interface" | 10.1.0 | 10.2.0 |
marked/Rel-10/32_series/32111-2/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
marked/Rel-10/32_series/32111-6/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
marked/Rel-10/32_series/32121/raw.md ADDED
@@ -0,0 +1,183 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+ # **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; 3GPP TS 32.121 (V10.0.0 (2011-03)) ~~Telecommunication management; Advanced Alarm Management (AAM)~~ *Technical Specification* **Integration Reference Point (IRP): Requirements (Release 10)**** ---
4
+
5
+ ![LTE Advanced logo](935eed7aa61f7777f62cfc032e11bee9_img.jpg)
6
+
7
+ The logo for LTE Advanced, featuring the word "lte" in bold lowercase letters with a red signal icon above the "l", and the word "ADVANCED" in smaller uppercase letters to the right. A trademark symbol (TM) is at the bottom right.
8
+
9
+ LTE Advanced logo
10
+
11
+ ![3GPP logo](30a26f2d17ca95672702bf50fb4f0242_img.jpg)
12
+
13
+ The 3GPP logo, consisting of the letters "3GPP" in a stylized, bold font with a red signal icon below the "G", and a trademark symbol (TM) at the top right.
14
+
15
+ 3GPP logo
16
+
17
+ Keywords
18
+ UMTS, GSM, management
19
+
20
+ ## **3GPP**
21
+
22
+ Postal address
23
+
24
+ ---
25
+
26
+ 3GPP support office address
27
+
28
+ ---
29
+
30
+ 650 Route des Lucioles - Sophia Antipolis
31
+ Valbonne - FRANCE
32
+ Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
33
+
34
+ Internet
35
+
36
+ ---
37
+
38
+ <http://www.3gpp.org>
39
+
40
+ ## **Copyright Notification**
41
+
42
+ No part may be reproduced except as authorized by written permission.
43
+ The copyright and the foregoing restriction extend to reproduction in all media.
44
+
45
+ © 2011, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TTA, TTC).
46
+ All rights reserved.
47
+
48
+ UMTS™ is a Trade Mark of ETSI registered for the benefit of its members
49
+ 3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
50
+ LTE™ is a Trade Mark of ETSI currently being registered for the benefit of its Members and of the 3GPP Organizational Partners
51
+ GSM® and the GSM logo are registered and owned by the GSM Association
52
+
53
+ # --- Contents
54
+
55
+ - Foreword ..... 4
56
+ - Introduction ..... 4
57
+ - 1 Scope..... 5
58
+ - 2 References..... 5
59
+ - 3 Definitions and abbreviations ..... 5
60
+ - 3.1 Definitions..... 5
61
+ - 3.2 Abbreviations ..... 5
62
+ - 4 Requirements for AAM on Itf-N ..... 6
63
+ - 4.1 Concept..... 6
64
+ - 4.2 General Requirements for AAM on Itf-N ..... 6
65
+ - Annex A (informative): Change history..... 7
66
+
67
+ # --- Foreword
68
+
69
+ This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP).
70
+
71
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
72
+
73
+ Version x.y.z
74
+
75
+ where:
76
+
77
+ - x the first digit:
78
+ - 1 presented to TSG for information;
79
+ - 2 presented to TSG for approval;
80
+ - 3 or greater indicates TSG approved document under change control.
81
+ - y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
82
+ - z the third digit is incremented when editorial only changes have been incorporated in the document.
83
+
84
+ # --- Introduction
85
+
86
+ The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below:
87
+
88
+ - 32.121: "Advanced Alarm Management Integration Reference Point (IRP): Requirements";**
89
+ - 32.122: "Advanced Alarm Management Integration Reference Point (IRP): Information Service (IS)";
90
+ - 32.126: "Advanced Alarm Management (AAM) Integration Reference Point (IRP); Solution Set (SS) definitions".
91
+
92
+ The Itf-N interface is built up by a number of IRPs and a related Name Convention, which realize the functional capabilities over this interface. The basic structure of the IRPs is defined in 3GPP TS 32.150 [1].
93
+
94
+ IRPManagers (typically Network Management Systems) and IRPAgents (typically EMs or NEs) synchronize their data concerning alarms or configuration data. In certain scenarios this synchronization is lost or not done.
95
+
96
+ This IRP provides functionality to significantly reduce the amount of data which needs to be transferred in order to re-establish synchronization.
97
+
98
+ # --- 1 Scope
99
+
100
+ The purpose of this set of specifications is to provide a mechanism enabling the IRP Manager to improve the information content of alarms, thereby contributing to reduce the time-to-repair. For this configurable rules for advanced alarm filtering are defined to reduce the number of alarms by applying such advanced alarm filtering.
101
+
102
+ The present document contains the Requirements of Advanced Alarm Management (AAM) on Itf-N IRP. It defines, for the purpose of AAM on Itf-N, the basic requirements to be fulfilled on Itf-N.
103
+
104
+ # --- 2 References
105
+
106
+ The following documents contain provisions that, through reference in this text, constitute provisions of the present document.
107
+
108
+ - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
109
+ - For a specific reference, subsequent revisions do not apply.
110
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document in the same Release as the present document.
111
+
112
+ [1] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions".
113
+
114
+ # --- 3 Definitions and abbreviations
115
+
116
+ ## 3.1 Definitions
117
+
118
+ For the purposes of the present document, the following terms and definitions apply:
119
+
120
+ **IRP:** See 3GPP TS 32.150 [1].
121
+
122
+ **IRPAgent:** See 3GPP TS 32.150 [1].
123
+
124
+ **IRPManager:** See 3GPP TS 32.150 [1].
125
+
126
+ ## 3.2 Abbreviations
127
+
128
+ For the purposes of the present document, the following abbreviations apply:
129
+
130
+ | | |
131
+ |-------|-----------------------------|
132
+ | IRP | Integration Reference Point |
133
+ | IS | Information Service |
134
+ | Itf-N | Interface N |
135
+ | NE | Network Element |
136
+
137
+ # --- 4 Requirements for AAM on Itf-N
138
+
139
+ ## 4.1 Concept
140
+
141
+ A single network fault may generate a large number of alarms over space and time. In a large and complex network, simultaneous network faults may occur, causing the network operator to be flooded with high volume of alarms. The high volume of alarms, typically the one received by an IRPManager via the getAlarmList or alarm notifications of Alarm IRP specification, greatly inhibits the operator ability to quickly identify and locate the responsible network faults.
142
+
143
+ Therefore it is considered advantageous to have methods categorizing network alarms as insignificant or significant. The word 'insignificant' does not imply "low priority". In the context of this specification the words 'significant' and 'insignificant' have the following implications:
144
+
145
+ - IRP Agent shall not report alarms categorized as insignificant.
146
+ - IRP Agent shall report all significant alarms.
147
+
148
+ Reporting only significant alarms and not reporting insignificant alarms would reduce network operator's time to locate network faults so that more time can be spent fixing them.
149
+
150
+ When reading the alarmList it can be advantageous to partition alarms in the alarmList into sets of alarms which might be caused by the same network fault.
151
+
152
+ By assigning network operators to locate network faults based on alarms in such alarm partitions, rather than based on alarm severity, alarm type or reporting location, duplication of network operator effort (e.g. two network operators work on two different alarms and their resolutions lead to the same network faults) can be reduced or avoided
153
+
154
+ ## 4.2 General Requirements for AAM on Itf-N
155
+
156
+ 4.2.1 The IRP Manager should be able to request the IRP Agent to
157
+
158
+ - a) categorize alarms as insignificant or significant and
159
+ - b) to act based on these categories, e.g. to discard if insignificant.
160
+ - The IRP Manager should be able to cancel such requests.
161
+
162
+ 4.2.2 The standard should define some alarm categorization rules. The standard should also allow vendor to define their own alarm categorization rules.
163
+
164
+ 4.2.3 Possible alarm categorization rule(s) may depend for example on the type of alarm, the environment, the time of day, the type of network element, the alarm severity, the location, position in the containment tree and many more. No restriction is imposed in this regard.
165
+
166
+ 4.2.4 The IRP Manager should be able to request the IRP Agent for the list of active categorization rules (i.e. standard defined and vendor defined).
167
+
168
+ 4.2.5 The IRP manager should be able to request the IRP Agent to apply the categorization rule(s) and to remove the insignificant alarms in the following situations:
169
+
170
+ - + alarm notifications to be sent to any IRP Manager
171
+ - + advanced alarm management requests by this IRP Manager to read the alarm list
172
+
173
+ Certain types of categorization rules are only to be applied to read the alarm list. The term used for these rules is alarm partitioning rules.
174
+
175
+ ## --- Annex A (informative): Change history
176
+
177
+ | Change history | | | | | | | | |
178
+ |----------------|-------|-----------|----|----|------------------------------------|-----|-------|--------|
179
+ | Date | TSG # | TSG Doc. | CR | R | Subject/Comment | Cat | Old | New |
180
+ | May 2007 | SA 36 | SP-070294 | -- | -- | Submitted to SA#36 for Information | -- | -- | 1.0.0 |
181
+ | Mar 2008 | SA 39 | SP-080071 | -- | -- | Submitted to SA#39 for Approval | -- | 2.0.0 | 8.0.0 |
182
+ | Dec 2009 | - | - | - | - | Update to Rel-9 version (MCC) | -- | 8.0.0 | 9.0.0 |
183
+ | Mar 2011 | - | - | - | - | Update to Rel-10 version (MCC) | -- | 9.0.0 | 10.0.0 |
marked/Rel-10/32_series/32122/raw.md ADDED
@@ -0,0 +1,983 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+ # **3rd Generation Partnership Project;** Keywords **Technical Specification Group Services and System Aspects;** **3GPP TS 32.122 V10.0.0 (2011-03)** **Telecommunication management;** **Advanced Alarm Management (AAM)** Technical Specification **Integration Reference Point (IRP):** **Information Service (IS)** **(Release 10)** ---
4
+
5
+ **3GPP**
6
+
7
+ Postal address
8
+
9
+ ---
10
+
11
+ 3GPP support office address
12
+
13
+ ---
14
+
15
+ 050 Route des Lucioles - Sophia Antipolis
16
+ Valbonne - FRANCE
17
+ Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
18
+
19
+ Internet
20
+
21
+ ---
22
+
23
+ <http://www.3gpp.org>
24
+
25
+ ![LTE logo with '4ADVANCED' text above the 'e' and a red signal icon.](4f4b52340aaccb1bcf733468dca9ee03_img.jpg)
26
+
27
+ LTE logo with '4ADVANCED' text above the 'e' and a red signal icon.
28
+
29
+ ![3GPP logo with a red signal icon below the 'P'.](6ed175c791b5e156d9c98a8dbcc3318c_img.jpg)
30
+
31
+ 3GPP logo with a red signal icon below the 'P'.
32
+
33
+ ## **Copyright Notification**
34
+
35
+ No part may be reproduced except as authorized by written permission.
36
+ The copyright and the foregoing restriction extend to reproduction in all media.
37
+
38
+ © 2011, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TTA, TTC).
39
+ All rights reserved.
40
+
41
+ UMTSTM is a Trade Mark of ETSI registered for the benefit of its members
42
+
43
+ 3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
44
+
45
+ LTETM is a Trade Mark of ETSI currently being registered for the benefit of its Members and of the 3GPP Organizational Partners
46
+
47
+ GSM® and the GSM logo are registered and owned by the GSM Association
48
+
49
+ The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP.
50
+
51
+ The present document has not been subject to any approval process by the 3GPP Organisational Partners and shall not be implemented.
52
+
53
+ This Specification is provided for future development work within 3GPP only. The Organisational Partners accept no liability for any use of this Specification.
54
+
55
+ Specifications and reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organisational Partners' Publications Offices.
56
+
57
+ # --- Contents
58
+
59
+ | | |
60
+ |------------------------------------------------------------------------------------------------------|----|
61
+ | Foreword ..... | 5 |
62
+ | Introduction ..... | 5 |
63
+ | 1 Scope..... | 6 |
64
+ | 2 References..... | 6 |
65
+ | 3 Definitions and abbreviations ..... | 7 |
66
+ | 3.1 Definitions..... | 7 |
67
+ | 3.2 Abbreviations ..... | 7 |
68
+ | 4 System overview ..... | 8 |
69
+ | 4.1 System context ..... | 8 |
70
+ | 5 Information Object Classes..... | 9 |
71
+ | 5.1 Imported information entities and local labels..... | 9 |
72
+ | 5.2 Class diagram ..... | 9 |
73
+ | 5.2.1 Attributes and relationships..... | 9 |
74
+ | 5.2.2 Inheritance ..... | 10 |
75
+ | 5.3 Information Object Class definitions ..... | 11 |
76
+ | 5.3.1 advancedAlarmManagementRule ..... | 11 |
77
+ | 5.3.1.1 Definition ..... | 11 |
78
+ | 5.3.1.1.1 General Definition ..... | 11 |
79
+ | 5.3.1.2 Attributes ..... | 11 |
80
+ | 5.3.2 advancedAlarmManagementIRP..... | 11 |
81
+ | 5.3.2.1 Definition ..... | 11 |
82
+ | 5.4 Information relationships definition..... | 12 |
83
+ | 5.4.1 relation- AdvancedAlarmManagementIRP-AdvancedAlarm ManagementRule (M) .. | 12 |
84
+ | 5.4.1.1 Definition ..... | 12 |
85
+ | 5.4.1.2 Roles ..... | 12 |
86
+ | 5.4.1.3 Constraints ..... | 12 |
87
+ | 5.5 Information attributes definition ..... | 12 |
88
+ | 5.5.1 Definitions and legal values ..... | 12 |
89
+ | 6 Interface Definition ..... | 13 |
90
+ | 6.1 Class diagram representing interfaces..... | 13 |
91
+ | 6.2 AAMIRPOperation_1 Interface (M)..... | 14 |
92
+ | 6.2.1 Scope ..... | 14 |
93
+ | 6.2.2 Operation activateAAMRule (M)..... | 14 |
94
+ | 6.2.2.1 Definition ..... | 14 |
95
+ | 6.2.2.2 Input parameters ..... | 14 |
96
+ | 6.2.2.2.1 Generic Input parameters..... | 14 |
97
+ | 6.2.2.2.2 Content of Input parameter aAMRuleParameterList depending on value of<br>aAMRuleType ..... | 14 |
98
+ | 6.2.2.2.2.1 aAMRuleType = ThresholdRule..... | 14 |
99
+ | 6.2.2.2.2.2 aAMRuleType = TransientRule..... | 15 |
100
+ | 6.2.2.2.2.3 aAMRuleType = ToggleRule..... | 15 |
101
+ | 6.2.2.2.2.4 aAMRuleType = vendorSpecificRule..... | 15 |
102
+ | 6.2.2.3 Output parameters..... | 15 |
103
+ | 6.2.2.4 Pre-condition..... | 15 |
104
+ | 6.2.2.5 Post-condition ..... | 15 |
105
+ | 6.2.2.6 Exceptions..... | 15 |
106
+ | 6.2.3 Operation getAAMRules (M)..... | 16 |
107
+ | 6.2.3.1 Definition ..... | 16 |
108
+ | 6.2.3.2 Input parameters ..... | 16 |
109
+ | 6.2.3.3 Output parameters..... | 16 |
110
+ | 6.2.3.4 Pre-condition..... | 16 |
111
+ | 6.2.3.5 Post-condition ..... | 16 |
112
+
113
+ | | | |
114
+ |---------|--------------------------------------|----|
115
+ | 6.2.3.6 | Exceptions..... | 16 |
116
+ | 6.2.4 | Operation deactivateAAMRule (M)..... | 17 |
117
+ | 6.2.4.1 | Definition ..... | 17 |
118
+ | 6.2.4.2 | Input parameters ..... | 17 |
119
+ | 6.2.4.3 | Output parameters..... | 17 |
120
+ | 6.2.4.4 | Pre-condition..... | 17 |
121
+ | 6.2.4.5 | Post-condition ..... | 17 |
122
+ | 6.2.4.6 | Exceptions..... | 17 |
123
+
124
+ # **Annex A (normative): Advanced Alarm Management Rules..... 18**
125
+
126
+ | | | |
127
+ |------------------------|------------------------------------------------|----|
128
+ | A.1 | General..... | 18 |
129
+ | A.2 | AAM Rules ..... | 20 |
130
+ | A.2.1 | Threshold Rule ..... | 20 |
131
+ | A.2.1.1 | Parameters ..... | 20 |
132
+ | A.2.1.2 | Criterion to determine alike alarm..... | 20 |
133
+ | A.2.1.3 | Treatment of alike alarm..... | 20 |
134
+ | A.2.1.4 | Relation to Log and AlarmList..... | 21 |
135
+ | A.2.1.5 | Samples..... | 21 |
136
+ | A.2.1.6 | Example for Use cases..... | 21 |
137
+ | A.2.2 | Transient Rule ..... | 22 |
138
+ | A.2.2.1 | Parameters ..... | 22 |
139
+ | A.2.2.2 | Criterion to determine alike alarm..... | 22 |
140
+ | A.2.2.3 | Treatment of alike alarm..... | 22 |
141
+ | A.2.2.4 | Relation to Log and AlarmList..... | 22 |
142
+ | A.2.2.5 | Samples..... | 23 |
143
+ | A.2.2.6 | Example for Use cases..... | 23 |
144
+ | A.2.3 | Toggle Rule ..... | 24 |
145
+ | A.2.3.1 | Parameters ..... | 24 |
146
+ | A.2.3.2 | Criterion to determine alike alarm..... | 24 |
147
+ | A.2.3.3 | Treatment of alike alarm..... | 24 |
148
+ | A.2.3.4 | Relation to Log and AlarmList..... | 25 |
149
+ | A.2.3.5 | Samples..... | 25 |
150
+ | A.2.3.6 | Example for Use cases..... | 26 |
151
+ | A.2.3.7 | Exception Handling ..... | 27 |
152
+ | A.2.4 | Definition of vendor specific rule ..... | 27 |
153
+ | A.3 | Relation of Rule and Notification filter ..... | 28 |
154
+ | Annex B (informative): | Change history..... | 29 |
155
+
156
+ # --- Foreword
157
+
158
+ This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP).
159
+
160
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
161
+
162
+ Version x.y.z
163
+
164
+ where:
165
+
166
+ - x the first digit:
167
+ - 1 presented to TSG for information;
168
+ - 2 presented to TSG for approval;
169
+ - 3 or greater indicates TSG approved document under change control.
170
+ - y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
171
+ - z the third digit is incremented when editorial only changes have been incorporated in the document.
172
+
173
+ # --- Introduction
174
+
175
+ The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below:
176
+
177
+ - 32.121: Advanced Alarm Management (AAM) Integration Reference Point (IRP): Requirements;
178
+ - 32.122: Advanced Alarm Management (AAM) Integration Reference Point (IRP): Information Service (IS);**
179
+ - 32.126: Advanced Alarm Management (AAM) Integration Reference Point (IRP); Solution Set (SS) definitions.
180
+
181
+ The Itf-N interface is built up by a number of IRPs and a related Name Convention, which realize the functional capabilities over this interface. The basic structure of the IRPs is defined in 3GPP TS 32.150 [1].
182
+
183
+ A single network fault may generate a large number of alarms over space and time. In a large and complex network, simultaneous network faults may occur, causing the network operator to be flooded with high volume of alarms. The high volume of alarms, typically the one received by an IRPManager via the getAlarmList or alarm notifications of Alarm IRP specification, greatly inhibits the operator ability to quickly identify and locate the responsible network faults. AAM IRP is intended to provide methods to improve this situation.
184
+
185
+ # --- 1 Scope
186
+
187
+ The purpose of Advanced Alarm Management (AAM) IRP is to define an interface through which an IRPManager can categorize alarm notifications.
188
+
189
+ The present document is the Information Service of AAM. It defines, for the purpose of categorizing alarm notifications, the information observable and controlled by management system's client and it also specifies the semantics of the interactions used to carry this information.
190
+
191
+ # --- 2 References
192
+
193
+ The following documents contain provisions that, through reference in this text, constitute provisions of the present document.
194
+
195
+ - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
196
+ - For a specific reference, subsequent revisions do not apply.
197
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document in the same Release as the present document.
198
+
199
+ - [1] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions".
200
+ - [2] 3GPP TS 32.102: "Telecommunication management; Architecture".
201
+ - [3] 3GPP TS 32.302: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP): Information Service (IS)".
202
+ - [4] 3GPP TS 32.121: "Telecommunication management; Advanced Alarm Management Reference Point (IRP): Requirements".
203
+ - [5] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions".
204
+ - [6] 3GPP TS 32.622: "Telecommunication management; Configuration Management (CM); Generic network resources Integration Reference Point (IRP): Network Resource Model (NRM)".
205
+ - [7] 3GPP TS 32.312: "Telecommunication management; Generic Integration Reference Point (IRP) management; Information Service (IS)".
206
+ - [8] 3GPP TS 32.602: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP): Information Service (SS)".
207
+ - [9] 3GPP TS 32.662: "Telecommunication management; Configuration Management (CM); Kernel CM; Information service (IS)".
208
+
209
+ # --- 3 Definitions and abbreviations
210
+
211
+ ## 3.1 Definitions
212
+
213
+ For the purposes of the present document, the following terms and definitions apply:
214
+
215
+ **IRP:** See 3GPP TS 32.150 [1].
216
+
217
+ **IRPAgent:** See 3GPP TS 32.150 [1].
218
+
219
+ **IRPManager:** See 3GPP TS 32.150 [1].
220
+
221
+ **Alike Alarm:** Two alarms are considered alike, if the corresponding alarm notifications are issued by the same object instance with the same `alarmType`, same `perceivedSeverity`, same `probableCause` and same `specificProblem` (if present).
222
+
223
+ **Lower Edge of Time Window:** The point in time which determines the begin of a time span.
224
+
225
+ **Upper Edge of Time Window:** The point in time which determines the end of a time span.
226
+
227
+ ## 3.2 Abbreviations
228
+
229
+ For the purposes of the present document, the following abbreviations apply:
230
+
231
+ | | |
232
+ |---------|--------------------------------|
233
+ | AAM | Advanced Alarm Management |
234
+ | AAMRule | Advanced Alarm Management Rule |
235
+ | CM | Configuration Management |
236
+ | EM | Element Manager |
237
+ | IOC | Information Object Class |
238
+ | IRP | Integration Reference Point |
239
+ | IS | Information Service |
240
+ | Itf-N | Interface N |
241
+ | MIB | Management Information Base |
242
+ | NE | Network Element |
243
+
244
+ # 4 System overview
245
+
246
+ ## 4.1 System context
247
+
248
+ The general definition of the System Context for the present IRP is found in 3GPP TS 32.150 [5], clause 4.7.
249
+
250
+ In addition, the set of related IRP(s) relevant to the present IRP is shown in figures 4.1-1 and 4.1-2.
251
+
252
+ ![Figure 4.1-1: System Context A. A diagram showing an IRPManager (NM) connected to an IRPAgent (EM), which is connected to multiple NEs. A notification path is shown from the IRPAgent to the Advanced Alarm Management IRP via the Itf-N interface.](49ee89a1d5852ab005dbbab6de09a8a6_img.jpg)
253
+
254
+ The diagram illustrates System Context A. On the left, a box labeled 'NM' contains 'IRPManager'. A solid line connects it to a box labeled 'EM' containing 'IRPAgent'. A dotted line connects the 'IRPAgent' to a box labeled 'NEs'. A vertical dashed line, labeled 'Itf-N' at its base, separates the 'IRPManager' from the 'IRPAgent'. A curved arrow points from the 'IRPAgent' to the 'Itf-N' interface. From the 'Itf-N' interface, a vertical line leads to a horizontal line labeled 'Notification'. To the right of this line is the text 'Advanced Alarm Management IRP'.
255
+
256
+ Figure 4.1-1: System Context A. A diagram showing an IRPManager (NM) connected to an IRPAgent (EM), which is connected to multiple NEs. A notification path is shown from the IRPAgent to the Advanced Alarm Management IRP via the Itf-N interface.
257
+
258
+ Figure 4.1-1: System Context A
259
+
260
+ ![Figure 4.1-2: System Context B. A diagram showing an IRPManager (NM) connected to an IRPAgent (NE), which is connected to the Advanced Alarm Management IRP via the Itf-N interface.](0236eff05bcb8f3a343ea7933aaa306b_img.jpg)
261
+
262
+ The diagram illustrates System Context B. On the left, a box labeled 'NM' contains 'IRPManager'. A solid line connects it to a box labeled 'NE' containing 'IRPAgent'. A vertical dashed line, labeled 'Itf-N' at its base, separates the 'IRPManager' from the 'IRPAgent'. A curved arrow points from the 'IRPAgent' to the 'Itf-N' interface. From the 'Itf-N' interface, a vertical line leads to a horizontal line labeled 'Notification IRP'. To the right of this line is the text 'Advanced Alarm Management IRP'.
263
+
264
+ Figure 4.1-2: System Context B. A diagram showing an IRPManager (NM) connected to an IRPAgent (NE), which is connected to the Advanced Alarm Management IRP via the Itf-N interface.
265
+
266
+ Figure 4.1-2: System Context B
267
+
268
+ # 5 Information Object Classes
269
+
270
+ ## 5.1 Imported information entities and local labels
271
+
272
+ | Label reference | Local label |
273
+ |-----------------------------------------------------------------|-------------------|
274
+ | 3GPP TS 32.622 [6], information object class, Top | Top |
275
+ | 3GPP TS 32.312 [7], information object class, managedGenericIRP | managedGenericIRP |
276
+ | 3GPP TS 32.622 [6], information object class, IRPAgent | IRPAgent |
277
+
278
+ ## 5.2 Class diagram
279
+
280
+ ### 5.2.1 Attributes and relationships
281
+
282
+ This clause depicts the set of IOC that encapsulate information within the AAM IRP. The intent is to identify the information required for the AAM IRP implementation of its operations and notification emission.
283
+
284
+ This clause provides the overview of all Information Object Classes in UML.
285
+
286
+ Subsequent clauses provide more detailed specification of various aspects of these Information Object Classes.
287
+
288
+ ![UML Class Diagram showing AdvancedAlarmManagementIRP and AdvancedAlarmManagementRule classes.](e1a0d046fbe7f28f5e93a47091851747_img.jpg)
289
+
290
+ ```
291
+ classDiagram
292
+ class AdvancedAlarmManagementIRP {
293
+ <<InformationObjectClass>>
294
+ }
295
+ class AdvancedAlarmManagementRule {
296
+ <<InformationObjectClass>>
297
+ aAMRuleIdentifier
298
+ aAMRuleType
299
+ aAMRuleParameterList
300
+ filter
301
+ }
302
+ AdvancedAlarmManagementIRP "1" *-- "0..*" AdvancedAlarmManagementRule
303
+ ```
304
+
305
+ The diagram shows two classes: **AdvancedAlarmManagementIRP** and **AdvancedAlarmManagementRule**. **AdvancedAlarmManagementIRP** is at the top and has a stereotype `<<InformationObjectClass>>`. **AdvancedAlarmManagementRule** is at the bottom and also has a stereotype `<<InformationObjectClass>>`. It lists four attributes: `aAMRuleIdentifier`, `aAMRuleType`, `aAMRuleParameterList`, and `filter`. A red line with a solid diamond at the top connects **AdvancedAlarmManagementIRP** to **AdvancedAlarmManagementRule**. The multiplicity `0..*` is shown near the bottom class.
306
+
307
+ UML Class Diagram showing AdvancedAlarmManagementIRP and AdvancedAlarmManagementRule classes.
308
+
309
+ Figure 5.2.1-1: Class Diagram
310
+
311
+ ### 5.2.2 Inheritance
312
+
313
+ This clause depicts the inheritance relationships that exist between Information Object Classes.
314
+
315
+ ![UML inheritance diagram showing AdvancedAlarmManagementRP inheriting from ManagedGenericRP.](562f471e8153729557e6a4ee6343c32c_img.jpg)
316
+
317
+ ```
318
+ classDiagram
319
+ class ManagedGenericRP {
320
+ <<InformationObjectClass>>
321
+ (from 32.622)
322
+ }
323
+ class AdvancedAlarmManagementRP {
324
+ <<InformationObjectClass>>
325
+ }
326
+ ManagedGenericRP <|-- AdvancedAlarmManagementRP
327
+ ```
328
+
329
+ The diagram illustrates an inheritance relationship between two Information Object Classes. The base class, **ManagedGenericRP** (from 32.622), is shown in a yellow box at the top. The derived class, **AdvancedAlarmManagementRP**, is shown in a yellow box at the bottom. A vertical line with an open triangle arrowhead points from the derived class to the base class, indicating that **AdvancedAlarmManagementRP** inherits from **ManagedGenericRP**.
330
+
331
+ UML inheritance diagram showing AdvancedAlarmManagementRP inheriting from ManagedGenericRP.
332
+
333
+ **Figure 5.2.2-1: Inheritance Diagram**
334
+
335
+ ## 5.3 Information Object Class definitions
336
+
337
+ ### 5.3.1 advancedAlarmManagementRule
338
+
339
+ #### 5.3.1.1 Definition
340
+
341
+ ##### 5.3.1.1.1 General Definition
342
+
343
+ This information object represents an AAM Rule object instance.
344
+
345
+ An AdvancedAlarmManagementRule is fully identified by its distinguished name.
346
+
347
+ It inherits from IOC top.
348
+
349
+ An AAM Rule is a way for the IRPManager to define which alarms / alarm clearings deliver significant or insignificant information (significant seen with the eyes of the IRPManager) and to tell the IRPAgent not to send the insignificant alarms / alarm clearings.
350
+
351
+ AAMRules will not screen out all insignificant alarms/alarm clearings, but contribute to enable the network operator to reduce the number of reported alarms to a reasonable and manageable level.
352
+
353
+ The choice of rule/s may depend on the type of alarm, the environment, the time of day and many more.
354
+
355
+ To avoid screening of alarms which might be important for the network operator, the user of AAM rules should apply AAMrules with careful consideration and appropriate setting of parameters.
356
+
357
+ An AAM Rule instance is fully identified by its DN distinguished name. A Rule instance carries, among other things, the identification of the Rule type called AdvancedAlarmManagementRuleType. Of these there exist the following:
358
+
359
+ - ThresholdRule
360
+ - TransientRule
361
+ - ToggleRule
362
+ - VendorSpecificRule
363
+
364
+ See Annex A for the description of the above Rules.
365
+
366
+ #### 5.3.1.2 Attributes
367
+
368
+ | Attribute name | Support Qualifier | Read Qualifier | Write Qualifier |
369
+ |------------------------------------------|-------------------|----------------|-----------------|
370
+ | advancedAlarmManagementRuleIdentifier | M | M | - |
371
+ | advancedAlarmManagementRuleType | M | M | - |
372
+ | advancedAlarmManagementRuleParameterList | M | M | - |
373
+ | filter | M | M | - |
374
+
375
+ ### 5.3.2 advancedAlarmManagementIRP
376
+
377
+ #### 5.3.2.1 Definition
378
+
379
+ This information object represents an AAM IRP. It inherits from IOC managedGenericIRP.
380
+
381
+ ## 5.4 Information relationships definition
382
+
383
+ ### 5.4.1 relation- AdvancedAlarmManagementIRP-AdvancedAlarmManagementRule (M)
384
+
385
+ #### 5.4.1.1 Definition
386
+
387
+ This relationship defines the relationship between an AdvancedAlarmManagementIRP and an AdvancedAlarmManagementRule instance.
388
+
389
+ #### 5.4.1.2 Roles
390
+
391
+ | Name | Definition |
392
+ |--------------------------------|--------------------------------------------------------------------------------------------------------------------------|
393
+ | theAdvancedAlarmManagementRule | This role represents an AAM Rule. It can be played by instances of IOC advancedAlarmingRule |
394
+ | theAdvancedAlarmManagementIRP | This role represents the AAM IRP which an IRPManager uses. It is played by instances of IOC advancedAlarm Management IRP |
395
+
396
+ #### 5.4.1.3 Constraints
397
+
398
+ None
399
+
400
+ ## 5.5 Information attributes definition
401
+
402
+ This clause defines the semantics of the Attributes used in Information Object Classes.
403
+
404
+ ### 5.5.1 Definitions and legal values
405
+
406
+ | Attribute Name | Definition | Legal Values |
407
+ |------------------------------------------|-------------------------------------------------------------------------|--------------|
408
+ | advancedAlarmManagementRuleIdentifier | This attribute identifies uniquely an AAM Rule base object instance | String |
409
+ | advancedAlarmManagementRuleType | This attribute indicates the type of AAM Rule this instance represents. | String |
410
+ | advancedAlarmManagementRuleParameterList | This attribute identifies parameters and values of this AAM Rule | N/A |
411
+
412
+ # --- 6 Interface Definition
413
+
414
+ ## 6.1 Class diagram representing interfaces
415
+
416
+ ![UML Class Diagram showing AdvancedAlarmManagementRP as an InformationObjectClass and AdvancedAlarmManagementRPOperation_1 as an Interface with methods: activateAAMRule(), deactivateAAMRule(), and getAAMRules(). A dashed inheritance arrow points from the class to the interface.](042733dc5e8e7f5f30b60adba3266cde_img.jpg)
417
+
418
+ ```
419
+ classDiagram
420
+ class AdvancedAlarmManagementRP {
421
+ <<InformationObjectClass>>
422
+ }
423
+ class AdvancedAlarmManagementRPOperation_1 {
424
+ <<Interface>>
425
+ activateAAMRule()
426
+ deactivateAAMRule()
427
+ getAAMRules()
428
+ }
429
+ AdvancedAlarmManagementRP ..|> AdvancedAlarmManagementRPOperation_1
430
+ ```
431
+
432
+ UML Class Diagram showing AdvancedAlarmManagementRP as an InformationObjectClass and AdvancedAlarmManagementRPOperation\_1 as an Interface with methods: activateAAMRule(), deactivateAAMRule(), and getAAMRules(). A dashed inheritance arrow points from the class to the interface.
433
+
434
+ Figure 6.1-1: Class Diagram for AdvancedAlarmManagementRPOperation\_1 Interface
435
+
436
+ ## 6.2 AAMIRPOperation\_1 Interface (M)
437
+
438
+ ### 6.2.1 Scope
439
+
440
+ This interface defines methods for the IRPManager to request for alarm notifications of significant information (significant from the IRPManager's perspective).
441
+
442
+ The definition of insignificance is determined by the IRPManager. The choice of AAM Rule/s may depend on the type of alarm, the environment, the time of day and many more.
443
+
444
+ An implementation can claim compliance to this IRP if it supports at least one of the AAMRules, i.e. one of the operations defined in clause 6.2.2 up to and including clause 6.2.5, and the mandatory operations defined in this interface.
445
+
446
+ ### 6.2.2 Operation activateAAMRule (M)
447
+
448
+ #### 6.2.2.1 Definition
449
+
450
+ This operation allows an IRPManager to activate an AAM rule (see §A.3.1.1.2.1).
451
+
452
+ #### 6.2.2.2 Input parameters
453
+
454
+ ##### 6.2.2.2.1 Generic Input parameters
455
+
456
+ | Parameter Name | Qualifier | Information type | Comment |
457
+ |----------------------|-----------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
458
+ | aAMRuleType | M | N/A | This corresponds to attribute advancedAlarmManagementRuleType of advancedAlarmManagementRule (see 5.3.1.2)<br>Values: ThresholdRule, TransientRule, ToggleRule, VendorSpecificRule |
459
+ | aAMRuleParameterList | M | N/A | This corresponds to attribute advancedAlarmManagementRuleParameterList of advancedAlarmManagementRule (see 5.3.1.2)<br>Content depends on value of advancedAlarmManagementRuleType |
460
+ | filter | M | N/A | This corresponds to attribute filter of advancedAlarmManagementRule (see 5.3.1.2)<br>Carries a filter constraint. It can e.g. comprise objectClass, objectInstance, alarmType, probableCause, perceivedSeverity, specificProblem. |
461
+
462
+ ##### 6.2.2.2.2 Content of Input parameter aAMRuleParameterList depending on value of aAMRuleType
463
+
464
+ ###### 6.2.2.2.2.1 aAMRuleType = ThresholdRule
465
+
466
+ | Parameter Name | Qualifier | Information type | Comment |
467
+ |-------------------------|-----------|------------------|---------------|
468
+ | alarmOccurenceThreshold | M | N/A | value >0 |
469
+ | slidingTimeWindow | M | N/A | Unit: minutes |
470
+
471
+ ###### 6.2.2.2.1.2 aAMRuleType = TransientRule
472
+
473
+ | Parameter Name | Qualifier | Information type | Comment |
474
+ |----------------|-----------|------------------|---------------|
475
+ | timeSpan | M | N/A | Unit: minutes |
476
+
477
+ ###### 6.2.2.2.2.3 aAMRuleType = ToggleRule
478
+
479
+ | Parameter Name | Qualifier | Information type | Comment |
480
+ |----------------------------------|-----------|------------------|---------------|
481
+ | alarmOccurenceThreshold | M | N/A | value>0 |
482
+ | slidingTimeWindowTogglingStarted | M | N/A | Unit: minutes |
483
+ | slidingTimeWindowTogglingSettled | M | N/A | Unit: minutes |
484
+
485
+ ###### 6.2.2.2.2.4 aAMRuleType = vendorSpecificRule
486
+
487
+ | Parameter Name | Qualifier | Information type | Comment |
488
+ |----------------------------|-----------|------------------|---------|
489
+ | vendor specific parameters | N/A | N/A | N/A |
490
+
491
+ #### 6.2.2.3 Output parameters
492
+
493
+ | Parameter Name | Qualifier | Matching Information | Comment |
494
+ |-------------------|-----------|-----------------------------------------------|------------|
495
+ | aAMRuleIdentifier | M | N/A | See §5.5.1 |
496
+ | status | M | ENUM (Success, Failure, aAMRuleAlreadyActive) | |
497
+
498
+ #### 6.2.2.4 Pre-condition
499
+
500
+ AAMIsSupported
501
+
502
+ | Assertion Name | Definition |
503
+ |----------------|------------------------------------------------------|
504
+ | aAMIsSupported | The AAM functionality is supported by the IRP Agent. |
505
+
506
+ #### 6.2.2.5 Post-condition
507
+
508
+ AAMRuleIsApplied
509
+
510
+ | Assertion Name | Definition |
511
+ |------------------|-------------------------------------------------------------------------------|
512
+ | aAMRuleIsApplied | The AAM rule is applied. For the consequences see the definitions in Annex A. |
513
+
514
+ #### 6.2.2.6 Exceptions
515
+
516
+ | Name | Properties |
517
+ |------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
518
+ | operation_failed | <b>Condition:</b> the pre-condition is false or the post-condition is false.<br><b>Returned Information:</b> The output parameter status.<br><b>Exit state:</b> Entry state. |
519
+
520
+ ### 6.2.3 Operation getAAMRules (M)
521
+
522
+ #### 6.2.3.1 Definition
523
+
524
+ This operation allows an IRPManager to request from the IRPAgent a list of activated AAMRules.
525
+
526
+ #### 6.2.3.2 Input parameters
527
+
528
+ None
529
+
530
+ #### 6.2.3.3 Output parameters
531
+
532
+ | Parameter Name | Qualifier | Matching Information | Comment |
533
+ |----------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------|
534
+ | aAMRuleList | M | LIST of aAMRuleInstance {<br><br>aAMRuleInstance<br>LIST OF {<br>aAMRuleIdentifier,<br>aAMRuleType,<br>aAMRuleParameterList,<br>filter<br>}<br><br>aAMRuleType<br>ENUM (<br>thresholdRule,<br>toggleRule,<br>transientRule,<br>vendorSpecificRule<br>)<br><br>aAMRuleParameterList:<br>Content type depends on the value of<br>aAMRuleType (see §6.2.2) | |
535
+ | Status | M | ENUM (Success, Failure) | If no rule is defined, an empty advancedAlarmManagementRuleList a shall be delivered and status==Success. |
536
+
537
+ #### 6.2.3.4 Pre-condition
538
+
539
+ None
540
+
541
+ #### 6.2.3.5 Post-condition
542
+
543
+ allActiveAdvanceAlarmManagementRulesAreDelivered
544
+
545
+ | Assertion Name | Definition |
546
+ |-------------------------------------------|------------------------------------------------|
547
+ | allActiveAlarmManagementRulesAreDelivered | All active AAM rules are listed in the output. |
548
+
549
+ #### 6.2.3.6 Exceptions
550
+
551
+ | Name | Properties |
552
+ |------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
553
+ | operation_failed | <b>Condition:</b> the pre-condition is false or the post-condition is false.<br><b>Returned Information:</b> The output parameter status.<br><b>Exit state:</b> Entry state. |
554
+
555
+ ### 6.2.4 Operation deactivateAAMRule (M)
556
+
557
+ #### 6.2.4.1 Definition
558
+
559
+ This operation allows an IRPManager to request from the IRPAgent to deactivate one or all activated AAMRules.
560
+
561
+ Deactivated rules are not visible for the IRPManager.
562
+
563
+ #### 6.2.4.2 Input parameters
564
+
565
+ | Parameter Name | Qualifier | Information type | Comment |
566
+ |---------------------------------------|-----------|------------------|--------------------------------------------------------------------------------------------|
567
+ | advancedAlarmManagementRuleIdentifier | M | See 32.302 [3] | If this parameter contains no information, then all active AAM Rules shall be deactivated. |
568
+
569
+ #### 6.2.4.3 Output parameters
570
+
571
+ | Parameter Name | Qualifier | Matching Information | Comment |
572
+ |----------------|-----------|---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
573
+ | status | M | ENUM (Success, SpecifiedRuleNotExisting, Failure) | If input parameter advancedAlarmManagementRuleIdentifier is present and no such rule exists, then status==SpecifiedRuleNotExisting.<br>If input parameter advancedAlarmManagementRuleIdentifier is not present and no rule is defined, then status==Success. |
574
+
575
+ #### 6.2.4.4 Pre-condition
576
+
577
+ None
578
+
579
+ #### 6.2.4.5 Post-condition
580
+
581
+ allOrSpecifiedActiveAdvanceAlarmManagementRulesAreDeactivated
582
+
583
+ | Assertion Name | Definition |
584
+ |---------------------------------------------------------------|-------------------------------------------------------------------------------------|
585
+ | allOrSpecifiedActiveAdvanceAlarmManagementRulesAreDeactivated | Depending on the input all or only the specified active AAM Rule are/is deactivated |
586
+
587
+ #### 6.2.4.6 Exceptions
588
+
589
+ | Name | Properties |
590
+ |------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
591
+ | operation_failed | <b>Condition:</b> the pre-condition is false or the post-condition is false.<br><b>Returned Information:</b> The output parameter status.<br><b>Exit state:</b> Entry state. |
592
+
593
+ # --- Annex A (normative): Advanced Alarm Management Rules
594
+
595
+ ## A.1 General
596
+
597
+ It is not recommended to have several AAMRules applicable at one time for one event. However, if YyyFunction supports and allows it, then it is vendor specific which AAMRule is applied or not.
598
+
599
+ An AAMRule (called Rule hereafter) contains multiple elements.
600
+
601
+ The first element (subSection titled: Criterion to determine alike alarm) is a criterion used to determine if an alarm is classified as ‘alike’ or “not alike”. If the alarm is not-alike, then the alarm is not subject to further scrutiny (processing) by the Rule, i.e. it would be processed as if there is no Rule in effect. The IRPManager specifies such criterion in an input parameter named filter in various relevant AAM operations.
602
+
603
+ The second element (subSection titled: Treatment of alike alarm) is the algorithm to determine if
604
+
605
+ - a) An alike alarm should be reported as one alarm (i.e. it is a significant alarm) or
606
+ - b) The alike alarm should be suppressed (i.e. it is an insignificant alarm).
607
+
608
+ When a significant alarm is identified, the algorithm also determines:
609
+
610
+ - a) The time when the notifyNew/Changed/ClearedAlarm of this significant alarm should be sent to IRPManager and
611
+ - b) The value of alarmRaisedTime, alarmChangedTime and alarmClearedTime parameters in the relevant notifyNew/Changed/ClearedAlarm of this significant alarm.
612
+
613
+ The third element (subSection titled: Relation to Log and AlarmList) specifies which alarms shall enter into Log of LogIRP and AlarmList of AlarmIRP.
614
+
615
+ Each of the following subsections defines a Rule using the three-element description outlined above.
616
+
617
+ For each Rule, illustration samples, using symbols shown below, are given (titled: Samples). The thick horizontal line indicates a time-line. The dotted double-arrow line indicates a time parameter, if applicable. The “?” box indicates the alarm under investigation. The left-edge of a box corresponds to the alarmRaisedTime while the right-edge corresponds to the alarmClearedTime. So, the horizontal span of a box indicates the alarm active time span.
618
+
619
+ ![Figure A.1-1: Sample diagram notations. A horizontal timeline with an arrow pointing right, labeled 't' at the end. A shaded rectangular box with a question mark '?' inside is positioned above the timeline. The left edge of the box is aligned with a vertical dotted line, and the right edge is aligned with another vertical dotted line. These dotted lines extend downwards to the timeline.](aa9441a5971655a79987d70fc551b26a_img.jpg)
620
+
621
+ Figure A.1-1: Sample diagram notations. A horizontal timeline with an arrow pointing right, labeled 't' at the end. A shaded rectangular box with a question mark '?' inside is positioned above the timeline. The left edge of the box is aligned with a vertical dotted line, and the right edge is aligned with another vertical dotted line. These dotted lines extend downwards to the timeline.
622
+
623
+ **Figure A.1-1: Sample diagram notations**
624
+
625
+ Sometimes, a shaded box is drawn below the time line as below. Such shaded box indicates the identification of a significant alarm (to be reported alarm).
626
+
627
+ The left-edge of the box indicates the time when the corresponding alarm notification is sent out. This emission time is not necessarily identical to the alarmRaised/ChangedTime within the alarm notification.
628
+
629
+ The right-edge of a box indicates the time when the corresponding alarm clearing notification is sent out. This emission time is not necessarily identical to the alarmClearedTime within the alarm notification.
630
+
631
+ ![A diagram showing a horizontal timeline labeled 't' at the right end. A rectangular box is centered on the timeline, with its top half being light gray and containing a question mark '?', and its bottom half being dark gray.](9c6461e1e94afae4dec455e69a2ce152_img.jpg)
632
+
633
+ A horizontal timeline with an arrow pointing to the right, labeled with the letter 't' at the far right. Centered on this timeline is a rectangular box. The box is divided into two horizontal sections: the top section is light gray and contains a black question mark '?', and the bottom section is dark gray.
634
+
635
+ A diagram showing a horizontal timeline labeled 't' at the right end. A rectangular box is centered on the timeline, with its top half being light gray and containing a question mark '?', and its bottom half being dark gray.
636
+
637
+ **Figure A.1-2: Sample diagram notations**
638
+
639
+ For each Rule, use cases are given (subSection titled: Example for Use cases).
640
+
641
+ For some Rules exception handling is defined (subSection titled: Exception Handling).
642
+
643
+ ## --- A.2 AAM Rules
644
+
645
+ ### A.2.1 Threshold Rule
646
+
647
+ #### A.2.1.1 Parameters
648
+
649
+ This Rule has three parameters, namely, the `alarmOccurenceThreshold` (called N here), the `slidingTimeWindow` (called T here) and `filter`.
650
+
651
+ #### A.2.1.2 Criterion to determine alike alarm
652
+
653
+ The `filter` parameter carries values for `objectInstance`, `alarmType`, `perceivedSeverity`, `probableCause` and `specificProblem`. If the alarm under investigation (e.g. the box with a “?” in the sample below) carries the same values, then it is considered ‘alike’ otherwise, “not-alike”.
654
+
655
+ #### A.2.1.3 Treatment of alike alarm
656
+
657
+ Starting value for Lower Edge of Time Window is the activation time of the threshold rule.
658
+
659
+ Test an alike alarm.
660
+
661
+ When a new alarm matches the filter, then Lower and Upper Edge of Time Window and count are newly determined: Upper Edge of Time Window becomes the time of the new alarm.
662
+
663
+ Lower Edge of Time Window becomes either the time of the current Lower Edge of Time Window or the time of the new alarm minus the default size T of the time window, whichever of these two times is later.
664
+
665
+ The count is the number of alarms between Lower and Upper Edge of Time Window (including the new alarm). If the count reaches the threshold N, then the alarm is considered as significant and the Lower Edge of Time Window becomes the time of the alarm.
666
+
667
+ For a not reported alarm no `notifyClearedAlarm` shall be sent.
668
+
669
+ `NotifyClearedAlarms` for alarms which were reported to the `IRPManager` before the activation of the threshold rule shall not be suppressed.
670
+
671
+ Table A.2.1.3-1 shows the emission times of the various related to a significant alarm.
672
+
673
+ **Table A.2.1.3-1: Significant alarm emission time for Threshold Rule**
674
+
675
+ | Reported alarm types | Emission (to IRPManager) times of a reported alarm |
676
+ |---------------------------------|-------------------------------------------------------|
677
+ | <code>notifyNewAlarm</code> | Immediately after the <code>alarmRaisedTime</code> . |
678
+ | <code>notifyChangedAlarm</code> | Immediately after the <code>alarmChangedTime</code> . |
679
+ | <code>notifyClearedAlarm</code> | Immediately after the <code>alarmClearedTime</code> |
680
+
681
+ Table A.2.1.3-2 shows the time related parameters in significant alarm.
682
+
683
+ **Table A.2.1.3-2: Significant alarm time parameters for Threshold Rule**
684
+
685
+ | Parameters of the Reported alarm | Parameter values |
686
+ |----------------------------------|------------------------------------------------|
687
+ | <code>alarmRaisedTime</code> | Same value as that carried in the alike alarm. |
688
+ | <code>alarmChangedTime</code> | Same value as that carried in the alike alarm. |
689
+ | <code>notifyClearedTime</code> | Same value as that carried in the alike alarm. |
690
+ | <code>alarmId</code> | Same value as that carried in the alike alarm. |
691
+
692
+ #### A.2.1.4 Relation to Log and AlarmList
693
+
694
+ The alike alarms enter the Log. The significant alarms enter the AlarmList.
695
+
696
+ #### A.2.1.5 Samples
697
+
698
+ ![Timeline diagram showing two alarms within a threshold T. The first alarm is a small gray rectangle. The second alarm is a small gray rectangle with a question mark '?' inside. A dotted double-headed arrow labeled 'T' spans the time between the start of the first alarm and the start of the second alarm. The horizontal axis is labeled 't' at the right end.](ebce355620876e10f907f8b71926c112_img.jpg)
699
+
700
+ N=3
701
+
702
+ A horizontal timeline labeled 't' at the right end. Above the timeline, a dotted double-headed arrow labeled 'T' spans from the start of a small gray rectangle to the start of another small gray rectangle containing a question mark '?'. The label 'N=3' is positioned to the left of the timeline.
703
+
704
+ Timeline diagram showing two alarms within a threshold T. The first alarm is a small gray rectangle. The second alarm is a small gray rectangle with a question mark '?' inside. A dotted double-headed arrow labeled 'T' spans the time between the start of the first alarm and the start of the second alarm. The horizontal axis is labeled 't' at the right end.
705
+
706
+ FigureA.2.1.5-1: Threshold Rule illustrations – insignificant alarm
707
+
708
+ ![Timeline diagram showing three alarms within a threshold T. The first alarm is a wide gray rectangle. The second alarm is a small gray rectangle. The third alarm is a small gray rectangle with a question mark '?' inside. A dotted double-headed arrow labeled 'T' spans the time between the start of the first alarm and the start of the third alarm. The horizontal axis is labeled 't' at the right end.](723827e0738d2743c3b3423760a5c48e_img.jpg)
709
+
710
+ N=3
711
+
712
+ A horizontal timeline labeled 't' at the right end. Above the timeline, a dotted double-headed arrow labeled 'T' spans from the start of a wide gray rectangle to the start of a small gray rectangle containing a question mark '?'. A second small gray rectangle is positioned between them. The label 'N=3' is positioned to the left of the timeline.
713
+
714
+ Timeline diagram showing three alarms within a threshold T. The first alarm is a wide gray rectangle. The second alarm is a small gray rectangle. The third alarm is a small gray rectangle with a question mark '?' inside. A dotted double-headed arrow labeled 'T' spans the time between the start of the first alarm and the start of the third alarm. The horizontal axis is labeled 't' at the right end.
715
+
716
+ FigureA.2.1.5-2: Threshold Rule illustrations – insignificant alarm
717
+
718
+ ![Timeline diagram showing three alarms within a threshold T. The first two alarms are small gray rectangles. The third alarm is a large gray rectangle with a question mark '?' inside, which extends below the timeline. A dotted double-headed arrow labeled 'T' spans the time between the start of the first alarm and the start of the third alarm. The horizontal axis is labeled 't' at the right end.](812b773680b611c18d49243e102b895a_img.jpg)
719
+
720
+ N=3
721
+
722
+ A horizontal timeline labeled 't' at the right end. Above the timeline, a dotted double-headed arrow labeled 'T' spans from the start of a small gray rectangle to the start of a large gray rectangle containing a question mark '?'. A second small gray rectangle is positioned between them. The large gray rectangle extends both above and below the timeline. The label 'N=3' is positioned to the left of the timeline.
723
+
724
+ Timeline diagram showing three alarms within a threshold T. The first two alarms are small gray rectangles. The third alarm is a large gray rectangle with a question mark '?' inside, which extends below the timeline. A dotted double-headed arrow labeled 'T' spans the time between the start of the first alarm and the start of the third alarm. The horizontal axis is labeled 't' at the right end.
725
+
726
+ FigureA.2.1.5-3: Threshold Rule illustrations – significant alarm
727
+
728
+ #### A.2.1.6 Example for Use cases
729
+
730
+ The thresholdRule can be used to screen out alarms which are only important if they appear repeatedly, e.g. if an alarm which is self-healing comes back again and again,
731
+
732
+ ### A.2.2 Transient Rule
733
+
734
+ #### A.2.2.1 Parameters
735
+
736
+ This Rule has two parameters, namely, the minutesAtLeastActive (called T here) and filter.
737
+
738
+ #### A.2.2.2 Criterion to determine alike alarm
739
+
740
+ The filter parameter carries values for objectInstance, alarmType, perceivedSeverity, probableCause and specificProblem. If the alarm under investigation (e.g. the box with a ‘?’ in the sample below) carries the identified parameters and having the same values, then it is considered ‘alike’ otherwise, "not-alike".
741
+
742
+ #### A.2.2.3 Treatment of alike alarm
743
+
744
+ Take an alike alarm. If it's period is smaller than T, then it is an insignificant alarm; otherwise, it is a significant alarm. For a not reported alarm no notifyClearedAlarm shall be sent.
745
+
746
+ NotifyClearedAlarms for alarms which were reported to the IRPManager before the activation of the transientRule shall not be suppressed.
747
+
748
+ Table A.2.2.3-1 shows the emission times of the various related to significant alarm.
749
+
750
+ **Table A.2.2.3-1: Significant alarm emission time re: Transient Rule**
751
+
752
+ | Reported alarm type | Emission (to IRPManager) times of an Reported alarm |
753
+ |---------------------|-----------------------------------------------------|
754
+ | notifyNewAlarm | Immediately after the alarmRaisedTime plus T. |
755
+ | notifyChangedAlarm | Immediately after the alarmChangedTime plus T. |
756
+ | notifyClearedAlarm | Immediately after the alarmClearedTime |
757
+
758
+ Table A.2.2.3-2 shows the time related parameters in significant alarm.
759
+
760
+ **Table A.2.2.3-2: Significant alarm time parameters re: Transient Rule**
761
+
762
+ | Parameters of the Reported alarm | Parameter values |
763
+ |----------------------------------|------------------------------------------------|
764
+ | alarmRaisedTime | Same value as that carried in the alike alarm. |
765
+ | alarmChangedTime | Same value as that carried in the alike alarm. |
766
+ | notifyClearedTime | Same value as that carried in the alike alarm |
767
+ | alarmId | Same value as that carried in the alike alarm. |
768
+
769
+ #### A.2.2.4 Relation to Log and AlarmList
770
+
771
+ The alike alarms enter the Log. The significant alarms enter the AlarmList.
772
+
773
+ #### A.2.2.5 Samples
774
+
775
+ Here are two samples. One is a not-to-be reported alarm while the other is a significant alarm.
776
+
777
+ ![Diagram of an insignificant alarm](9b5411fa2d169b66f6185fbf67b49766_img.jpg)
778
+
779
+ N=3
780
+
781
+ A horizontal timeline labeled 't' at the right end. A light gray rectangular box with a question mark '?' is positioned on the timeline. Above the box, a horizontal dotted line with arrows at both ends spans its width and is labeled 'T' above its center.
782
+
783
+ Diagram of an insignificant alarm
784
+
785
+ Figure A.2.2.5-1: TransientRule Illustrations – insignificant alarm
786
+
787
+ ![Diagram of a significant alarm](50fecd0e7c9bf4ebf321d8367d42cc94_img.jpg)
788
+
789
+ N=3
790
+
791
+ A horizontal timeline labeled 't' at the right end. A light gray rectangular box with a question mark '?' is positioned on the timeline. Above the box, a horizontal dotted line with arrows at both ends spans its width and is labeled 'T' above its center. A second, darker gray rectangular box is positioned below the timeline, partially overlapping the right side of the first box.
792
+
793
+ Diagram of a significant alarm
794
+
795
+ Figure A.2.2.5-2: TransientRule Illustrations – significant alarm
796
+
797
+ #### A.2.2.6 Example for Use cases
798
+
799
+ The transientRule can be used to screen out alarms which usually are of temporarily nature.
800
+
801
+ ### A.2.3 Toggle Rule
802
+
803
+ #### A.2.3.1 Parameters
804
+
805
+ This Rule has 4 parameters, namely, the filter, the alarmOccurenceThreshold (called N here), the slidingTimeWindowTogglingStarted (called T1 here) and slidingTimeWIndowTogglingSettled (called T2 here).
806
+
807
+ #### A.2.3.2 Criterion to determine alike alarm
808
+
809
+ The filter parameter carries values for objectInstance, alarmType, perceivedSeverity, probableCause and specificProblem. If the alarm under investigation (e.g. the box with a '?' in the sample below) carries the identified parameters and having the same values, then it is considered 'alike' otherwise, "not-alike".
810
+
811
+ #### A.2.3.3 Treatment of alike alarm
812
+
813
+ ##### 1. Starting values:
814
+
815
+ Starting value for Lower Edges of Time Windows for Toggling Started/Settled is the activation time of the toggle rule. Starting value for the count is zero.
816
+
817
+ At the beginning all alarms are "non-toggling"
818
+
819
+ ##### 2. To do when alike alarm was identified
820
+
821
+ When a notifyNew/Changed/ClearedAlarm event matches the filter, then Lower and Upper Edge of the Time Window TogglingStarted/Settled and count are newly determined:
822
+
823
+ ###### 2.1. Determine Time Window TogglingStarted
824
+
825
+ Upper Edge of Time Window TogglingStarted becomes the time of the event.
826
+
827
+ Lower Edge of Time Window TogglingStarted becomes the time of the event minus the size T1 of the time window.
828
+
829
+ ##### 2.2. Determination of "toggling" (via count)
830
+
831
+ The count is the number of alike alarms between Lower and Upper Edge of Time Window TogglingStarted (including the new alarm).
832
+
833
+ If the count is above or equal to the threshold N and the event was a notifyNewAlarm and the alarm was "non-toggling", then the notifyNewAlarm is sent and the alarm is considered as "toggling", with the consequence that further alike notifyNew/Changed/Alarm events are regarded as not significant, until the alarm is considered as "non-toggling" again.
834
+
835
+ ###### 2.3.Determine Time Window TogglingSettled
836
+
837
+ If the alarm is "non-toggling", then there is no need to determine Upper and Lower Edge of Time Window TogglingSettled.
838
+
839
+ If the alarm is "toggling", then:
840
+
841
+ Upper Edge of Time Window TogglingSettled becomes the time of the new event plus the size T2 of the Time Window TogglingSettled .
842
+
843
+ Lower Edge of Time Window TogglingSettled becomes the time of the new alarm .
844
+
845
+ ##### 3. Return to non-toggling
846
+
847
+ If the time reaches the Upper Edge of Time Window TogglingSettled, then the alarm is considered as "non-toggling", i.e. alike alarms are regarded as significant.
848
+
849
+ If the last event was a notifyChanged/ClearedAlarm, then the change to "non-toggling" triggers the emission of the related notification.
850
+
851
+ Table A.2.3.3-1 shows the emission times of the various related to significant alarm.
852
+
853
+ **Table A.2.3.3-1: Significant alarm emission time re: Toggle Rule**
854
+
855
+ | Reported alarm types | Emission (to IRPManager) times of an Reported alarm |
856
+ |----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
857
+ | notifyNewAlarm | Immediately after the alarmRaisedTime |
858
+ | notifyChangedAlarm | Immediately after the alarmChangedTime [Remark: If the alarm is toggling state, then the notifyChangeAlarm is dropped (not significant).] |
859
+ | notifyClearedAlarm | Immediately after the alarmClearedTime+T2 of the last alike alarm , if alarmClearedTime is earlier than alarmRaisedTime+T2<br>or<br>immediately after the alarmClearedTime of the last alike alarm, if this time is later than or equal to alarmRaisedTime+T2 |
860
+
861
+ Table A.2.3.3-2 shows the time related parameters in significant alarm.
862
+
863
+ **Table A.2.3.3-2: Significant alarm time parameters re: Toggle Rule**
864
+
865
+ | Parameters of the Reported alarm | Parameter values |
866
+ |----------------------------------|---------------------------------------------------------------|
867
+ | alarmRaisedTime | Same value as that carried in the alike alarm. |
868
+ | alarmChangedTime | Same value as that carried in the alike alarm. |
869
+ | notifyClearedTime | Same value as that carried in the last alike alarm. |
870
+ | alarmId | Same value as that carried by the first member of a sequence. |
871
+
872
+ #### A.2.3.4 Relation to Log and AlarmList
873
+
874
+ The alike alarms enter the Log. The significant alarms enter the AlarmList.
875
+
876
+ #### A.2.3.5 Samples
877
+
878
+ The samples below use N=3.
879
+
880
+ ![Figure A.2.3.5-1: Toggle Rule illustration 1. A timeline diagram showing three alarm events on a horizontal axis labeled 't'. The first event is a rectangle with a light gray top half and a dark gray bottom half. The second event is a similar rectangle. The third event is a rectangle with a question mark '?' in the light gray top half and a dark gray bottom half. Above the first two events, a double-headed arrow labeled 'T 1' spans the gap between them. Above the third event, a double-headed arrow labeled 'T 2' spans from the start of the event to a point further right. To the left of the first event, a double-headed arrow labeled 'N=3' spans the gap between the start of the timeline and the first event.](dd380ccd5aca1151074fede04826f1a4_img.jpg)
881
+
882
+ Figure A.2.3.5-1: Toggle Rule illustration 1. A timeline diagram showing three alarm events on a horizontal axis labeled 't'. The first event is a rectangle with a light gray top half and a dark gray bottom half. The second event is a similar rectangle. The third event is a rectangle with a question mark '?' in the light gray top half and a dark gray bottom half. Above the first two events, a double-headed arrow labeled 'T 1' spans the gap between them. Above the third event, a double-headed arrow labeled 'T 2' spans from the start of the event to a point further right. To the left of the first event, a double-headed arrow labeled 'N=3' spans the gap between the start of the timeline and the first event.
883
+
884
+ **Figure A.2.3.5-1: Toggle Rule illustration 1**
885
+
886
+ ![Figure A.2.3.5-2: Toggle Rule illustration 2. A timeline 't' shows five boxes. The first two are light gray above and dark gray below. The third and fourth are light gray above and part of a long dark gray block below. The fifth is light gray above with a '?' and part of the long dark gray block below. A dotted double-headed arrow labeled 'T 1' spans the first two boxes. A dotted double-headed arrow labeled 'T 2' spans the last three boxes. The label 'N=3' is to the left of the 'T 1' arrow.](97f61e67792478fb6ce089868e503063_img.jpg)
887
+
888
+ Figure A.2.3.5-2: Toggle Rule illustration 2. A timeline 't' shows five boxes. The first two are light gray above and dark gray below. The third and fourth are light gray above and part of a long dark gray block below. The fifth is light gray above with a '?' and part of the long dark gray block below. A dotted double-headed arrow labeled 'T 1' spans the first two boxes. A dotted double-headed arrow labeled 'T 2' spans the last three boxes. The label 'N=3' is to the left of the 'T 1' arrow.
889
+
890
+ Figure A.2.3.5-2: Toggle Rule illustration 2
891
+
892
+ ![Figure A.2.3.5-3: Toggle Rule illustration 3. A timeline 't' shows five boxes. The first two are light gray above and dark gray below. The third and fourth are light gray above and part of a long dark gray block below. The fifth is a long light gray box above with a '?' and part of the long dark gray block below. A dotted double-headed arrow labeled 'T 1' spans the first two boxes. A dotted double-headed arrow labeled 'T 2' spans the last three boxes. The label 'N=3' is to the left of the 'T 1' arrow.](2a25e8bc21554c0efceda1a8ccf57db3_img.jpg)
893
+
894
+ Figure A.2.3.5-3: Toggle Rule illustration 3. A timeline 't' shows five boxes. The first two are light gray above and dark gray below. The third and fourth are light gray above and part of a long dark gray block below. The fifth is a long light gray box above with a '?' and part of the long dark gray block below. A dotted double-headed arrow labeled 'T 1' spans the first two boxes. A dotted double-headed arrow labeled 'T 2' spans the last three boxes. The label 'N=3' is to the left of the 'T 1' arrow.
895
+
896
+ Figure A.2.3.5-3: Toggle Rule illustration 3
897
+
898
+ ![Figure A.2.3.5-4: Toggle Rule illustration 4. A timeline 't' shows a single long box. The top half is light gray with a '?' and the bottom half is dark gray. A dotted double-headed arrow labeled 'T 1' spans the top half. The label 'N=3' is to the left of the 'T 1' arrow.](004a497465710d16d63f436bb330fb42_img.jpg)
899
+
900
+ Figure A.2.3.5-4: Toggle Rule illustration 4. A timeline 't' shows a single long box. The top half is light gray with a '?' and the bottom half is dark gray. A dotted double-headed arrow labeled 'T 1' spans the top half. The label 'N=3' is to the left of the 'T 1' arrow.
901
+
902
+ Figure A.2.3.5-4: Toggle Rule illustration 4
903
+
904
+ #### A.2.3.6 Example for Use cases
905
+
906
+ The toggleRule can be used to take some burden from alarm management for cases where an alarm comes and goes back and forth, e.g. because of some entity is in a swinging state.
907
+
908
+ #### A.2.3.7 Exception Handling
909
+
910
+ The Toggle Rule can potentially group multiple alike alarms together to form one significant alarm. If the process executing the Rule misses the alarm clearing time of one member of a group, then this can have the following consequences:
911
+
912
+ If a clearing of one of the alike alarms during the toggling state is missed (green box in Figure A.2.3.7-1), then the significant alarm would also not be cleared (pink box continuing the dark grey in the same figure). This can be avoided if the filter is set in a way that only alarms of one instance will pass it and if always the latest `notifyClearedAlarms` triggers the start of T2.
913
+
914
+ ![Figure A.2.3.7-1: Exception handling example. A timeline diagram showing alarm states over time. A horizontal axis represents time (t). Above the axis, a green bar labeled 'alarmList' contains several boxes. From left to right: three grey boxes (two above, one below the axis), a green box (above), a green box with a question mark (above), and a large green box (above). A red arrow labeled 'Missed notifyClearedAlarm' points to the second green box. To the left of the first grey box is a double-headed arrow labeled 'N=3'. To the right of the first grey box is a double-headed arrow labeled 'T1'. To the right of the green box with the question mark is a double-headed arrow labeled 'T2'. Below the axis, a dark grey bar extends from the start of the third grey box to the start of a pink box. The pink box continues to the right, ending at a vertical line labeled 't'.](043e64d41a3368d138ace3816fd26469_img.jpg)
915
+
916
+ Figure A.2.3.7-1: Exception handling example. A timeline diagram showing alarm states over time. A horizontal axis represents time (t). Above the axis, a green bar labeled 'alarmList' contains several boxes. From left to right: three grey boxes (two above, one below the axis), a green box (above), a green box with a question mark (above), and a large green box (above). A red arrow labeled 'Missed notifyClearedAlarm' points to the second green box. To the left of the first grey box is a double-headed arrow labeled 'N=3'. To the right of the first grey box is a double-headed arrow labeled 'T1'. To the right of the green box with the question mark is a double-headed arrow labeled 'T2'. Below the axis, a dark grey bar extends from the start of the third grey box to the start of a pink box. The pink box continues to the right, ending at a vertical line labeled 't'.
917
+
918
+ Figure A.2.3.7-1: Exception handling example
919
+
920
+ ### A.2.4 Definition of vendor specific rule
921
+
922
+ It is possible to implement vendor specific `AAMRules`. No specific definitions are supplied here.
923
+
924
+ ## A.3 Relation of Rule and Notification filter
925
+
926
+ This clause illustrates the relation between the AAM capabilities and the NotificationIRP and AlarmIRP.
927
+
928
+ The following diagram illustrates the case when AAM capabilities are not deployed. The "1, 2.. 6" indicates 6 alarms. They will be logged and they would appear in the `AlarmList`. The NotificationIRP supported a filter F1. The `IRPManager`, in this case, receives "1, 3" where '2, 4, 5, 6' were discarded because of Notification filter F1 is in effect.
929
+
930
+ ![Diagram showing alarm flow without AAM capabilities. Alarms 1-6 enter AlarmIRP. AlarmIRP sends 1-6 to NotificationIRP, Log, and AlarmList. NotificationIRP uses filter F1 to output only 1 and 3.](9c1d3678db4a12d5864cb2a4def1135d_img.jpg)
931
+
932
+ ```
933
+
934
+ graph LR
935
+ Input(( )) -- "1,2,3,4,5,6" ---> AlarmIRP[AlarmIRP]
936
+ AlarmIRP -- "1,2,3,4,5,6" ---> NotificationIRP[NotificationIRP]
937
+ NotificationIRP -- "F1" ---> Output["1,3"]
938
+ AlarmIRP -- "1,2,3,4,5,6" ---> Log[[Log]]
939
+ AlarmIRP -- "1,2,3,4,5,6" ---> AlarmList[[AlarmList]]
940
+
941
+ ```
942
+
943
+ Diagram showing alarm flow without AAM capabilities. Alarms 1-6 enter AlarmIRP. AlarmIRP sends 1-6 to NotificationIRP, Log, and AlarmList. NotificationIRP uses filter F1 to output only 1 and 3.
944
+
945
+ **Figure A.3-1: Deployment without AAM capabilities**
946
+
947
+ The following diagram illustrates the case when AAM capabilities are deployed. The "1, 2.. 6" indicates 6 alarms. They will be logged. Because of AAMRule R1 is in effect, the ""1,2...6" result in two significant alarms, A and B. The A and B will appear in `AlarmList`. They will also be broadcasted to `IRPManagers` subject to NotificationIRP filter in effect. In the case below, the `IRPManager` would receive only A because Notification IRP filter F2 is in effect.
948
+
949
+ ![Diagram showing alarm flow with AAM capabilities. Alarms 1-6 enter AAMIRP. AAMRule R1 processes them into A and B. A and B are sent to NotificationIRP and AlarmList. NotificationIRP uses filter F2 to output only A. Original alarms 1-6 are sent to Log.](705ee99c3c44fd2a1ea6a3348ce8878f_img.jpg)
950
+
951
+ ```
952
+
953
+ graph LR
954
+ Input(( )) -- "1,2,3,4,5,6" ---> AAMIRP[AAMIRP]
955
+ AAMIRP -- "R1" ---> AAMIRP
956
+ AAMIRP -- "A,B" ---> NotificationIRP[NotificationIRP]
957
+ NotificationIRP -- "F2" ---> Output["A"]
958
+ AAMIRP -- "A,B" ---> AlarmList[[AlarmList]]
959
+ Input -- "1,2,3,4,5,6" ---> Log[[Log]]
960
+
961
+ ```
962
+
963
+ Diagram showing alarm flow with AAM capabilities. Alarms 1-6 enter AAMIRP. AAMRule R1 processes them into A and B. A and B are sent to NotificationIRP and AlarmList. NotificationIRP uses filter F2 to output only A. Original alarms 1-6 are sent to Log.
964
+
965
+ **Figure A.3-2: Deployment with AAM capabilities**
966
+
967
+ # Annex B (informative): Change history
968
+
969
+ | Change history | | | | | | | | |
970
+ |----------------|-------|-----------|----------|-----|---------------------------------------------|-----|-------|--------|
971
+ | Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Cat | Old | New |
972
+ | Sep 2007 | SA_37 | SP-070616 | -- | -- | Submitted to SA#37 for Information | -- | 1.0.0 | |
973
+ | Mar 2008 | SA_39 | SP-080072 | -- | -- | Submitted to SA#39 for Approval | -- | 2.0.0 | 8.0.0 |
974
+ | Jun 2008 | SA_40 | SP-080329 | 000<br>1 | -- | Clarify the assumed scenarios for AAM rules | F | 8.0.0 | 8.1.0 |
975
+ | Dec 2009 | - | - | - | - | Update to Rel-9 version (MCC) | - | 8.1.0 | 9.0.0 |
976
+ | Mar 2011 | - | - | - | - | Update to Rel-10 version (MCC) | - | 9.0.0 | 10.0.0 |
977
+
978
+ document.
979
+
980
+ **30**Error! No text of
981
+ specified style in
982
+
983
+ Error! No text of specified style in
marked/Rel-10/32_series/32126/raw.md ADDED
@@ -0,0 +1,1109 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+ # Keywords Alarm management, CORBA, XML, SOAP 3GPP TS 32.126 V10.1.0 (2011-06)
4
+
5
+ *Technical Specification*
6
+
7
+ ## **3rd Generation Partnership Project;** **Technical Specification Group Services and System Aspects;** **Telecommunication management;** **Advanced Alarm Management (AAM)** **Integration Reference Point (IRP):** **Solution Set**
8
+
9
+ ![LTE logo with '4ADVANCED' text above the 'e' and a red signal icon.](64662465bba247703fdec49c8f3309f9_img.jpg)
10
+
11
+ LTE logo with '4ADVANCED' text above the 'e' and a red signal icon.
12
+
13
+ Postal address
14
+ 3GPP SA-NGSI WG1 Coord
15
+ 650 Route des Lucioles - Sophia Antipolis
16
+ Valbonne - FRANCE
17
+ Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
18
+
19
+ Internet
20
+ <http://www.3gpp.org>
21
+
22
+ ![3GPP logo with a red signal icon below the 'P'.](0538daaa5583c23e17db3a12f2281a55_img.jpg)
23
+
24
+ 3GPP logo with a red signal icon below the 'P'.
25
+
26
+ The present document has been developed within the 3<sup>rd</sup> Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP..
27
+
28
+ The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented.
29
+
30
+ This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification.
31
+
32
+ Specifications and reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices.
33
+
34
+ # ***Copyright Notification***
35
+
36
+ No part may be reproduced except as authorized by written permission.
37
+ The copyright and the foregoing restriction extend to reproduction in all media.
38
+
39
+ © 2011, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TTA, TTC).
40
+ All rights reserved.
41
+
42
+ UMTSTM is a Trade Mark of ETSI registered for the benefit of its members
43
+ 3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
44
+ LTE™ is a Trade Mark of ETSI currently being registered for the benefit of its Members and of the 3GPP Organizational Partners
45
+ GSM® and the GSM logo are registered and owned by the GSM Association
46
+
47
+ # Contents
48
+
49
+ | | |
50
+ |--------------------------------------------------------------|-----------|
51
+ | Foreword ..... | 4 |
52
+ | Introduction ..... | 4 |
53
+ | 1 Scope..... | 5 |
54
+ | 2 References..... | 5 |
55
+ | 3 Definitions and abbreviations ..... | 6 |
56
+ | 3.1 Definitions..... | 6 |
57
+ | 3.2 Abbreviations ..... | 7 |
58
+ | 4 Solution Set definitions..... | 7 |
59
+ | <b>Annex A (normative): CORBA Solution Set.....</b> | <b>8</b> |
60
+ | A.1 Architectural features..... | 8 |
61
+ | A.1.1 Syntax for Distinguished Names..... | 8 |
62
+ | A.1.2 Notifications..... | 8 |
63
+ | A.2 Mapping ..... | 8 |
64
+ | A.2.1 General mappings..... | 8 |
65
+ | A.2.2 Operation and notification mapping..... | 8 |
66
+ | A.2.3 Operation parameter mapping..... | 9 |
67
+ | A.2.4 Notification parameter mapping..... | 9 |
68
+ | A.3 Solution Set definitions..... | 10 |
69
+ | A.3.1 IDL definition structure..... | 10 |
70
+ | A.3.2 IDL specification (file name "AAMConstDefs.idl") ..... | 11 |
71
+ | A.3.3 IDL specification (file name "AAMSystem.idl") ..... | 13 |
72
+ | <b>Annex B (normative): XML definitions.....</b> | <b>15</b> |
73
+ | B.1 Architectural Features ..... | 15 |
74
+ | B.1.1 Syntax for Distinguished Names..... | 15 |
75
+ | B.1.2 Notification Services..... | 15 |
76
+ | B.1.3 IOC definitions..... | 15 |
77
+ | B.2 Mapping ..... | 15 |
78
+ | B.3 Solution Set definitions..... | 15 |
79
+ | B.3.1 XML definition structure ..... | 15 |
80
+ | B.3.2 Graphical Representation..... | 16 |
81
+ | B.3.3 XML Schema "aamIOCs.xsd"..... | 17 |
82
+ | <b>Annex C (normative): SOAP Solution Set.....</b> | <b>19</b> |
83
+ | C.1 Architectural features..... | 19 |
84
+ | C.1.1 Syntax for Distinguished Names..... | 19 |
85
+ | C.1.2 Notification Services..... | 19 |
86
+ | C.1.3 Supported W3C specifications..... | 19 |
87
+ | C.1.4 Prefixes and namespaces..... | 19 |
88
+ | C.2 Mapping ..... | 20 |
89
+ | C.2.1 Operation and notification mapping..... | 20 |
90
+ | C.2.2 Operation parameter mapping..... | 20 |
91
+ | C.2.3 Notification parameter mapping..... | 20 |
92
+ | C.3 Solution Set definitions..... | 21 |
93
+ | C.3.1 WSDL definition structure ..... | 21 |
94
+ | C.3.2 Graphical Representation..... | 21 |
95
+ | C.3.3 WSDL specification "AAMIRPSystem.wsdl"..... | 22 |
96
+ | Annex D (informative): Change history..... | 26 |
97
+
98
+ # --- Foreword
99
+
100
+ This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP).
101
+
102
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
103
+
104
+ Version x.y.z
105
+
106
+ where:
107
+
108
+ - x the first digit:
109
+ - 1 presented to TSG for information;
110
+ - 2 presented to TSG for approval;
111
+ - 3 or greater indicates TSG approved document under change control.
112
+ - y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
113
+ - z the third digit is incremented when editorial only changes have been incorporated in the document.
114
+
115
+ # --- Introduction
116
+
117
+ The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below:
118
+
119
+ - 32.121: Advanced Alarm Management (AAM) Integration Reference Point (IRP): Requirements.
120
+ - 32.122: Advanced Alarm Management (AAM) Integration Reference Point (IRP): Information Service (IS).
121
+ - 32.126: Advanced Alarm Management (AAM) Integration Reference Point (IRP): Solution Set (SS) definitions.**
122
+
123
+ The Itf-N interface is built up by a number of IRPs and a related Name Convention, which realise the functional capabilities over this interface. The basic structure of the IRPs is defined in 3GPP TS 32.150 [4].
124
+
125
+ A single network fault may generate a large number of alarms over space and time. In a large and complex network, simultaneous network faults may occur, causing the network operator to be flooded with high volume of alarms. The high volume of alarms, typically the one received by an IRPManager via the getAlarmList or alarm notifications of Alarm IRP specification, greatly inhibits the operator ability to quickly identify and locate the responsible network faults. Advanced Alarm Management IRP is intended to provide methods to improve this situation.
126
+
127
+ # --- 1 Scope
128
+
129
+ The present specifies the Solution Set definitions for the IRP whose semantics are specified in the Advanced Alarm Management (AAM) IRP Information Service (3GPP TS 32.122 [6]).
130
+
131
+ This Solution Set specification is related to TS 32.122 v10.0.X.
132
+
133
+ # --- 2 References
134
+
135
+ The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
136
+
137
+ - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
138
+ - For a specific reference, subsequent revisions do not apply.
139
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
140
+
141
+ - [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications".
142
+ - [2] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements".
143
+ - [3] 3GPP TS 32.102: "Telecommunication management; Architecture".
144
+ - [4] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions".
145
+ - [5] 3GPP TS 32.121: "Telecommunication management; Advanced Alarm Management (AAM) Integration Reference Point (IRP): Requirements".
146
+ - [6] 3GPP TS 32.122: "Telecommunication management; Advanced Alarm Management (AAM) Integrations Reference Point (IRP); Information Service (IS)".
147
+ - [7] W3C REC-xml-20001006: "Extensible Markup Language (XML) 1.0 (Second Edition)".
148
+ - [8] W3C REC-xmlschema-0-20010502: "XML Schema Part 0: Primer".
149
+ - [9] W3C REC-xmlschema-1-20010502: "XML Schema Part 1: Structures".
150
+ - [10] W3C REC-xmlschema-2-20010502: "XML Schema Part 2: Datatypes".
151
+ - [11] W3C REC-xml-names-19990114: "Namespaces in XML".
152
+ - [12] W3C SOAP 1.1 specification (<http://www.w3.org/TR/2000/NOTE-SOAP-20000508/>)
153
+ - [13] W3C XPath 1.0 specification (<http://www.w3.org/TR/1999/REC-xpath-19991116>)
154
+ - [14] W3C WSDL 1.1 specification (<http://www.w3.org/TR/2001/NOTE-wsdl-20010315>)
155
+ - [15] W3C SOAP 1.2 specification (<http://www.w3.org/TR/soap12-part1/>)
156
+ - [16] 3GPP TS 32.306: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP): Solution Set definitions".
157
+ - [17] 3GPP TS 32.312: "Telecommunication management; Generic Integration Reference Point (IRP) management; Information Service (IS)"
158
+ - [18] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects".
159
+
160
+ # --- 3 Definitions and abbreviations
161
+
162
+ ## 3.1 Definitions
163
+
164
+ For the purposes of the present document, the terms and definitions given in TR 21.905 [1], 3GPP TS 32.101 [2], 3GPP TS 32.102 [3], 3GPP TS 32.150 [4] apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TR 21.905 [1].
165
+
166
+ **Alike Alarm:** Two alarms are considered alike, if the corresponding alarm notifications are issued by the same object instance with the same alarmType, same perceivedSeverity, same probableCause and same specificProblem (if present).
167
+
168
+ **Lower Edge of Time Window:** The point in time which determines the begin of a time span.
169
+
170
+ **Upper Edge of Time Window:** The point in time which determines the end of a time span
171
+
172
+ **XML file:** file containing an XML document
173
+
174
+ **XML document:** composed of the succession of an optional XML declaration followed by a root XML element
175
+
176
+ NOTE: See [7]; in the scope of the present document.
177
+
178
+ **XML declaration:** it specifies the version of XML being used
179
+
180
+ NOTE: See [7].
181
+
182
+ **XML element:** has a type, is identified by a name, may have a set of XML attribute specifications and is either composed of the succession of an XML start-tag followed by the XML content of the XML element followed by an XML end-tag, or composed simply of an XML empty-element tag; each XML element may contain other XML elements
183
+
184
+ NOTE: See [7].
185
+
186
+ **empty XML element:** having an empty XML content; an empty XML element still possibly has a set of XML attribute specifications; an empty XML element is either composed of the succession of an XML start-tag directly followed by an XML end-tag, or composed simply of an XML empty-element tag
187
+
188
+ NOTE: See [7].
189
+
190
+ **XML content (of an XML element):** empty if the XML element is simply composed of an XML empty-element tag; otherwise the part, possibly empty, of the XML element between its XML start-tag and its XML end-tag
191
+
192
+ **XML start-tag:** the beginning of a non-empty XML element is marked by an XML start-tag containing the name and the set of XML attribute specifications of the XML element
193
+
194
+ NOTE: See [7].
195
+
196
+ **XML end-tag:** the end of a non-empty XML element is marked by an XML end-tag containing the name of the XML element
197
+
198
+ NOTE: See [7].
199
+
200
+ **XML empty-element tag:** composed simply of an empty-element tag containing the name and the set of XML attribute specifications of the XML element.
201
+
202
+ NOTE: See [7].
203
+
204
+ **XML attribute specification:** has a name and a value
205
+
206
+ NOTE: See [7].
207
+
208
+ **DTD:** defines structure and content constraints to be respected by an XML document to be valid with regard to this DTD
209
+
210
+ NOTE: See [7].
211
+
212
+ **XML schema:** more powerful than a DTD, an XML schema defines structure and content constraints to be respected by an XML document to conform with this XML schema; through the use of XML namespaces several XML schemas can be used together by a single XML document; an XML schema is itself also an XML document that shall conform with the XML schema for XML schemas
213
+
214
+ NOTE: See [8], [9] and [10].
215
+
216
+ **XML namespace:** enables qualifying element and attribute names used in XML documents by associating them with namespaces identified by different XML schemas
217
+
218
+ NOTE: See [11], in the scope of the present document.
219
+
220
+ **XML complex type:** defined in an XML schema; cannot be directly used in an XML document; can be the concrete type or the derivation base type for an XML element type or for another XML complex type; ultimately defines constraints for an XML element on its XML attribute specifications and/or its XML content
221
+
222
+ NOTE: See [8], [9] and [10].
223
+
224
+ **XML element type:** declared by an XML schema; can be directly used in an XML document; as the concrete type of an XML element, directly or indirectly defines constraints on its XML attribute specifications and/or its XML content; can also be the concrete type or the derivation base type for another XML element type
225
+
226
+ NOTE: See [8], [9] and [10].
227
+
228
+ ## 3.2 Abbreviations
229
+
230
+ For the purposes of the present document, the abbreviations given in TR 21.905 [1], in 3GPP TS 32.101 [2], 3GPP TS 32.102 [3], 3GPP TS 32.150 [4], and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1].
231
+
232
+ | | |
233
+ |---------|--------------------------------|
234
+ | AAM | Advanced Alarm Management |
235
+ | AAMRule | Advanced Alarm Management Rule |
236
+ | CM | Configuration Management |
237
+ | EM | Element Manager |
238
+ | IOC | Information Object Class |
239
+ | IRP | Integration Reference Point |
240
+ | IS | Information Service |
241
+ | Itf-N | Interface N |
242
+ | MIB | Management Information Base |
243
+ | NE | Network Element |
244
+ | XML | eXtensible Markup Language |
245
+
246
+ # --- 4 Solution Set definitions
247
+
248
+ This specification defines the following 3GPP Advance Alarm Management IRP Solution Set definitions:
249
+
250
+ Annex A provides the CORBA Solution Set.
251
+
252
+ Annex B provides the XML Definitions.
253
+
254
+ Annex C provides the SOAP Solution Set.
255
+
256
+ # --- Annex A (normative): CORBA Solution Set
257
+
258
+ This annex contains the CORBA Solution Set for the IRP whose semantics is specified in AAM IRP: Information Service (3GPP TS 32.122 [6]).
259
+
260
+ ---
261
+
262
+ ## A.1 Architectural features
263
+
264
+ The overall architectural feature of Advanced Alarm Management IRP is specified in 3GPP TS 32.122 [6]
265
+
266
+ ### A.1.1 Syntax for Distinguished Names
267
+
268
+ The syntax of a Distinguished Name is defined in 3GPP TS 32.300[18]
269
+
270
+ ### A.1.2 Notifications
271
+
272
+ Notifications are sent according to the Notification IRP: CORBA SS (see 3GPP TS 32.306 [16]).
273
+
274
+ Currently there are no AAM IRP notifications defined in 3GPP TS 32.122 [6].
275
+
276
+ ---
277
+
278
+ ## A.2 Mapping
279
+
280
+ ### A.2.1 General mappings
281
+
282
+ Not applicable.
283
+
284
+ ### A.2.2 Operation and notification mapping
285
+
286
+ The AAM IS (3GPP TS 32.122 [6]) defines semantics of operations visible across the Itf-N.
287
+
288
+ Table A.2.2-1 indicates mapping of these operations and notifications to their equivalents defined in this CORBA SS.
289
+
290
+ **Table A.2.2-1: Mapping from IS Operation to SS equivalents**
291
+
292
+ | IS Operation / Notification<br>(3GPP TS 32.122) | SS Method | Qualifier |
293
+ |-------------------------------------------------|---------------------|-----------|
294
+ | activateAAMRule | activate_aam_rule | M |
295
+ | getAAMRules | get_aam_rules | M |
296
+ | deactivateAAMRule | deactivate_aam_rule | M |
297
+
298
+ ### A.2.3 Operation parameter mapping
299
+
300
+ The AAM IS (3GPP TS 32.122 [6]) defines semantics of parameters carried in operations across the Itf-N. The following tables indicate the mapping of these parameters, as per operation, to their equivalents defined in this CORBA SS.
301
+
302
+ **Table A.2.3-1: Mapping from IS `activate_aam_rule` parameters to SS equivalents**
303
+
304
+ | IS Operation parameter | SS Method parameter | Qualifier |
305
+ |--------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|
306
+ | <code>aam_rule_type</code> | <code>AAMConstDefs::AAMRuleType</code> | M |
307
+ | <code>aam_rule_parameter_list</code> | <code>AAMConstDefs::AAMRuleParameterList</code> | M |
308
+ | <code>filter</code> | <code>AdvancedAlarmManagementConstDefs::FilterType</code> | M |
309
+ | <code>status</code> | Exceptions:<br><code>AAMConstDefs::ActivateAAMRule</code> ,<br><code>AAMConstDefs::AAMRuleAlreadyActive</code> ,<br><code>GenericIRPManagementSystem::ParameterNotSupported</code> ,<br><code>GenericIRPManagementSystem::InvalidParameter</code> ,<br><code>GenericIRPManagementSystem::ValueNotSupported</code> ,<br><code>GenericIRPManagementSystem::OperationNotSupported</code> | M |
310
+ | <code>aam_rule_identifier</code> | <code>AAMConstDefs::AAMRuleIdentifier</code> | M |
311
+
312
+ **Table A.2.3-2: Mapping from IS `get_advanced_alarm_management_rules` parameters to SS equivalents**
313
+
314
+ | IS Operation parameter | SS Method parameter | Qualifier |
315
+ |----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|
316
+ | <code>aam_rule_list</code> | <code>AAMConstDefs::AAMRuleList</code> | M |
317
+ | <code>Status</code> | Exceptions:<br><code>AAMConstDefs::GetAAMRules</code> ,<br><code>GenericIRPManagementSystem::ParameterNotSupported</code> ,<br><code>GenericIRPManagementSystem::InvalidParameter</code> ,<br><code>GenericIRPManagementSystem::ValueNotSupported</code> ,<br><code>GenericIRPManagementSystem::OperationNotSupported</code> | M |
318
+
319
+ **Table A.2.3-3: Mapping from IS `deactivate_aam_rule` parameters to SS equivalents**
320
+
321
+ | IS Operation parameter | SS Method parameter | Qualifier |
322
+ |----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|
323
+ | <code>aam_rule_identifier</code> | <code>AAMConstDefs::AAMRuleIdentifier</code> | M |
324
+ | <code>Status</code> | Exceptions:<br><code>AAMConstDefs::DeactivateAAMRule</code> ,<br><code>AAMConstDefs::SpecifiedRuleNotExisting</code> ,<br><code>GenericIRPManagementSystem::ParameterNotSupported</code> ,<br><code>GenericIRPManagementSystem::InvalidParameter</code> ,<br><code>GenericIRPManagementSystem::ValueNotSupported</code> ,<br><code>GenericIRPManagementSystem::OperationNotSupported</code> | M |
325
+
326
+ ### A.2.4 Notification parameter mapping
327
+
328
+ None.
329
+
330
+ ## --- A.3 Solution Set definitions
331
+
332
+ ### A.3.1 IDL definition structure
333
+
334
+ Clause A.3.2 defines the constants and types used by the AAM IRP.
335
+
336
+ Clause A.3.3 defines the operations which are performed by the AAM IRP agent.
337
+
338
+ ### A.3.2 IDL specification (file name "AAMConstDefs.idl")
339
+
340
+ ```
341
+ // File: AAMConstDefs.idl
342
+ #ifndef _AAM_CONST_DEFS_IDL_
343
+ #define _AAM_CONST_DEFS_IDL_
344
+
345
+ // This statement must appear after all include statements
346
+ #pragma prefix "3gppsa5.org"
347
+
348
+ /* ## Module: AAMConstDefs */
349
+
350
+ module AAMConstDefs
351
+ {
352
+
353
+ /*****
354
+ * definition of types used in several operations for Advanced Alarm Management */
355
+ /*****
356
+
357
+ enum AAMRuleType {
358
+ THRESHOLD_RULE,
359
+ TRANSIENT_RULE,
360
+ TOGGLE_RULE,
361
+ VENDOR_SPECIFIC_RULE
362
+ };
363
+
364
+ enum Status {SUCCESS, FAILURE, AAM_RULE_ALREADY_ACTIVE };
365
+
366
+ typedef string AAMRuleIdentifier;
367
+
368
+ /*****
369
+ * types used in operation activateAAMRule and */
370
+ * types used in operation getAAMRules */
371
+ /*****
372
+
373
+ typedef string FilterType;
374
+
375
+ typedef string TimeSpan;
376
+ typedef string AlarmOccurenceThreshold;
377
+ typedef string SlidingTimeWindow;
378
+
379
+ struct AAMRuleParameterListForTransientRule
380
+ {
381
+ TimeSpan time_span;
382
+ };
383
+
384
+ struct AAMRuleParameterListForThresholdRule
385
+ {
386
+ AlarmOccurenceThreshold alarm_occurence_threshold;
387
+ SlidingTimeWindow sliding_time_window;
388
+ };
389
+
390
+ struct AAMRuleParameterListForToggleRule
391
+ {
392
+ AlarmOccurenceThreshold alarm_occurence_threshold;
393
+ SlidingTimeWindow sliding_time_window_toggling_started;
394
+ SlidingTimeWindow sliding_time_window_toggling_settled;
395
+ };
396
+
397
+ typedef string VendorSpecificParameterIdentifier;
398
+ typedef string VendorSpecificParameterValue;
399
+
400
+ struct VendorSpecificParameter
401
+ {
402
+ VendorSpecificParameterIdentifier vendor_specific_parameter_identifier;
403
+ VendorSpecificParameterValue vendor_specific_parameter_value;
404
+ };
405
+
406
+ typedef sequence <VendorSpecificParameter> AAMRuleParameterListForVendorSpecificRule;
407
+
408
+ /* The AAMRuleParameterList may contain a list of */
409
+ ```
410
+
411
+ ```
412
+
413
+ /* AAMParameters with different content depending on the */
414
+ /* AAMRuleType. */
415
+ union AAMRuleParameterList switch (AAMRuleType)
416
+ {
417
+ case THRESHOLD_RULE: AAMRuleParameterListForTransientRule
418
+ aam_rule_parameter_list_for_transient_rule;
419
+ case TRANSIENT_RULE: AAMRuleParameterListForThresholdRule
420
+ aam_rule_parameter_list_for_threshold_rule;
421
+ case TOGGLE_RULE: AAMRuleParameterListForToggleRule
422
+ aam_rule_parameter_list_for_toggle_rule;
423
+ case VENDOR_SPECIFIC_RULE: AAMRuleParameterListForVendorSpecificRule
424
+ aam_rule_parameter_list_for_vendor_specificRule;
425
+ };
426
+
427
+ struct AAMRule
428
+ {
429
+ AAMRuleIdentifier aam_rule_identifier;
430
+ AAMRuleType aam_rule_type;
431
+ AAMRuleParameterList aam_rule_parameter_list;
432
+ FilterType filter;
433
+ };
434
+
435
+ typedef sequence <AAMRule> AAMRuleList;
436
+
437
+ /*****
438
+ * types used in operation deactivateAAMRule only */
439
+ /*****
440
+
441
+ * none */
442
+
443
+ };
444
+
445
+ #endif // _AAM_CONST_DEFS_IDL_
446
+
447
+ ```
448
+
449
+ ### A.3.3 IDL specification (file name "AAMSystem.idl")
450
+
451
+ ```
452
+ //File: AAMSystem.idl
453
+ #ifndef _AAM_SYSTEM_IDL_
454
+ #define _AAM_SYSTEM_IDL_
455
+
456
+ #include <AAMConstDefs.idl>
457
+ #include <GenericIRPManagementSystem.idl>
458
+
459
+ // This statement must appear after all include statements
460
+ #pragma prefix "3gppsa5.org"
461
+
462
+ /* ## Module: AAMSystem */
463
+
464
+ module AdvancedAlarmManagementIRPOperation_1
465
+ {
466
+
467
+ /*
468
+ If the system fails to complete an operation, then it can provide a reason
469
+ to qualify the exception. The semantics carried in this reason are outside
470
+ the scope of the present document.
471
+ */
472
+
473
+ exception ActivateAAMRule { string reason; };
474
+ exception AAMRuleAlreadyActive { string reason; };
475
+ exception GetAAMRules { string reason; };
476
+ exception DeactivateAAMRule { string reason; };
477
+ exception SpecifiedRuleNotExisting { string reason; };
478
+
479
+ interface AdvancedAlarmManagement
480
+ {
481
+
482
+ AAMConstDefs::Status activate_aam_rule
483
+ /* for the purpose of this operation see 3GPP TS 32.322 */
484
+ (
485
+ in AAMConstDefs::AAMRuleType
486
+ aam_rule_type,
487
+ in AAMConstDefs::AAMRuleParameterList
488
+ aam_rule_parameter_list,
489
+ in AAMConstDefs::FilterType filter,
490
+ out AAMConstDefs::AAMRuleIdentifier
491
+ aam_rule_identifier
492
+ )
493
+ raises
494
+ (
495
+ ActivateAAMRule,
496
+ AAMRuleAlreadyActive,
497
+ GenericIRPManagementSystem::ParameterNotSupported,
498
+ GenericIRPManagementSystem::InvalidParameter,
499
+ GenericIRPManagementSystem::ValueNotSupported,
500
+ GenericIRPManagementSystem::OperationNotSupported
501
+ );
502
+
503
+ AAMConstDefs::Status get_aam_rules
504
+ /* for the purpose of this operation see 3GPP TS 32.322 */
505
+ (
506
+ out AAMConstDefs::AAMRuleList
507
+ aam_rule_list
508
+ )
509
+ raises
510
+ (
511
+ GetAAMRules,
512
+ GenericIRPManagementSystem::ParameterNotSupported,
513
+ GenericIRPManagementSystem::InvalidParameter,
514
+ GenericIRPManagementSystem::ValueNotSupported,
515
+ GenericIRPManagementSystem::OperationNotSupported
516
+ );
517
+
518
+ AAMConstDefs::Status deactivate_aam_rule
519
+ /* for the purpose of this operation see 3GPP TS 32.322 */
520
+ (
521
+ in AAMConstDefs::AAMRuleIdentifier
522
+ aam_rule_identifier
523
+ )
524
+ raises
525
+ }
526
+ }
527
+ ```
528
+
529
+ ```
530
+ (
531
+ DeactivateAAMRule,
532
+ SpecifiedRuleNotExisting,
533
+ GenericIRPManagementSystem::ParameterNotSupported,
534
+ GenericIRPManagementSystem::InvalidParameter,
535
+ GenericIRPManagementSystem::ValueNotSupported,
536
+ GenericIRPManagementSystem::OperationNotSupported
537
+ );
538
+ ```
539
+
540
+ ```
541
+ };
542
+ ```
543
+
544
+ ```
545
+ );
546
+ #endif // _AAM_SYSTEM_IDL_
547
+ ```
548
+
549
+ # --- Annex B (normative): XML definitions
550
+
551
+ This annex contains the XML Definitions for the Advance Alarm Management Integration Reference Point (AAM IRP) as it applies to Itf-N, in accordance with AAM IRP IS definitions [6]
552
+
553
+ ## --- B.1 Architectural Features
554
+
555
+ The overall architectural feature of AAM IRP is specified in 3G TS 32.122 [6]. This clause specifies features that are specific to the XML definitions.
556
+
557
+ ### B.1.1 Syntax for Distinguished Names
558
+
559
+ The syntax of a Distinguished Name is defined in 3GPP TS 32.300[18].
560
+
561
+ ### B.1.2 Notification Services
562
+
563
+ Currently there are no AAM IRP notifications defined in 3GPP TS 32.122 [6].
564
+
565
+ ### B.1.3 IOC definitions
566
+
567
+ This annex defines the XML syntax for the IOC definitions of the AAM IRP IS [6], which are used by the XML definitions for the AAM IRP notifications and the AAM IRP IS operations.
568
+
569
+ ## --- B.2 Mapping
570
+
571
+ Not present in the current version of this specification.
572
+
573
+ ## --- B.3 Solution Set definitions
574
+
575
+ ### B.3.1 XML definition structure
576
+
577
+ Clause B.3.2 provides a graphical representation of the XML elements.
578
+
579
+ Clause B.3.3 provides XML definitions of AAM IOC as defined in [6].
580
+
581
+ ### B.3.2 Graphical Representation
582
+
583
+ ![UML Class Diagram showing the structure of AdvancedAlarmManagementRule and its parameter lists.](5cab96b2d23174c25919840ecd50aa48_img.jpg)
584
+
585
+ ```
586
+ classDiagram
587
+ class AdvancedAlarmManagementRule
588
+ class xaa:AAMRuleParameterListForTransientRule
589
+ class xaa:AAMRuleParameterListForThresholdRule
590
+ class xaa:AAMRuleParameterListForToggleRule
591
+ class xaa:AAMRuleParameterListForVendorSpecificRule
592
+ class xaa:TimeSpan
593
+ class xaa:AlarmOccurenceThreshold
594
+ class xaa:SlidingTimeWindow
595
+ class xaa:SlidingTimeWindowTogglin...
596
+ class xaa:VendorSpecificParameter
597
+ class xaa:VendorSpecificParameterId...
598
+ class xaa:VendorSpecificParameterVa...
599
+
600
+ AdvancedAlarmManagementRule --> xaa:AAMRuleParameterListForTransientRule
601
+ AdvancedAlarmManagementRule --> xaa:AAMRuleParameterListForThresholdRule
602
+ AdvancedAlarmManagementRule --> xaa:AAMRuleParameterListForToggleRule
603
+ AdvancedAlarmManagementRule --> xaa:AAMRuleParameterListForVendorSpecificRule
604
+
605
+ xaa:AAMRuleParameterListForTransientRule --> xaa:TimeSpan
606
+ xaa:AAMRuleParameterListForThresholdRule --> xaa:AlarmOccurenceThreshold
607
+ xaa:AAMRuleParameterListForThresholdRule --> xaa:SlidingTimeWindow
608
+ xaa:AAMRuleParameterListForToggleRule --> xaa:AlarmOccurenceThreshold
609
+ xaa:AAMRuleParameterListForToggleRule --> xaa:SlidingTimeWindowTogglin...
610
+ xaa:AAMRuleParameterListForToggleRule --> xaa:SlidingTimeWindowTogglin...
611
+ xaa:AAMRuleParameterListForVendorSpecificRule --> xaa:VendorSpecificParameter
612
+ xaa:VendorSpecificParameter --> xaa:VendorSpecificParameterId...
613
+ xaa:VendorSpecificParameter --> xaa:VendorSpecificParameterVa...
614
+ ```
615
+
616
+ The diagram illustrates the structure of **AdvancedAlarmManagementRule** and its associated parameter lists. The main class, **AdvancedAlarmManagementRule**, is shown on the left. It has four associations leading to different parameter list classes, each represented by a yellow box:
617
+
618
+ - xaa:AAMRuleParameterListForTransientRule**: Contains the attribute **xaa:TimeSpan**.
619
+ - xaa:AAMRuleParameterListForThresholdRule**: Contains the attributes **xaa:AlarmOccurenceThreshold** and **xaa:SlidingTimeWindow**.
620
+ - xaa:AAMRuleParameterListForToggleRule**: Contains the attributes **xaa:AlarmOccurenceThreshold**, **xaa:SlidingTimeWindowTogglin...**, and **xaa:SlidingTimeWindowTogglin...**.
621
+ - xaa:AAMRuleParameterListForVendorSpecificRule**: Contains the attribute **xaa:VendorSpecificParameter**. This attribute is further associated with a class **xaa:VendorSpecificParameter** (also shown in a yellow box), which contains the attributes **xaa:VendorSpecificParameterId...** and **xaa:VendorSpecificParameterVa...**. The association between **xaa:VendorSpecificParameter** and **xaa:VendorSpecificParameter** has a multiplicity of **1..∞**.
622
+
623
+ UML Class Diagram showing the structure of AdvancedAlarmManagementRule and its parameter lists.
624
+
625
+ ### B.3.3 XML Schema “aamIRPIOCs.xsd”
626
+
627
+ ```
628
+ <?xml version="1.0" encoding="UTF-8"?>
629
+ <!--
630
+ 3GPP TS 32.126 AAMIRP IOC XML Schema
631
+ aamIRPIOCs.xsd
632
+ -->
633
+ <schema xmlns:xaa="http://www.3gpp.org/ftp/specs/archive/32_series/32.126#aamIRPIOCs"
634
+ xmlns="http://www.w3.org/2001/XMLSchema"
635
+ targetNamespace="http://www.3gpp.org/ftp/specs/archive/32_series/32.126#aamIRPIOCs"
636
+ elementFormDefault="qualified" attributeFormDefault="unqualified">
637
+ <simpleType name="AdvancedAlarmManagementRuleIdentifier">
638
+ <restriction base="string">
639
+ <length value="64"/>
640
+ </restriction>
641
+ </simpleType>
642
+ <simpleType name="AdvancedAlarmManagementRuleType">
643
+ <restriction base="string">
644
+ <enumeration value="THRESHOLD_RULE"/>
645
+ <enumeration value="TRANSIENT_RULE"/>
646
+ <enumeration value="TOGGLE_RULE"/>
647
+ <enumeration value="VENDOR_SPECIFIC_RULE"/>
648
+ </restriction>
649
+ </simpleType>
650
+ <simpleType name="TimeSpan">
651
+ <restriction base="string">
652
+ <length value="3"/>
653
+ </restriction>
654
+ </simpleType>
655
+ <complexType name="AAMRuleParameterListForTransientRule">
656
+ <sequence>
657
+ <element name="TimeSpan" type="xaa:TimeSpan"/>
658
+ </sequence>
659
+ </complexType>
660
+ <simpleType name="AlarmOccurenceThreshold">
661
+ <restriction base="string">
662
+ <length value="3"/>
663
+ </restriction>
664
+ </simpleType>
665
+ <simpleType name="SlidingTimeWindow">
666
+ <restriction base="string">
667
+ <length value="3"/>
668
+ </restriction>
669
+ </simpleType>
670
+ <complexType name="AAMRuleParameterListForThresholdRule">
671
+ <sequence>
672
+ <element name="AlarmOccurenceThreshold" type="xaa:AlarmOccurenceThreshold"/>
673
+ <element name="SlidingTimeWindow" type="xaa:SlidingTimeWindow"/>
674
+ </sequence>
675
+ </complexType>
676
+ <complexType name="AAMRuleParameterListForToggleRule">
677
+ <sequence>
678
+ <element name="AlarmOccurenceThreshold" type="xaa:AlarmOccurenceThreshold"/>
679
+ <element name="SlidingTimeWindowTogglingStarted" type="xaa:SlidingTimeWindow"/>
680
+ <element name="SlidingTimeWindowTogglingSettled" type="xaa:SlidingTimeWindow"/>
681
+ </sequence>
682
+ </complexType>
683
+ <simpleType name="VendorSpecificParameterIdentifier">
684
+ <restriction base="string">
685
+ <length value="64"/>
686
+ </restriction>
687
+ </simpleType>
688
+ <simpleType name="VendorSpecificParameterValue">
689
+ <restriction base="string">
690
+ <length value="64"/>
691
+ </restriction>
692
+ </simpleType>
693
+ <complexType name="VendorSpecificParameter">
694
+ <sequence>
695
+ <element name="VendorSpecificParameterIdentifier"
696
+ type="xaa:VendorSpecificParameterIdentifier"/>
697
+ <element name="VendorSpecificParameterValue" type="xaa:VendorSpecificParameterValue"/>
698
+ </sequence>
699
+ </complexType>
700
+ <complexType name="AAMRuleParameterListForVendorSpecificRule">
701
+ <sequence>
702
+ ```
703
+
704
+ ```
705
+
706
+ <element name="VendorSpecificParameter" type="xaa:VendorSpecificParameter"
707
+ maxOccurs="unbounded"/>
708
+ </sequence>
709
+ </complexType>
710
+ <complexType name="AdvancedAlarmManagementRuleParameterList">
711
+ <choice>
712
+ <element name="AAMRuleParameterListForTransientRule"
713
+ type="xaa:AAMRuleParameterListForTransientRule"/>
714
+ <element name="AAMRuleParameterListForThresholdRule"
715
+ type="xaa:AAMRuleParameterListForThresholdRule"/>
716
+ <element name="AAMRuleParameterListForToggleRule"
717
+ type="xaa:AAMRuleParameterListForToggleRule"/>
718
+ <element name="AAMRuleParameterListForVendorSpecificRule"
719
+ type="xaa:AAMRuleParameterListForVendorSpecificRule"/>
720
+ </choice>
721
+ </complexType>
722
+ <simpleType name="Filter">
723
+ <restriction base="string">
724
+ <length value="256"/>
725
+ </restriction>
726
+ </simpleType>
727
+ <!-- Attributes of the advancedAlarmManagementRule IOC -->
728
+ <element name="advancedAlarmManagementRuleIdentifier"
729
+ type="xaa:AdvancedAlarmManagementRuleIdentifier"/>
730
+ <element name="advancedAlarmManagementRuleType" type="xaa:AdvancedAlarmManagementRuleType"/>
731
+ <element name="advancedAlarmManagementRuleParameterList"
732
+ type="xaa:AdvancedAlarmManagementRuleParameterList"/>
733
+ <element name="filter" type="xaa:Filter"/>
734
+ </schema>
735
+
736
+ ```
737
+
738
+ # --- Annex C (normative): SOAP Solution Set
739
+
740
+ This annex specifies the SOAP Solution Set for the IRP whose semantics are specified in AAM IRP: Information Service (3GPP TS 32.122 [6]).
741
+
742
+ ---
743
+
744
+ ## C.1 Architectural features
745
+
746
+ The overall architectural feature of the AAM IRP is specified in 3GPP TS 32.122 [6]. This clause specifies features that are specific to the SOAP Solution Set.
747
+
748
+ ### C.1.1 Syntax for Distinguished Names
749
+
750
+ The syntax of a Distinguished Name is defined in 3GPP TS 32.300[18].
751
+
752
+ ### C.1.2 Notification Services
753
+
754
+ Currently there are no AAM IRP notifications defined in 3GPP TS 32.122 [6].
755
+
756
+ ### C.1.3 Supported W3C specifications
757
+
758
+ The overall architectural feature of the Advanced Alarm Management IRP is specified in 3GPP TS 32.122 [6]. This clause specifies features that are specific to the SOAP solution set.
759
+
760
+ The SOAP 1.1 specification [12] and WSDL 1.1 specification [14] are supported.
761
+
762
+ The SOAP 1.2 specification [15] is supported optionally.
763
+
764
+ This specification uses "document" style in WSDL file.
765
+
766
+ This specification uses "literal" encoding style in WSDL file.
767
+
768
+ The filter language used in the SS is the XPath Language (see W3C XPath 1.0 specification [13]). IRPAgents may throw a FilterComplexityLimit fault when a given filter is too complex.
769
+
770
+ ### C.1.4 Prefixes and namespaces
771
+
772
+ This specification uses a number of namespace prefixes throughout that are listed in Table C.1.4.
773
+
774
+ **Table C.1.4: Prefixes and Namespaces used in this specification**
775
+
776
+ | PREFIX | NAMESPACE |
777
+ |------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
778
+ | (no prefix) | <a href="http://schemas.xmlsoap.org/wsdl/">http://schemas.xmlsoap.org/wsdl/</a> |
779
+ | soap | <a href="http://schemas.xmlsoap.org/wsdl/soap/">http://schemas.xmlsoap.org/wsdl/soap/</a> |
780
+ | aamIRPSystem | <a href="http://www.3gpp.org/ftp/specs/archive/32_series/32.126#AAMRPSystem">http://www.3gpp.org/ftp/specs/archive/32_series/32.126#AAMRPSystem</a> |
781
+ | aamIRPData | <a href="http://www.3gpp.org/ftp/specs/archive/32_series/32.126#AAMIRPData">http://www.3gpp.org/ftp/specs/archive/32_series/32.126#AAMIRPData</a> |
782
+ | aam | <a href="http://www.3gpp.org/ftp/specs/archive/32_series/32.126#aamIRP">http://www.3gpp.org/ftp/specs/archive/32_series/32.126#aamIRP</a> |
783
+ | xn | <a href="http://www.3gpp.org/ftp/specs/archive/32_series/32.626#genericNrm">http://www.3gpp.org/ftp/specs/archive/32_series/32.626#genericNrm</a> |
784
+ | genericIRPSystem | <a href="http://www.3gpp.org/ftp/specs/archive/32_series/32.316#GenericIRPSystem">http://www.3gpp.org/ftp/specs/archive/32_series/32.316#GenericIRPSystem</a> |
785
+ | ntfIRPNtfSystem | <a href="http://www.3gpp.org/ftp/specs/archive/32_series/32.306#NotificationIRPNtfSystem">http://www.3gpp.org/ftp/specs/archive/32_series/32.306#NotificationIRPNtfSystem</a> |
786
+
787
+ ## C.2 Mapping
788
+
789
+ ### C.2.1 Operation and notification mapping
790
+
791
+ The Advanced Alarm Management IRP IS (3GPP TS 32.122 [6]) defines semantics of operation and notification visible across the Itf-N. Table C.2.1 indicates mapping of these operations and notifications to their equivalents defined in this SS.
792
+
793
+ **Table C.2.1: Mapping from IS Operation to SS Equivalents**
794
+
795
+ | IS Operations in 3GPP TS 32.122 [6] | SS Operations | Qualifier |
796
+ |-------------------------------------|------------------------|-----------|
797
+ | activateAAMRule | activateAAMRule | M |
798
+ | getAAMRules | getAAMRules | M |
799
+ | deactivateAAMRule | deactivateAAMRule | M |
800
+ | getIRPVersion (note 1) | getIRPVersion | M |
801
+ | getOperationProfile (note 1) | getOperationProfile | O |
802
+ | getNotificationProfile (note 1) | getNotificationProfile | O |
803
+
804
+ NOTE 1: These 3 operations are operations of ManagedGenericIRP IOC specified in 3GPP TS 32.312 [17]. The AdvancedAlarmManagementIRP IOC of 3GPP TS 32.122 [6] inherits from it.
805
+
806
+ ### C.2.2 Operation parameter mapping
807
+
808
+ The Advanced Alarm Management IRP IS (3GPP TS 32.122 [6]) defines semantics of parameters carried in the operations. The tables below show the mapping of these parameters, as per operation, to their equivalents defined in this SS.
809
+
810
+ **Table C.2.2.1: Mapping from IS activateAAMRule parameters to SS equivalents**
811
+
812
+ | IS Operation parameter | SS Method parameter | Qualifier |
813
+ |------------------------|----------------------|-----------|
814
+ | aAMRuleType | aAMRuleType | M |
815
+ | aAMRuleParameterList | aAMRuleParameterList | M |
816
+ | filter | filter | M |
817
+ | aAMRuleIdentifier | aAMRuleIdentifier | M |
818
+ | status | status | M |
819
+
820
+ **Table C.2.2.2: Mapping from IS getAAMRules parameters to SS equivalents**
821
+
822
+ | IS Operation parameter | SS Method parameter | Qualifier |
823
+ |------------------------|---------------------|-----------|
824
+ | aAMRuleList | aAMRuleList | M |
825
+ | status | status | M |
826
+
827
+ **Table C.2.2.3: Mapping from IS deactivateAAMRule parameters to SS equivalents**
828
+
829
+ | IS Operation parameter | SS Method parameter | Qualifier |
830
+ |---------------------------------------|---------------------------------------|-----------|
831
+ | advancedAlarmManagementRuleIdentifier | advancedAlarmManagementRuleIdentifier | M |
832
+ | status | status | M |
833
+
834
+ ### C.2.3 Notification parameter mapping
835
+
836
+ The Advance Alarm Management IRP IS (3GPP TS 32.122 [6]) does not currently define any notifications.
837
+
838
+ ## C.3 Solution Set definitions
839
+
840
+ ### C.3.1 WSDL definition structure
841
+
842
+ Clause C.3.2 provides a graphical representation of the AAM IRP service.
843
+
844
+ Clause C.3.3 defines the services which are supported the AAM IRP agent.
845
+
846
+ ### C.3.2 Graphical Representation
847
+
848
+ The WSDL structure is depicted in Figure C.3.2 below, depicting port type, binding and service. The port type contains port type operations, which again contains input, output and fault messages. The binding contains binding operations, which have the same name as the port type operations. The binding connects to a port inside the service.
849
+
850
+ ![WSDL structure diagram showing AAMIRPPortType, AAMIRPBinding, and AAMIRPService components and their relationships.](79e1709a7317ead45379cbb8ff3ba802_img.jpg)
851
+
852
+ The diagram illustrates the WSDL structure for the Advance Alarm IRP SOAP Solution Set. It consists of three main components connected by lines: AAMIRPPortType, AAMIRPBinding, and AAMIRPService.
853
+
854
+ - AAMIRPPortType**: Contains three operations: activateAAMRule, getAAMRules, and deactivateAAMRule.
855
+ - AAMIRPBinding**: Contains three operations: activateAAMRule, getAAMRules, and deactivateAAMRule. It specifies the transport as http://schemas.xmlsoap.org/soap/http.
856
+ - AAMIRPService**: Contains two ports: AAMIRPPort and GenericIRPPort. AAMIRPPort is associated with the AAMIRPBinding and has a location of http://www.3gpp.org/ftp/specs/archive/32\_series/32.126#AAMIRP. GenericIRPPort is associated with the GenericIRPSystem:GenericIRPBinding and has a location of http://www.3gpp.org/ftp/specs/archive/32\_series/32.316#GenericIRP.
857
+
858
+ Relationships: AAMIRPPortType is connected to AAMIRPBinding. AAMIRPBinding is connected to AAMIRPService. Specifically, AAMIRPBinding is connected to the AAMIRPPort within AAMIRPService.
859
+
860
+ WSDL structure diagram showing AAMIRPPortType, AAMIRPBinding, and AAMIRPService components and their relationships.
861
+
862
+ **Figure C.3.2: Advance Alarm IRP SOAP Solution Set WSDL structure**
863
+
864
+ ### C.3.3 WSDL specification “AAMIRPSystem.wsdl”
865
+
866
+ ```
867
+ <?xml version="1.0" encoding="UTF-8"?>
868
+ <!--
869
+ 3GPP TS 32.126 Advanced Alarm Management (AAM) IRP SOAP Solution Set
870
+ -->
871
+ <definitions xmlns="http://schemas.xmlsoap.org/wsdl/"
872
+ xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
873
+ xmlns:aamIRPSystem="http://www.3gpp.org/ftp/specs/archive/32_series/32.126#AAMIRPSystem"
874
+ xmlns:aamIRPData="http://www.3gpp.org/ftp/specs/archive/32_series/32.126#AAMIRPData"
875
+ xmlns:xaa="http://www.3gpp.org/ftp/specs/archive/32_series/32.126#aamIRPIOCs"
876
+ xmlns:genericIRPSystem="http://www.3gpp.org/ftp/specs/archive/32_series/32.316#GenericIRPSystem"
877
+ targetNamespace="http://www.3gpp.org/ftp/specs/archive/32_series/32.126#AAMIRPSystem"
878
+ <import namespace="http://www.3gpp.org/ftp/specs/archive/32_series/32.316#GenericIRPSystem"/>
879
+ <types>
880
+ <schema targetNamespace="http://www.3gpp.org/ftp/specs/archive/32_series/32.126#AAMIRPData"
881
+ xmlns="http://www.w3.org/2001/XMLSchema">
882
+ <import namespace="http://www.3gpp.org/ftp/specs/archive/32_series/32.126#aamIRPIOCs"/>
883
+ <!-- The following types are defined for the AAM IRP operations -->
884
+ <complexType name="AdvancedAlarmRule">
885
+ <sequence>
886
+ <element name="AdvancedAlarmRuleIdentifier"
887
+ type="xaa:AdvancedAlarmManagementRuleIdentifier"/>
888
+ <element name="AdvancedAlarmRuleType" type="xaa:AdvancedAlarmManagementRuleType"/>
889
+ <element name="AdvancedAlarmManagementRuleParameterList"
890
+ type="xaa:AdvancedAlarmManagementRuleParameterList"/>
891
+ <element name="Filter" type="xaa:Filter"/>
892
+ </sequence>
893
+ </complexType>
894
+ <complexType name="AdvancedAlarmRuleList">
895
+ <sequence>
896
+ <element name="AdvancedAlarmRule" type="aamIRPData:AdvancedAlarmRule"
897
+ maxOccurs="unbounded"/>
898
+ </sequence>
899
+ </complexType>
900
+ <simpleType name="Status">
901
+ <restriction base="string">
902
+ <enumeration value="Success"/>
903
+ <enumeration value="AAMRuleAlreadyActive"/>
904
+ <enumeration value="SpecifiedRuleNotExisting"/>
905
+ <enumeration value="Failure"/>
906
+ </restriction>
907
+ </simpleType>
908
+ <!-- activateAAMRule Request-->
909
+ <element name="activateAAMRule">
910
+ <complexType>
911
+ <sequence>
912
+ <element name="advancedAlarmManagementRuleType"
913
+ type="xaa:AdvancedAlarmManagementRuleType"/>
914
+ <element name="advancedAlarmManagementRuleParameterList"
915
+ type="xaa:AdvancedAlarmManagementRuleParameterList"/>
916
+ <element name="filter" type="xaa:Filter"/>
917
+ </sequence>
918
+ </complexType>
919
+ </element>
920
+ <!-- activateAAMRule Response -->
921
+ <element name="activateAAMRuleResponse">
922
+ <complexType>
923
+ <sequence>
924
+ <element name="advancedAlarmManagementRuleIdentifier"
925
+ type="xaa:AdvancedAlarmManagementRuleIdentifier"/>
926
+ <element name="status" type="aamIRPData:Status"/>
927
+ </sequence>
928
+ </complexType>
929
+ </element>
930
+ <!-- activateAAMRule Fault -->
931
+ <element name="activateAAMRuleFault">
932
+ <simpleType>
933
+ <restriction base="string">
934
+ <enumeration value="OPERATION_FAILED"/>
935
+ </restriction>
936
+ </simpleType>
937
+ </element>
938
+ <!-- getAAMRules Request-->
939
+ <element name="getAAMRules">
940
+ <!-- no input parameter -->
941
+ <complexType>
942
+ ```
943
+
944
+ ```
945
+
946
+ <sequence>
947
+ <element name="dummy" type="string" minOccurs="0"/>
948
+ </sequence>
949
+ </complexType>
950
+ </element>
951
+ <!-- getAAMRules Response -->
952
+ <element name="getAAMRulesResponse">
953
+ <complexType>
954
+ <sequence>
955
+ <element name="advancedAlarmRuleList" type="aamIRPData:AdvancedAlarmRuleList"/>
956
+ <element name="status" type="aamIRPData:Status"/>
957
+ </sequence>
958
+ </complexType>
959
+ </element>
960
+ <!-- getAAMRules Fault -->
961
+ <element name="getAAMRulesFault">
962
+ <simpleType>
963
+ <restriction base="string">
964
+ <enumeration value="OPERATION_FAILED"/>
965
+ </restriction>
966
+ </simpleType>
967
+ </element>
968
+ <!-- deactivateAAMRule Request-->
969
+ <element name="deactivateAAMRule">
970
+ <complexType>
971
+ <sequence>
972
+ <element name="advancedAlarmManagementRuleIdentifier"
973
+ type="xaa:AdvancedAlarmManagementRuleIdentifier"/>
974
+ </sequence>
975
+ </complexType>
976
+ </element>
977
+ <!-- deactivateAAMRule Response -->
978
+ <element name="deactivateAAMRuleResponse">
979
+ <complexType>
980
+ <sequence>
981
+ <element name="status" type="aamIRPData:Status"/>
982
+ </sequence>
983
+ </complexType>
984
+ </element>
985
+ <!-- deactivateAAMRule Fault -->
986
+ <element name="deactivateAAMRuleFault">
987
+ <simpleType>
988
+ <restriction base="string">
989
+ <enumeration value="OPERATION_FAILED"/>
990
+ </restriction>
991
+ </simpleType>
992
+ </element>
993
+ </schema>
994
+ </types>
995
+ <message name="activateAAMRule">
996
+ <part name="parameter" element="aamIRPData:activateAAMRule"/>
997
+ </message>
998
+ <message name="activateAAMRuleResponse">
999
+ <part name="parameter" element="aamIRPData:activateAAMRuleResponse"/>
1000
+ </message>
1001
+ <message name="activateAAMRuleFault">
1002
+ <part name="parameter" element="aamIRPData:activateAAMRuleFault"/>
1003
+ </message>
1004
+ <message name="getAAMRules">
1005
+ <part name="parameter" element="aamIRPData:getAAMRules"/>
1006
+ </message>
1007
+ <message name="getAAMRulesResponse">
1008
+ <part name="parameter" element="aamIRPData:getAAMRulesResponse"/>
1009
+ </message>
1010
+ <message name="getAAMRulesFault">
1011
+ <part name="parameter" element="aamIRPData:getAAMRulesFault"/>
1012
+ </message>
1013
+ <message name="deactivateAAMRule">
1014
+ <part name="parameter" element="aamIRPData:deactivateAAMRule"/>
1015
+ </message>
1016
+ <message name="deactivateAAMRuleResponse">
1017
+ <part name="parameter" element="aamIRPData:deactivateAAMRuleResponse"/>
1018
+ </message>
1019
+ <message name="deactivateAAMRuleFault">
1020
+ <part name="parameter" element="aamIRPData:deactivateAAMRule"/>
1021
+ </message>
1022
+ <portType name="AAMIRPPortType">
1023
+ <operation name="activateAAMRule">
1024
+
1025
+ ```
1026
+
1027
+ ```
1028
+
1029
+ <input message="aamIRPSystem:activateAAMRule"/>
1030
+ <output message="aamIRPSystem:activateAAMRuleResponse"/>
1031
+ <fault name="activateAAMRuleFault" message="aamIRPSystem:activateAAMRuleFault"/>
1032
+ </operation>
1033
+ <operation name="getAAMRules">
1034
+ <input message="aamIRPSystem:getAAMRules"/>
1035
+ <output message="aamIRPSystem:getAAMRulesResponse"/>
1036
+ <fault name="getAAMRulesFault" message="aamIRPSystem:getAAMRulesFault"/>
1037
+ </operation>
1038
+ <operation name="deactivateAAMRule">
1039
+ <input message="aamIRPSystem:deactivateAAMRule"/>
1040
+ <output message="aamIRPSystem:deactivateAAMRuleResponse"/>
1041
+ <fault name="deactivateAAMRuleFault" message="aamIRPSystem:deactivateAAMRuleFault"/>
1042
+ </operation>
1043
+ </portType>
1044
+ <binding name="AAMIRPBinding" type="aamIRPSystem:AAMIRPPortType">
1045
+ <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
1046
+ <operation name="activateAAMRule">
1047
+ <soap:operation
1048
+ soapAction="http://www.3gpp.org/ftp/specs/archive/32_series/32.126#activateAAMRule"
1049
+ style="document"/>
1050
+ <input>
1051
+ <soap:body use="literal"/>
1052
+ </input>
1053
+ <output>
1054
+ <soap:body use="literal"/>
1055
+ </output>
1056
+ <fault name="activateAAMRuleFault">
1057
+ <soap:fault name="activateAAMRuleFault" use="literal"/>
1058
+ </fault>
1059
+ </operation>
1060
+ <operation name="getAAMRules">
1061
+ <soap:operation
1062
+ soapAction="http://www.3gpp.org/ftp/specs/archive/32_series/32.126#getAAMRules" style="document"/>
1063
+ <input>
1064
+ <soap:body use="literal"/>
1065
+ </input>
1066
+ <output>
1067
+ <soap:body use="literal"/>
1068
+ </output>
1069
+ <fault name="getAAMRulesFault">
1070
+ <soap:fault name="getAAMRulesFault" use="literal"/>
1071
+ </fault>
1072
+ </operation>
1073
+ <operation name="deactivateAAMRule">
1074
+ <soap:operation
1075
+ soapAction="http://www.3gpp.org/ftp/specs/archive/32_series/32.126#deactivateAAMRule"
1076
+ style="document"/>
1077
+ <input>
1078
+ <soap:body use="literal"/>
1079
+ </input>
1080
+ <output>
1081
+ <soap:body use="literal"/>
1082
+ </output>
1083
+ <fault name="deactivateAAMRuleFault">
1084
+ <soap:fault name="deactivateAAMRuleFault" use="literal"/>
1085
+ </fault>
1086
+ </operation>
1087
+ </binding>
1088
+ <service name="AAMIRPService">
1089
+ <port name="AAMIRPPort" binding="aamIRPSystem:AAMIRPBinding">
1090
+ <soap:address location="http://www.3gpp.org/ftp/specs/archive/32_series/32.126#AAMIRP"/>
1091
+ </port>
1092
+ <port name="GenericIRPPort" binding="genericIRPSystem:GenericIRPBinding">
1093
+ <soap:address
1094
+ location="http://www.3gpp.org/ftp/specs/archive/32_series/32.316#GenericIRP"/>
1095
+ </port>
1096
+ </service>
1097
+ </definitions>
1098
+
1099
+ ```
1100
+
1101
+ # --- Annex D (informative): Change history
1102
+
1103
+ | Change history | | | | | | | |
1104
+ |----------------|-------|-----------|-----|-----|--------------------------------------------------|--------|--------|
1105
+ | Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New |
1106
+ | 2010-09 | SA#49 | SP-100505 | -- | -- | Presentation to SA for Information and Approval | --- | 1.0.0 |
1107
+ | 2010-10 | -- | -- | -- | -- | Publication | 1.0.0 | 10.0.0 |
1108
+ | 2011-06 | SA#52 | SP-110291 | 001 | -- | Correct syntax errors in AAM IRP schema and wsdl | 10.0.0 | 10.1.0 |
1109
+
marked/Rel-10/32_series/32140/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
marked/Rel-10/32_series/32141/raw.md ADDED
@@ -0,0 +1,356 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+ # Keywords UMTS, management , architecture 3GPP TS 32.141 V10.0.0 (2011-03)
4
+
5
+ *Technical Specification*
6
+
7
+ **3GPP**
8
+
9
+ ## Postal address **3rd Generation Partnership Project;** **Technical Specification Group Services and System Aspects;** **Telecommunication management;** **Subscription Management (Su)** 3GPP support office address 650 Route des Lucioles - Sophia Antipolis 06410 VALBONNE - FRANCE Tel.: +33 4 92 94 42 00 Fax: +33 4 93 95 47 16
10
+
11
+ ![LTE logo with '4ADVANCED' text above the 'e'](5fb340ad68b0c71df0b56698b137e35b_img.jpg)
12
+
13
+ LTE logo with '4ADVANCED' text above the 'e'
14
+
15
+ Internet
16
+ <http://www.3gpp.org>
17
+
18
+ ![3GPP logo with a signal icon below the 'P'](0538daaa5583c23e17db3a12f2281a55_img.jpg)
19
+
20
+ 3GPP logo with a signal icon below the 'P'
21
+
22
+ # **Copyright Notification**
23
+
24
+ No part may be reproduced except as authorized by written permission.
25
+ The copyright and the foregoing restriction extend to reproduction in all media.
26
+
27
+ © 2011, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TTA, TTC).
28
+ All rights reserved.
29
+
30
+ UMTS™ is a Trade Mark of ETSI registered for the benefit of its members
31
+
32
+ 3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
33
+
34
+ LTE™ is a Trade Mark of ETSI currently being registered for the benefit of its Members and of the 3GPP Organizational Partners
35
+
36
+ GSM® and the GSM logo are registered and owned by the GSM Association
37
+
38
+ The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP.
39
+
40
+ The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented.
41
+
42
+ This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices.
43
+
44
+ # --- Contents
45
+
46
+ | | |
47
+ |----------------------------------------------------|-----------|
48
+ | Foreword ..... | 4 |
49
+ | Introduction ..... | 4 |
50
+ | 1 Scope..... | 5 |
51
+ | 2 References..... | 5 |
52
+ | 3 Definitions and abbreviations ..... | 5 |
53
+ | 3.1 Definitions..... | 5 |
54
+ | 3.2 Abbreviations ..... | 6 |
55
+ | 4 Subscription Management (SuM) architecture ..... | 6 |
56
+ | 4.1 Functional entities ..... | 7 |
57
+ | 4.2 Interfaces ..... | 8 |
58
+ | 4.2.1 Application of Itf-N for SuM ..... | 8 |
59
+ | 4.2.2 Void ..... | 8 |
60
+ | 4.3 Overview of IRP..... | 8 |
61
+ | 4.3.1 IRP security ..... | 9 |
62
+ | 4.4 Methodology ..... | 9 |
63
+ | 4.4.1 SuM Stage 1 ..... | 9 |
64
+ | 4.4.2 SuM Stage 2 ..... | 9 |
65
+ | 4.4.3 SuM Stage 3 ..... | 10 |
66
+ | <b>Annex A (informative): Void.....</b> | <b>11</b> |
67
+ | Annex B (informative): Change history..... | 12 |
68
+
69
+ # --- Foreword
70
+
71
+ This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP).
72
+
73
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
74
+
75
+ Version x.y.z
76
+
77
+ where:
78
+
79
+ - x the first digit:
80
+ - 1 presented to TSG for information;
81
+ - 2 presented to TSG for approval;
82
+ - 3 or greater indicates TSG approved document under change control.
83
+ - y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
84
+ - z the third digit is incremented when editorial only changes have been incorporated in the document.
85
+
86
+ # --- Introduction
87
+
88
+ The present document is part a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management, as identified below:
89
+
90
+ - TS 32.140: "Subscription Management (SuM) requirements".
91
+ - TS 32.141: "Subscription Management (SuM) architecture".**
92
+ - TS 32.171: "Subscription Management (SuM) Network Resource Model (NRM) Integration Reference Point (IRP): Requirements".
93
+ - TS 32.172: "Subscription Management (SuM) Network Resource Model (NRM) Integration Reference Point (IRP): Information Service (IS)".
94
+ - TS 32.176: "Subscription Management (SuM) Network Resource Model (NRM) Integration Reference Point (IRP): Solution Set (SS) definitions".
95
+
96
+ The 3G environment requires more complex service delivery mechanisms and is no longer simply an internal matter for a single operator but a capability that is achieved by linking together features across multiple service providers and operators. Subscription Management (SuM) is a feature that permits Service Providers, Value Added Service Providers, and Mobile Operators to provision services for a specific subscriber. The feature is necessary to allow service providers and operators to provision, control, monitor and bill the configuration of services that they offer to their subscribers.
97
+
98
+ For further details see 3GPP TS 32.140 [5] on SuM requirements that gives an overview of SuM.
99
+
100
+ # --- 1 Scope
101
+
102
+ The present document defines the architecture for Subscription Management (SuM).
103
+
104
+ # --- 2 References
105
+
106
+ The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
107
+
108
+ - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
109
+ - For a specific reference, subsequent revisions do not apply.
110
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
111
+
112
+ - [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications".
113
+ - [2] 3GPP TS 23.002: "Network Architecture".
114
+ - [3] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements".
115
+ - [4] 3GPP TS 32.102: "Telecommunication management; Architecture".
116
+ - [5] 3GPP TS 32.140: "Telecommunication management; Subscription Management (SuM) requirements".
117
+ - [6] 3GPP TS 23.008: "Organization of subscriber data".
118
+ - [7] 3GPP TS 32.150: "Integration Reference Point (IRP) Concept and definitions".
119
+
120
+ # --- 3 Definitions and abbreviations
121
+
122
+ ## 3.1 Definitions
123
+
124
+ For the purposes of the present document, the following terms and definitions apply:
125
+
126
+ **subscriber:** See 3GPP TR 21.905 [1].
127
+
128
+ **service:** See 3GPP TR 21.905 [1].
129
+
130
+ **Integration Reference Point (IRP):** See 3GPP TS 32.101 [3].
131
+
132
+ **user:** See 3GPP TR 21.905 [1].
133
+
134
+ **subscription:** See 3GPP TR 21.905 [1].
135
+
136
+ **Subscription Management (SuM):** See 3GPP TR 32.140 [5].
137
+
138
+ **Subscription Profile:** See 3GPP TR 32.140 [5].
139
+
140
+ **Subscription Profile Component:** See 3GPP TR 32.140 [5].
141
+
142
+ ## 3.2 Abbreviations
143
+
144
+ For the purposes of the present document, the following abbreviations apply:
145
+
146
+ | | |
147
+ |-----|-----------------------------------|
148
+ | 2G | Second Generation Mobile |
149
+ | 3G | Third Generation Mobile |
150
+ | API | Application Programming Interface |
151
+
152
+ | | |
153
+ |--------|--------------------------------------------------|
154
+ | ASP | Application Service Provider |
155
+ | AuC | Authentication Center |
156
+ | B2B | Business to Business |
157
+ | CS | Circuit Switch |
158
+ | EIR | Equipment Identity Register |
159
+ | GTT | Global Text Telephony |
160
+ | GUP | Generic User Profile |
161
+ | HE | Home Environment |
162
+ | HLR | Home Location Register |
163
+ | HSS | Home Subscriber Server |
164
+ | IMS | IP Multimedia Subsystem |
165
+ | IRP | Integration Reference Point (3GPP TS 32.102 [4]) |
166
+ | ISP | Internet Service Provider |
167
+ | NPDB | Number Portability Data Base |
168
+ | NRM | Network Resource Model |
169
+ | OAM | Operations, Administration and Maintenance |
170
+ | OSA | Open Services Access |
171
+ | OSF | Operations System Functions |
172
+ | OSS | Operations Support System |
173
+ | PS | Packet Switch |
174
+ | SLA | Service Level Agreement |
175
+ | SM&O | Service Management and Operations (TMF/ITU-T) |
176
+ | SP | Service Provider |
177
+ | SuM | Subscription Management |
178
+ | TMN | Telecommunication Management Network |
179
+ | TR-IRP | Trading Partner IRP |
180
+ | UICC | Universal Integrated Circuit Card |
181
+ | USIM | Universal Subscriber Identity Module |
182
+ | VASP | Value Added Service Provider |
183
+ | VHE | Virtual Home Environment |
184
+ | VNO | Virtual Network Operator |
185
+
186
+ # --- 4 Subscription Management (SuM) architecture
187
+
188
+ 3G Telecommunication Management focuses on the most important and strategic contexts in the physical architecture for the management of UMTS. The framework to help define a telecom management physical architecture for a planned UMTS and to adopt standards and provide products that are easy to integrate is defined in 3GPP TS 32.102 [4].
189
+
190
+ SuM manages Subscription Profile Components stored in network resources for the purpose of providing services to specific subscribers. This is done with an architecture that is consistent with the one specified in 3GPP TS 32.102 [4].
191
+
192
+ Subscription Profiles represent services and are associated to subscribers that employ these services (3GPP TS 32.140 [5]). To the extent the HSS controls certain services, Subscription Profile Components can be associated with the HSS. Other services, and as a result Subscription Profiles Components, are outside the jurisdiction of the HSS.
193
+
194
+ ## 4.1 Functional entities
195
+
196
+ Functional entities belonging to SuM are described in Figure 1. The figure also contains the actors related to Subscriptions.
197
+
198
+ ![Figure 1: Functional entities in SUM. A UML class diagram showing relationships between actors (PLMN operator/Service Provider, Subscriber, User) and entities (Service, Subscription Profile, Service Preferences, Subscription Profile Component, System).](a7d78d22e465dea388b31d0739f9d0cd_img.jpg)
199
+
200
+ ```
201
+
202
+ classDiagram
203
+ actor PLMN_operator_Service_Provider as PLMN operator/Service Provider
204
+ actor Subscriber
205
+ actor User
206
+ class Service
207
+ class Subscription_Profile as Subscription Profile
208
+ class Service_Preferences as Service Preferences
209
+ class Subscription_Profile_Component as Subscription Profile Component
210
+ class System
211
+
212
+ PLMN_operator_Service_Provider "1" -- "0..n" Service : Has
213
+ Subscriber "1" -- "0..n" Subscription_Profile : Has
214
+ User "1" -- "0..n" Service_Preferences : Has
215
+ Service "1" -- "0..n" Subscription_Profile : Refers to
216
+ Subscription_Profile "1" -- "0..n" Service_Preferences : Defines
217
+ Subscription_Profile "1" -- "0..n" Subscription_Profile_Component : Consists of
218
+ Subscription_Profile_Component -- System : Resides in
219
+
220
+ subgraph SM_O_mapping [SM&O mapping of information entities]
221
+ Service
222
+ Subscription_Profile
223
+ Service_Preferences
224
+ end
225
+
226
+ ```
227
+
228
+ The diagram illustrates the functional entities and actors in the SuM (Service Management) domain. It shows the following relationships:
229
+
230
+ - PLMN operator/Service Provider** (actor) has **Service** (entity) (1 to 0..n).
231
+ - Subscriber** (actor) has **Subscription Profile** (entity) (1 to 0..n).
232
+ - User** (actor) has **Service Preferences** (entity) (1 to 0..n).
233
+ - Service** (entity) refers to **Subscription Profile** (entity) (1 to 0..n).
234
+ - Subscription Profile** (entity) defines **Service Preferences** (entity) (1 to 0..n).
235
+ - Subscription Profile** (entity) consists of **Subscription Profile Component** (entity) (1 to 0..n).
236
+ - Subscription Profile Component** (entity) resides in **System** (entity).
237
+
238
+ A dashed oval labeled "SM&O mapping of information entities" encloses the **Service**, **Subscription Profile**, and **Service Preferences** entities.
239
+
240
+ Figure 1: Functional entities in SUM. A UML class diagram showing relationships between actors (PLMN operator/Service Provider, Subscriber, User) and entities (Service, Subscription Profile, Service Preferences, Subscription Profile Component, System).
241
+
242
+ Figure 1: Functional entities in SUM
243
+
244
+ Actors described in Figure 1 are:
245
+
246
+ - **Subscriber** (definition See TS 21.905)
247
+ - **User** (definition See TS 21.905)
248
+ - **Service Provider** (definition See TS 21.905)
249
+ - **PLMN Operator** (definition See TS 21.905)
250
+
251
+ The entities described in Figure 1 are:
252
+
253
+ - **Subscription Profile** (definition See TS 32.140)
254
+ - **Subscription Profile Component** (definition See TS 32.140)
255
+ - **Service** (definition See TS 21.905)
256
+ - **System** (definition See TS 32.102)
257
+ - **Service Preferences**: Contains the service preferences chosen for a user. Each user configures his preferences for a particular subscribed service, but only within the limits defined by the Subscription.
258
+
259
+ ### Clarifications to the figure:
260
+
261
+ - A PLMN Operator/Service Provider has one or several Services to offer for Subscribers.
262
+ - A Subscriber has one or several Subscription Profiles, where each describes an offered Service.
263
+ - A User has one or several Service Preferences, where each describes the user's chosen preferences for the service.
264
+
265
+ - A Subscription Profile may consist of one or several Subscription Profile Components.
266
+ - A Subscription Profile may define one or several Service Preferences.
267
+ - A Subscription Profile Component resides in one or several systems
268
+ - Subscriptions are managed in the form of Subscription profile components, which may be distributed across Service Management & Operations (SM&O), Network Resource Management & Operations (RM&O) and Network Domains. There may also be mappings among the SM&O, RM&O and Network Domains.
269
+
270
+ ## 4.2 Interfaces
271
+
272
+ ### 4.2.1 Application of Itf-N for SuM
273
+
274
+ ![Diagram showing the OSF for Network Management and Service Management connected via Itf-N to various OSF domains: User Equipment Domain, Access Network Domain, Core Network Basic Entities Domain (Common CN, CS, PS), and Core network Service Specific entities. The NE Management is also shown.](997233d405f0d4b89ddeb7683e047f66_img.jpg)
275
+
276
+ The diagram illustrates the architecture of PLMN Telecom Management Domains. At the top, a large box labeled "OSF for Network Management and Service Management" is connected via a vertical line labeled "Itf-N" to a lower section. This lower section contains four boxes: "OSF User Equipment Domain", "OSF Access Network Domain", "OSF Core Network Basic Entities Domain" (which is further divided into "Common CN Domain", "CS Domain", and "PS (GPRS) Domain"), and "OSF Core network Service Specific entities". To the right of these boxes is a label "NE Management".
277
+
278
+ Diagram showing the OSF for Network Management and Service Management connected via Itf-N to various OSF domains: User Equipment Domain, Access Network Domain, Core Network Basic Entities Domain (Common CN, CS, PS), and Core network Service Specific entities. The NE Management is also shown.
279
+
280
+ **Figure 2: Overview of PLMN Telecom Management Domains and Itf-N (3GPP TS 32.102 [4])**
281
+
282
+ The Itf-N for SuM is realized by means of an Integration Reference Point (IRP) as defined in 3GPP TS 32.102 [4].
283
+
284
+ Operations System Functions (OSF) functionality can be realized in NEs or in the NE Management systems. SuM, for this release, is concerned with the OSF functionality contained in the Core Network Basic Entities Domain and specifically that of the Common CN Domain. Subscription Profile Components are located in the NEs OSF's within the Common CN Domain or their NEs OSF's in the NE management systems, and are in either case accessed consistent with the IRP concept. SuM OSF's for Network Management and Service Management are located in network- and service management systems.
285
+
286
+ ### 4.2.2 Void
287
+
288
+ ## 4.3 Overview of IRP
289
+
290
+ Figures 3 and 4 identify system contexts of the IRP in terms of its implementation, called IRP Agent (3GPP TS 32.150 [7]), and the user of the IRP Agent, called IRP Manager (3GPP TS 32.150 [7]).
291
+
292
+ The IRP Agent implements and supports the Interface IRPs for SuM NRM IRP. The IRP Agent can reside in an Element Manager (EM) or a Network Element (NE) (3GPP TS 32.102 [4]). In the former case, the interface (represented by a thick dotted line) between the EM and the NEs is not the subject of the Interface IRPs for SuM NRM IRP.
293
+
294
+ An IRP Manager using the Interface IRPs for SuM NRM IRP shall choose one of the two System Contexts defined here, for each NE. For instance, if an EM is responsible for managing a number of NEs, the NM shall access the Interface IRPs for SuM NRM IRP through the EM and not directly to those NEs.
295
+
296
+ The interface IRPs for SuM NRM IRP can be the followings:
297
+
298
+ - Basic CM IRP
299
+
300
+ ![Figure 3: System Context A. A diagram showing the interaction between an IRPManager (NM) and an IRPAgent (EM). The IRPManager is connected to the IRPAgent via a solid line. The IRPAgent is connected to NEs via a dotted line. A dashed vertical line separates the NM and EM domains. An arrow labeled 'Itf-N' points to the interface between the NM and EM. A bracket on the right side of the interface is labeled 'Interface IRPs for SuM NRM IRP'.](3121ebddccf183ca63bb9781be440a7e_img.jpg)
301
+
302
+ Figure 3: System Context A. A diagram showing the interaction between an IRPManager (NM) and an IRPAgent (EM). The IRPManager is connected to the IRPAgent via a solid line. The IRPAgent is connected to NEs via a dotted line. A dashed vertical line separates the NM and EM domains. An arrow labeled 'Itf-N' points to the interface between the NM and EM. A bracket on the right side of the interface is labeled 'Interface IRPs for SuM NRM IRP'.
303
+
304
+ **Figure 3: System Context A**
305
+
306
+ ![Figure 4: System Context B. A diagram showing the interaction between an IRPManager (NM) and an IRPAgent (NE). The IRPManager is connected to the IRPAgent via a solid line. A dashed vertical line separates the NM and NE domains. An arrow labeled 'Itf-N' points to the interface between the NM and NE. A bracket on the right side of the interface is labeled 'Interface IRPs for SuM NRM IRP'.](990567efebf979be51f56d1150012c9d_img.jpg)
307
+
308
+ Figure 4: System Context B. A diagram showing the interaction between an IRPManager (NM) and an IRPAgent (NE). The IRPManager is connected to the IRPAgent via a solid line. A dashed vertical line separates the NM and NE domains. An arrow labeled 'Itf-N' points to the interface between the NM and NE. A bracket on the right side of the interface is labeled 'Interface IRPs for SuM NRM IRP'.
309
+
310
+ **Figure 4: System Context B**
311
+
312
+ ### 4.3.1 IRP security
313
+
314
+ The IRP interface is made secure by controlling access to the network and management systems. Operations processes must insure that only authorized personnel have the access authority to retrieve and alter SuM data. Standard protocols used over the interface between the IRPManager and the IRPAgent provide some degree of security. The exact nature of the security is described in the Solution Set for that protocol. In addition to the requirement that the IRPManager and the IRPAgent be secure, most physical links between them are secured as well.
315
+
316
+ ## 4.4 Methodology
317
+
318
+ The methodology used to conclude the standard work for SuM shall follow the IRP methodology described in 3GPP TS 32.150 [4]. This subclause describes how to apply that methodology.
319
+
320
+ ### 4.4.1 SuM Stage 1
321
+
322
+ SuM Stage 1 is documented in 3GPP TS 32.140 [5].
323
+
324
+ ### 4.4.2 SuM Stage 2
325
+
326
+ SuM Stage 2 is documented as follows:
327
+
328
+ - a) The present document (3GPP TS 32.141) is finalized by identifying the relevant IRPs.
329
+ - b) 3GPP TS 32.171 describes the Requirements for the NRM IRP – containing the Information Object Classes (IOCs), attributes, relations etc. for SuM.
330
+ 3GPP TS 32.171 shall, where applicable, follow the structure from 3GPP TS 32.621 (Configuration Management (CM); Generic network resources Integration Reference Point (IRP): requirements).
331
+ - c) 3GPP TS 32.172 describes the Information Service for the Network Resource Model (NRM) IRP – containing the Information Object Classes (IOCs), attributes, relations etc. for SuM.
332
+ 3GPP TS 32.172 shall, where applicable, follow the structure from 3GPP TS 32.622 (Configuration Management (CM); Generic network resources Integration Reference Point (IRP): Network Resource Model (NRM)).
333
+
334
+ ### 4.4.3 SuM Stage 3
335
+
336
+ SuM Stage 3 is documented in the following documents:
337
+
338
+ - TS 32.176 SuM NRM IRP: Solution set definition
339
+
340
+ ---
341
+
342
+ Annex A (informative): Void
343
+
344
+ # --- Annex B (informative): Change history
345
+
346
+ | Change history | | | | | | | |
347
+ |----------------|-------|-----------|------|-----|----------------------------------------------------------------------------------------------------------------------------------------|-------|--------|
348
+ | Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New |
349
+ | Mar 2003 | SA 19 | SP-030042 | -- | -- | Submitted to SA#19 as v1.0.0 for Information | 1.0.0 | -- |
350
+ | Sep 2003 | SA 21 | SP-030405 | -- | -- | Submitted to SA#21 as v2.0.0 for Approval | 2.0.0 | 6.0.0 |
351
+ | Mar 2004 | SA_23 | SP-040108 | 0001 | -- | Subscription Management TS-family (32.14x and 32.17x) title alignment ("SM" becomes "SuM" and delete "Services operations management") | 6.0.0 | 6.1.0 |
352
+ | Jun 2007 | SA 36 | -- | -- | -- | Automatic upgrade to Rel-7 (no CR) at freeze of Rel-7. | 6.1.0 | 7.0.0 |
353
+ | Dec 2008 | SA 42 | -- | -- | -- | Upgrade to Release 8 | 7.0.0 | 8.0.0 |
354
+ | Sep 2009 | SA 45 | SP-090627 | 0002 | -- | Align with TS 32.140 SuM requirements | 8.0.0 | 9.0.0 |
355
+ | Mar 2011 | - | - | - | - | Update to Rel-10 version (MCC) | 9.0.0 | 10.0.0 |
356
+
marked/Rel-10/32_series/32150/raw.md ADDED
@@ -0,0 +1,487 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+
4
+
5
+
6
+
7
+ # --- Contents
8
+
9
+ | | |
10
+ |-------------------------------------------------------------------------------|-----------|
11
+ | Foreword ..... | 4 |
12
+ | Introduction ..... | 4 |
13
+ | 1 Scope..... | 5 |
14
+ | 2 References..... | 5 |
15
+ | 3 Definitions and abbreviations ..... | 6 |
16
+ | 3.1 Definitions..... | 6 |
17
+ | 3.2 Abbreviations ..... | 7 |
18
+ | 4 Integration Reference Points (IRPs) ..... | 8 |
19
+ | 4.1 Introduction ..... | 8 |
20
+ | 4.1.1 General ..... | 8 |
21
+ | 4.1.2 IRP Specifications Approach ..... | 9 |
22
+ | 4.2 Integration levels..... | 10 |
23
+ | 4.2.1 Application integration..... | 10 |
24
+ | 4.3 Application of IRPs..... | 11 |
25
+ | 4.4 Defining the IRPs..... | 12 |
26
+ | 4.5 Void..... | 12 |
27
+ | 4.6 Mandatory, Optional and Conditional qualifiers..... | 13 |
28
+ | 4.7 System context for Interface IRPs..... | 15 |
29
+ | <b>Annex A (informative): Void.....</b> | <b>16</b> |
30
+ | <b>Annex B (normative): Void.....</b> | <b>17</b> |
31
+ | <b>Annex C (informative): Void.....</b> | <b>18</b> |
32
+ | <b>Annex D (informative): Void.....</b> | <b>19</b> |
33
+ | <b>Annex E (normative): Void.....</b> | <b>20</b> |
34
+ | <b>Annex F (informative): Void.....</b> | <b>21</b> |
35
+ | <b>Annex G (normative): IOC Properties and Inheritance .....</b> | <b>22</b> |
36
+ | G.1 Property..... | 22 |
37
+ | G.2 Inheritance..... | 23 |
38
+ | <b>Annex H (normative): Interface Properties and Inheritance .....</b> | <b>24</b> |
39
+ | H.1 Property..... | 24 |
40
+ | H.2 Inheritance..... | 24 |
41
+ | <b>Annex I (normative): Entity (Interface, IOC and Attribute) Import.....</b> | <b>25</b> |
42
+ | Annex H (informative): Change history..... | 26 |
43
+
44
+ # --- Foreword
45
+
46
+ This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP).
47
+
48
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
49
+
50
+ Version x.y.z
51
+
52
+ where:
53
+
54
+ - x the first digit:
55
+ - 1 presented to TSG for information;
56
+ - 2 presented to TSG for approval;
57
+ - 3 or greater indicates TSG approved document under change control.
58
+ - y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
59
+ - z the third digit is incremented when editorial only changes have been incorporated in the document.
60
+
61
+ # --- Introduction
62
+
63
+ The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below:
64
+
65
+ - TS 32.150: Integration Reference Point (IRP) Concept and definitions**
66
+ - TS 32.151: Integration Reference Point (IRP) Information Service (IS) template
67
+ - TS 32.152: Integration Reference Point (IRP) Information Service (IS) Unified Modelling Language (UML) repertoire
68
+ - TS 32.153: Integration Reference Point (IRP) technology specific templates
69
+ - TS 32.154: Backward and Forward Compatibility (BFC); Concept and definitions
70
+ - TS 32.155: Telecommunication management; Requirements template
71
+
72
+ # --- 1 Scope
73
+
74
+ The present document provides the overall concept for all Integration Reference Point (IRP) specifications. Relevant IRP overview and high-level definitions are already provided in 3GPP TS 32.101 [1] and TS 32.102 [2].
75
+
76
+ IRP specifications are intended to be applicable to any management interface (see definition of Integration Reference Point in subclause 3.1).
77
+
78
+ # --- 2 References
79
+
80
+ The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
81
+
82
+ - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
83
+ - For a specific reference, subsequent revisions do not apply.
84
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
85
+
86
+ - [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements".
87
+ - [2] 3GPP TS 32.102: "Telecommunication management; Architecture".
88
+ - [3] 3GPP TS 32.151: "Telecommunication management; Integration Reference Point (IRP) Information Service (IS) template".
89
+ - [4] 3GPP TS 32.152: "Telecommunication management; Integration Reference Point (IRP) Information Service (IS) Unified Modelling Language (UML) repertoire".
90
+ - [5] ITU-T Recommendation M.3020: "TMN Interface Specification Methodology".
91
+ - [6] OMG IDL Style Guide, ab/98-06-03, June 17, 1998.
92
+ - [7] 3GPP TS 32.111-2: "Telecommunication management; Fault Management; Part 2: Alarm Integration Reference Point: Information Service (IS)".
93
+ - [8] 3GPP TS 32.601: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP); Requirements".
94
+ - [9] 3GPP TS 32.602: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP): Information Service (IS)".
95
+ - [10] 3GPP TS 32.606: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP); Solution Set (SS) definitions".
96
+ - [11] 3GPP TS 32.621: "Telecommunication management; Configuration Management (CM); Generic network resources Integration Reference Point (IRP); Requirements".
97
+ - [12] 3GPP TS 32.622: "Telecommunication management; Configuration Management (CM); Generic network resources Integration Reference Point (IRP): Network Resource Model (NRM)".
98
+ - [13] 3GPP TS 32.626: "Telecommunication management; Configuration Management (CM); Generic network resources Integration Reference Point (IRP): Solution Set (SS) definitions".
99
+ - [14] 3GPP TS 32.671: "Telecommunication management; Configuration Management (CM); State Management Integration Reference Point (IRP): Requirements".
100
+ - [15] 3GPP TS 32.672: "Telecommunication management; Configuration Management (CM); State Management Integration Reference Point (IRP): Information Service (IS)".
101
+
102
+ [16] 3GPP TS 32.676: "Telecommunication management; Configuration Management (CM); State Management Integration Reference Point (IRP); Solution Set (SS) definitions".
103
+
104
+ # --- 3 Definitions and abbreviations
105
+
106
+ ## 3.1 Definitions
107
+
108
+ For the purposes of the present document, the terms and definitions given in 3GPP TS 32.101 [1], 3GPP TS 32.102 [2], 3GPP TS 32.151 [3] and the following apply:
109
+
110
+ **Data Definition IRP:** 3GPP publishes IRP specifications relating to commonly used data definitions that can be imported for use by Interface IRP and/or NRM IRP. This term represents all such specifications. An example of a Data Definition IRP is the State Management IRP (32.671 [14], 32.672 [15], 32.676 [16], etc.).
111
+
112
+ **Information Object Class (IOC):** Describes the information that can be passed/used in management interfaces and is modelled using the stereotype "Class" in the UML meta-model. For a formal definition of Information Object Class and its structure of specification, see 3GPP TS 32.151[3].
113
+
114
+ **Integration Reference Point (IRP):** An architectural concept that is described by a set of specifications for definition of a certain aspect of a management interface, comprising a **Requirements** specification, an **Information Service** specification, and one or more **Solution Set** specifications.
115
+
116
+ **Interface IRP:** 3GPP publishes a number of IRP specifications each of which is related to a set of operations and notifications for a specific telecom management domain such as alarm management, configuration management, etc. Interface IRPs also contain definitions of Support IOCs. This term represents all such specifications. An example of an Interface IRP is the Basic CM IRP (the set of TSs 32.601 [8], 32.602 [9], 32.606 [10], etc.).
117
+
118
+ **IRP Agent:** Encapsulates a well-defined subset of network (element) functions. It interacts with IRPManagers using one or more IRPs. From the IRPManager's perspective, the IRP Agent behaviour is only visible via the IRP(s).
119
+
120
+ **Information Service (IS):** an IRP Information Service describes the information related to the entities (either network resources or support objects) to be managed and the way that the information may be managed for a certain functional area (e.g. the Alarm IRP Information Service in the fault management area). Information Services are defined for all IRPs.
121
+
122
+ **IRP Manager:** Models a user of IRP Agent(s) and it interacts directly with the IRP Agent(s) using IRP(s). Since the IRP Manager represents an IRP Agent user, it gives a clear picture of what the IRP Agent is supposed to do. From the IRP Agent perspective, the IRP Manager behaviour is only visible via the IRP.
123
+
124
+ **Managed Object (MO):** An instance of a Managed Object Class (MOC).
125
+
126
+ **Managed Object Class (MOC):** The mapping of an Information Object Class (IOC) to a Solution Set.
127
+
128
+ **Managed Object Instance (MOI):** An instance of a MOC, i.e. the same as a MO as described above.
129
+
130
+ **Network Resource Model (NRM):** An Information Service describing Information Object Classes representing the manageable aspects of network resources, e.g. an RNC or NodeB.
131
+
132
+ **NRM IRP:** 3GPP publishes a number of IRP specifications each of which is related to a particular NRM (Network Resource Model) as defined in 3GPP TS 32.101 [1]. NRM IRPs do not define any operations or notifications. This term represents all such specifications. Note: In some NRM IRP titles, for historic reasons, they are named "...network resources IRP"). An example of an NRM IRP is the Generic NRM IRP (32.621 [11], 32.622 [12], 32.626 [13], etc.).
133
+
134
+ **Solution Set (SS):** contains a mapping of the IRP Information Service (IS) defined entities (that are technology-agnostic) to technology specific termed entities. It does not contain specification of the entities' semantics. The semantics can be found in the corresponding IS. It is noted that one IS can be mapped to one or several SSs.
135
+
136
+ **Support IOC:** IOC that represents a particular capability, introduced to model a management service. As an example of Support IOC, in the Alarm IRP Information Service [59] there are the AlarmInformation and AlarmList IOCs.
137
+
138
+ **YyyIRP:** 3GPP defines a number of support-IOCs (defined in Interface IRPs) such as AlarmIRP, BasicCMIRP and EPIRP. This term represents all such support-IOCs.
139
+
140
+ **Yyy IRP:** For a specific Interface IRP such as the Basic CM IRP, when the letters Yyy are replaced by the specific key words naming that IRP (in the given example the Yyy is replaced by “Basic CM”), this term represents all specifications that are part of that Interface IRP.
141
+
142
+ ## 3.2 Abbreviations
143
+
144
+ For the purposes of the present document, the abbreviations given in 3GPP TS 32.101 [1], 3GPP TS 32.102 [2], 3GPP TS 32.151 [3] and the following apply:
145
+
146
+ | | |
147
+ |-------|--------------------------------------------------|
148
+ | CORBA | Common Object Request Broker Architecture |
149
+ | EM | Element Manager |
150
+ | GDMO | Guidelines for the Definition of Managed Objects |
151
+ | GUI | Graphical User Interface |
152
+ | IDL | Interface Definition Language |
153
+ | IOC | Information Object Class |
154
+ | IRP | Integration Reference Point |
155
+ | IS | Information Service |
156
+ | NE | Network Element |
157
+ | NM | Network Manager |
158
+ | NRM | Network Resource Model |
159
+ | OMG | Object Management Group |
160
+ | ORB | Object Request Broker |
161
+ | PSA | Product Specific Application |
162
+ | SMP | System Management Processes |
163
+ | SNM | Sub-Network Manager |
164
+ | SS | Solution Set |
165
+ | TMF | TeleManagement Forum |
166
+ | TOM | Telecom Operations Map |
167
+ | UML | Unified Modelling Language |
168
+
169
+ # 4 Integration Reference Points (IRPs)
170
+
171
+ ## 4.1 Introduction
172
+
173
+ For the purpose of management interface development 3GPP has developed an interface concept known as Integration Reference Point (IRP) to promote the wider adoption of standardized management interfaces in telecommunication networks. The IRP concept and associated methodology employs protocol and technology neutral modelling methods as well as protocol specific solution sets to achieve its goals.
174
+
175
+ ### 4.1.1 General
176
+
177
+ The three cornerstones of the IRP concept are:
178
+
179
+ - **Top-down, process-driven modelling approach:** The purpose of each IRP is automation of one specific task, related to TMF TOM. This allows taking a "one step at a time" approach with a focus on the most important tasks.
180
+ - **Technology-independent modelling:** To create from the requirements an interface technology independent model. This is specified in the IRP Information Service.
181
+ - **Standards-based technology-dependent modelling:** To create one or more interface technology dependent models from the technology independent model. This is specified in the IRP Solution Set(s).
182
+
183
+ ![Diagram of IRP components showing the hierarchy from Requirements to Information Service to Solution Sets.](731f533b0599c8e42a063f06e4332045_img.jpg)
184
+
185
+ The diagram illustrates the components of an Integration Reference Point (IRP). It is structured into three main levels:
186
+
187
+ - IRP REQUIREMENTS:** The top level, represented by a yellow box containing a white box labeled "IRP REQUIREMENTS".
188
+ - IRP INFORMATION SERVICE:** The middle level, represented by a white box containing two icons: a document with a person and a tree diagram, separated by a plus sign (+). This box is situated within a larger yellow box.
189
+ - IRP SOLUTION SETS:** The bottom level, represented by a pink box containing four stacked colored bars labeled "SNMP" (blue), "XML" (green), "SOAP" (magenta), and "CORBA" (orange). Two large green arrows point from the "IRP INFORMATION SERVICE" box down to the "IRP SOLUTION SETS" box.
190
+
191
+ Diagram of IRP components showing the hierarchy from Requirements to Information Service to Solution Sets.
192
+
193
+ Figure 4.1: IRP components (with example Solution Sets; for definition of valid 3GPP Solution Sets, see Annex C in TS 32.101 [1])
194
+
195
+ ### 4.1.2 IRP Specifications Approach
196
+
197
+ As highlighted in the previous subclause, IRP specifications are specified using a 3-level approach: Requirements, IS-level and SS-level.
198
+
199
+ Furthermore, there are three categories of IRP specifications (see formal and more detailed definitions in subclause 3.1):
200
+
201
+ - Interface IRPs
202
+ - NRM IRPs
203
+ - Data Definition IRPs.
204
+
205
+ Each category is partitioned into Requirements, IS-level and SS-level specifications.
206
+
207
+ ![Diagram illustrating the IRP 3-Level Specifications Approach combined with the three IRP categories. The diagram shows three horizontal levels: Requirements / Use Cases, Information Service Definitions (UML), and Solution Set Definitions (CORBA, SOAP, XML, CMIP) and Solution Set Definitions (other/future e.g. JAVA, SNMP). The first two levels are further divided into three vertical categories: Interface IRP's, NRM IRP's, and Data Definition IRP's. Annotations on the right indicate stability or change over time for each level.](a234352dfaccdc24745c88eef7724cc6_img.jpg)
208
+
209
+ The diagram illustrates the IRP 3-Level Specifications Approach combined with the three IRP categories. It is structured as follows:
210
+
211
+ - Requirements / Use Cases** (Top Level): This level is divided into three categories:
212
+ - Interface IRP's**
213
+ - NRM IRP's**
214
+ - Data Definition IRP's**
215
+ An annotation on the right indicates this level is "Relative stable over long period of time".
216
+ - Information Service Definitions (UML)** (Middle Level): This level is also divided into three categories:
217
+ - Interface IRP's**: Notification IRP, Alarm IRP, BulkCM IRP, KernelCM IRP, BasicCM IRP, etc.
218
+ - NRM IRP's**: Generic NRM, CoreNW NRM, UMTS NRM's, CDMA NRM's, Inventory NRM, etc.
219
+ - Data Definition IRP's**: State Mgmt IRP, etc.
220
+ An annotation on the right indicates this level "Changes only with respect to addition and extensions".
221
+ - Solution Set Definitions (CORBA, SOAP, XML, CMIP)** and **Solution Set Definitions (other/future e.g. JAVA, SNMP)** (Bottom Level): This level represents technology-specific definitions. An annotation on the right indicates this level "Changes with new/better Technologies".
222
+
223
+ Diagram illustrating the IRP 3-Level Specifications Approach combined with the three IRP categories. The diagram shows three horizontal levels: Requirements / Use Cases, Information Service Definitions (UML), and Solution Set Definitions (CORBA, SOAP, XML, CMIP) and Solution Set Definitions (other/future e.g. JAVA, SNMP). The first two levels are further divided into three vertical categories: Interface IRP's, NRM IRP's, and Data Definition IRP's. Annotations on the right indicate stability or change over time for each level.
224
+
225
+ Figure 4.2: The IRP 3-Level Specifications Approach combined with the three IRP categories.
226
+
227
+ #### Level 1:
228
+
229
+ The "Requirements-level" intends to provide conceptual and use cases definitions for a specific management interface aspect as well as defining subsequent requirements for this IRP.
230
+
231
+ #### Level 2:
232
+
233
+ - The "IS-level" provides the technology independent specification of an IRP.
234
+
235
+ #### Level 3:
236
+
237
+ The "SS-level" finally provides the mapping of IS definitions into one or more technology-specific Solution Sets. This concept provides support for multiple interface technologies as applicable on a vendor and/or network type basis and also enables accommodation of future interface technologies - without the need to redefine requirements and IS-level definitions.
238
+
239
+ ## 4.2 Integration levels
240
+
241
+ Virtually all types of telecom/datacom networks comprise many different technologies purchased from several different vendors. This implies that the corresponding management solution need to be built by integrating product-specific applications from different vendors with a number of generic applications that each provide some aspect of multi-vendor and/or multi-technology support. A complete management solution is thus composed of several independent applications.
242
+
243
+ The following levels of integration are defined:
244
+
245
+ - **Screen Integration:** Each application provides its own specific Graphical User Interface (GUI) that need to be accessible from a single, unified screen (a common desktop). A seamless integration between the various GUIs is then required. Screen Integration is not specified in the present document.
246
+ - **Application Integration:** Applications need to interwork, on a machine-machine basis, in order to automate various end-to-end processes of a communication provider.
247
+
248
+ ### 4.2.1 Application integration
249
+
250
+ Interfaces related to application integration can be divided in the following three categories:
251
+
252
+ - 1) **High-level generic interfaces:** between generic applications on the network and service management layers. The same approach and concepts apply for these as the next category.
253
+ - 2) **High-level (technology-independent to the extent possible) interfaces:** between product-specific and generic applications are needed in order to automate and streamline frequently occurring tasks applicable to several types of network elements. A top-down approach shall be taken when defining these interfaces, where the main input is:
254
+ - a) business processes of a communication provider; and
255
+ - b) the types of generic applications that are used to implement the process support.
256
+
257
+ - 3) **Detailed (product-specific) interfaces:** between product-specific applications and the corresponding network elements are of course also needed. These interfaces are defined using the traditional bottom-up approach, where the actual network infrastructure is modelled. This is the traditional TMN approach to element management. The management information in these interfaces is not further discussed in the present document, as it is internal to a specific development organization and does not need to be open. In fact, by publishing the management information in these interfaces, too much of the internal design may be revealed and it may become impossible to later enhance the systems that are using the interfaces. The management services (operations and notifications) and protocol shall however be open and standardized as long as they are independent of the NRM describing the managed NEs/NRs.
258
+
259
+ ## 4.3 Application of IRPs
260
+
261
+ When providing integrated management solutions for multi-vendor networks, there is a strong requirement that the NEs and the management solutions that go together with them are systems integratable.
262
+
263
+ It should be noted that these IRPs could be provided by an IRP Agent on any management interface.
264
+
265
+ These IRPs are introduced to ensure interoperability, for example between Product-Specific Applications (PSA) and the Network and System Management Processes (SMP) of the Network Manager (NM) - see figure 4.3 from TS 32.101 [1]. These IRPs are considered to cover the most basic needs of task automation.
266
+
267
+ ![Figure 4.3: Examples of IRPs for application integration. The diagram shows a Network Manager at the top containing five Network & System Management Processes: Network Planning & Development, Network Inventory Management, Network Provisioning, Network Maintenance & Restoration, and Network Data Management. Below the Network Manager is a cloud representing a network element (NE) containing an Element Manager and a Product Specific Application (PSA). Arrows indicate the flow of Information Resource Protocols (IRPs) between the PSA and the Network Manager processes. The IRPs are categorized as Service IRPs, CM IRPs (Bulk, Inventory, State...), Common IRPs (Notification, File Xfer, Log...), FM IRPs (Alarm, Test...), and PM IRPs. On the left, two alternative IRPs are shown between the PSA and the NE. A legend at the bottom right defines PSA as Product Specific Application and NE as Network Element.](853f59c89931a666c07903b31d098277_img.jpg)
268
+
269
+ Figure 4.3: Examples of IRPs for application integration. The diagram shows a Network Manager at the top containing five Network & System Management Processes: Network Planning & Development, Network Inventory Management, Network Provisioning, Network Maintenance & Restoration, and Network Data Management. Below the Network Manager is a cloud representing a network element (NE) containing an Element Manager and a Product Specific Application (PSA). Arrows indicate the flow of Information Resource Protocols (IRPs) between the PSA and the Network Manager processes. The IRPs are categorized as Service IRPs, CM IRPs (Bulk, Inventory, State...), Common IRPs (Notification, File Xfer, Log...), FM IRPs (Alarm, Test...), and PM IRPs. On the left, two alternative IRPs are shown between the PSA and the NE. A legend at the bottom right defines PSA as Product Specific Application and NE as Network Element.
270
+
271
+ **Figure 4.3: Examples of IRPs for application integration**
272
+
273
+ Taking one of the above mentioned IRPs as an example, the Network and System Management Processes have similar need to receive notifications from various PSAs. The corresponding service is formalized as a *Notification IRP*. It specifies: firstly, an interface through which subscriptions to different types of notifications can be set-up (or cancelled), and secondly, common attributes for all notifications.
274
+
275
+ Further, applying a common *Name Convention for Managed Objects* is useful for co-operating applications that require identical interpretation of names assigned to network resources under management.
276
+
277
+ ## 4.4 Defining the IRPs
278
+
279
+ It is important to accommodate more than one specific technology, as the technologies will change over time. Applications need to be future-proof. One fundamental principle for achieving this is to clearly separate the semantics of information definition from the protocols definitions (accessing the information) for the external interfaces.
280
+
281
+ The framework being used to define IRPs allows the implementation of user requirements for each management capability (e.g. configuration management), by modelling the information related to the resources to be managed and the way that the information may be accessed and manipulated. Such modelling is done in a way that is independent of the technology and distribution used in the implementation of a management system.
282
+
283
+ The IRP methodology uses the following steps:
284
+
285
+ - Capture the management requirements.
286
+ - Specify the semantics of the information to describe the system. Trace back to item (a).
287
+ - Specify the semantics of the interactions between the management system and its clients. Trace back to item (a).
288
+ - Specify the syntaxes of the information and interactions identified in (b) and (c). The specification is technology dependent. Trace back to items (b) and (c).
289
+
290
+ Figure 4.4 shows an example of how an IRP can be structured (the Alarm IRP).
291
+
292
+ ![Figure 4.4: Example of an IRP (Alarm IRP). The diagram shows a layered structure for the Alarm IRP. The top layer is 'Alarm IRP: Requirements' (Requirements). The second layer is 'Alarm IRP: Information Service' (Information Service), which includes 'Notifications for Alarm reporting and operations possible over the Alarm IRP (Specified in UML and natural language)'. A dashed line separates the top two layers from the bottom layers, labeled 'Protocol independent' above and 'Protocol specific' below. The third layer is 'Solution Set Layer', which branches into three boxes: 'SNMP Solution Set' (Alarm IRP mapped to SNMP including standard SNMP MIB:s), 'CORBA Solution Set' (Alarm IRP mapped to CORBA IDL files. Alarm reporting mapped to OMG Structured events.), and 'CMIP Solution Set' (Alarm IRP mapped to GDMO including relevant ITU-T standards.). Below this are three rows of protocol boxes: 'Application Layer' (SNMP, CORBA/IIOP, CMIS/CMIP), 'Transport Layer' (UDP, TCP, OSI transport protocol), and 'Network Layer' (IP, OSI network protocol).](e9d825d87c5f85c8dba0664eace96ef4_img.jpg)
293
+
294
+ | | | | |
295
+ |-----------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------|--------------------------------------------------------------|----------------------|
296
+ | <b>Alarm IRP: Requirements</b> | | | Requirements |
297
+ | <b>Alarm IRP: Information Service</b> | | | Information Service |
298
+ | Notifications for Alarm reporting and operations possible over the Alarm IRP (Specified in UML and natural language). | | | |
299
+ | <hr style="border-top: 1px dashed blue;"/> | | | Protocol independent |
300
+ | <b>Solution Set Layer</b> | | | |
301
+ | <b>SNMP Solution Set</b> | <b>CORBA Solution Set</b> | <b>CMIP Solution Set</b> | |
302
+ | Alarm IRP mapped to SNMP including standard SNMP MIB:s | Alarm IRP mapped to CORBA IDL files. Alarm reporting mapped to OMG Structured events. | Alarm IRP mapped to GDMO including relevant ITU-T standards. | |
303
+ | <hr style="border-top: 1px dotted black;"/> | | | |
304
+ | SNMP | CORBA/IIOP | CMIS | Application Layer |
305
+ | | | CMIP | |
306
+ | <hr style="border-top: 1px dotted black;"/> | | | |
307
+ | UDP | TCP | OSI transport protocol | Transport Layer |
308
+ | <hr style="border-top: 1px dotted black;"/> | | | |
309
+ | IP | | OSI network protocol | Network Layer |
310
+
311
+ Figure 4.4: Example of an IRP (Alarm IRP). The diagram shows a layered structure for the Alarm IRP. The top layer is 'Alarm IRP: Requirements' (Requirements). The second layer is 'Alarm IRP: Information Service' (Information Service), which includes 'Notifications for Alarm reporting and operations possible over the Alarm IRP (Specified in UML and natural language)'. A dashed line separates the top two layers from the bottom layers, labeled 'Protocol independent' above and 'Protocol specific' below. The third layer is 'Solution Set Layer', which branches into three boxes: 'SNMP Solution Set' (Alarm IRP mapped to SNMP including standard SNMP MIB:s), 'CORBA Solution Set' (Alarm IRP mapped to CORBA IDL files. Alarm reporting mapped to OMG Structured events.), and 'CMIP Solution Set' (Alarm IRP mapped to GDMO including relevant ITU-T standards.). Below this are three rows of protocol boxes: 'Application Layer' (SNMP, CORBA/IIOP, CMIS/CMIP), 'Transport Layer' (UDP, TCP, OSI transport protocol), and 'Network Layer' (IP, OSI network protocol).
312
+
313
+ Figure 4.4: Example of an IRP (Alarm IRP)
314
+
315
+ ## 4.5 Void
316
+
317
+ ## 4.6 Mandatory, Optional and Conditional qualifiers
318
+
319
+ This subclause defines a number of terms used to qualify the relationship between the Information Service, the Solution Sets and their impact on the IRP implementations. The qualifiers defined in this clause are used to qualify IRP Agent behaviour only. This is considered sufficient for the specification of the IRPs.
320
+
321
+ IS specifications define IOC attributes, interfaces, operations, notifications, operation parameters and notification parameters. They can have the following support/read/write qualifiers: M, O, CM, CO, C.
322
+
323
+ Definition of qualifier M (Mandatory):
324
+
325
+ - Used for items that shall be supported.
326
+
327
+ Definition of qualifier O (Optional):
328
+
329
+ - Used for items which may or may not be supported.
330
+
331
+ Definition of qualifier CM (Conditional-Mandatory):
332
+
333
+ - Used for items that are mandatory under certain conditions, specifically:
334
+ - All items having the support qualifier CM shall have a corresponding constraint defined in the IS specification. If the specified constraint is met then the items shall be supported.
335
+
336
+ Definition of qualifier CO (Conditional-Optional):
337
+
338
+ - Used for items that are optional under certain conditions, specifically:
339
+ - All items having the support qualifier CO shall have a corresponding constraint defined in the IS specification. If the specified constraint is met then the items may be supported.
340
+
341
+ Definition of qualifier C (SS-Conditional):
342
+
343
+ - Used for items that are only applicable for certain but not all Solutions Sets (SSs).
344
+
345
+ SS specifications define the SS-equivalents of the IS-defined IOC attributes, operations, notifications, operation parameters and notification parameters. These SS-equivalents can have the following support/read/write qualifiers: M, O, CM and CO.
346
+
347
+ The mapping of the qualifiers of IS-defined constructs to the qualifiers of the corresponding SS-constructs is defined as follows:
348
+
349
+ - For qualifier M, O, CM and CO, each IS-defined item (operation and notification, input and output parameter of operations, input parameter of notifications, information relationship and information attribute) shall be mapped to its equivalent(s) in all SSs. Mapped equivalent(s) shall have the same qualifier as the IS-defined qualifier.
350
+ - For qualifier C, each IS-defined item shall be mapped to its equivalent(s) in at least one SS. Mapped equivalent(s) can have support qualifier M or O.
351
+
352
+ Table 4.6 defines the semantics of qualifiers of the Interface IRP SS equivalents, in terms of support from the IRP Agent perspective.
353
+
354
+ **Table 4.6: Semantics for Mandatory, Optional and Conditional qualifiers used in Solution Sets**
355
+
356
+ | <b>Mapped SS Equivalent</b> | <b>Mandatory</b> | <b>Optional</b> | <b>Conditional-Mandatory (CM)</b> | <b>Conditional-Optional (CO)</b> |
357
+ |-------------------------------------------------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
358
+ | Mapped notification equivalent | The IRP Agent shall generate the notification. | The IRP Agent may or may not generate it. | The IRP Agent shall generate this notification if the constraint described in the IS for this item is satisfied. | The IRP Agent may choose whether or not to generate it. If the IRP Agent chooses to generate it, the constraint described in the IS for this notification must be satisfied. |
359
+ | Mapped operation equivalent | The IRP Agent shall support it. | The IRP Agent may or may not support this operation. If the IRP Agent does not support this operation, the IRP Agent shall reject the operation invocation with a reason indicating that the IRP Agent does not support this operation. The rejection, together with a reason, shall be returned to the IRP Manager. | The IRP Agent shall support this operation if the constraint described in the IS for this item is satisfied. | The IRP Agent may support this operation if the constraint described in the IS for this item is satisfied. |
360
+ | Input parameter of the mapped operation equivalent | The IRP Agent shall accept and behave according to its value. | The IRP Agent may or may not support this input parameter. If the IRP Agent does not support this input parameter and if it carries meaning (i.e. it does not carry no-information semantics), the IRP Agent shall reject the invocation with a reason (that it does not support the parameter). The rejection, together with the reason, shall be returned to the IRP Manager. | The IRP Agent shall accept and behave according to its value if the constraint described in the IS for this item is satisfied. | The IRP Agent may accept and behave according to its value if the constraint described in the IS for this item is satisfied. |
361
+ | Input parameter of mapped notification equivalent AND output parameter of mapped operation equivalent | The IRP Agent shall supply this parameter. | The IRP Agent may supply this parameter. | The IRP Agent shall supply this parameter if the constraint described in the IS for this item is satisfied. | The IRP Agent may supply this parameter if the constraint described in the IS for this item is satisfied. |
362
+ | Mapped IOC attribute equivalent | The IRP Agent shall support it. | The IRP Agent may support it. | The IRP Agent shall support this attribute if the constraint described in the IS for this item is satisfied. | The IRP Agent may support this attribute if the constraint described in the IS for this item is satisfied. |
363
+
364
+ ## 4.7 System context for Interface IRPs
365
+
366
+ Every Interface IRP on a management interface (e.g. Alarm IRP, Notification IRP, Basic CM IRP, Bulk CM IRP) is subject to a System Context as described in this subclause (also consistent with 3GPP TS 32.102 [2] clause 8).
367
+
368
+ Figure 4.7.1 and 4.7.2 identify system contexts of the Interface IRP in terms of its implementation, called IRP<sub>Agent</sub>, and the user of the IRP<sub>Agent</sub>, called IRP<sub>Manager</sub>.
369
+
370
+ Each IRP<sub>Agent</sub> implements and supports one or more IRPs. The set of IRPs that is related to each Interface IRP is defined by the System Context subclause in each individual Interface IRP IS specification, e.g. subclause 4.2 in the Alarm IRP IS [7].
371
+
372
+ An NE can be managed via System Context A or B. The criterion for choosing System Context A or B to manage a particular NE is implementation dependent. An IRP<sub>Agent</sub> shall support one of the two System Contexts. By observing the interaction across the management interface, an IRP<sub>Manager</sub> cannot deduce if the EM and NE are integrated in a single system or if they run in separate systems.
373
+
374
+ ![Diagram of System Context A showing an IRPManager in an NM connected to an IRPAgent in an EM, which is connected to NEs via a management interface (e.g. Itf-N). The IRPAgent supports IRP(s).](b90144cfbb81a2d610d920240fda689d_img.jpg)
375
+
376
+ The diagram illustrates System Context A. On the left, a box labeled 'NM' contains a sub-box labeled 'IRPManager'. A solid line connects 'IRPManager' to a vertical dashed line representing the 'management interface (e.g. Itf-N)'. On the right of the interface, a box labeled 'EM' contains a sub-box labeled 'IRPAgent'. A solid line connects the 'IRPAgent' to the interface. A curved arrow points from the interface to the 'IRPAgent', labeled 'Supported IRP(s)'. A dotted line extends from the 'IRPAgent' to a box labeled 'NEs'.
377
+
378
+ Diagram of System Context A showing an IRPManager in an NM connected to an IRPAgent in an EM, which is connected to NEs via a management interface (e.g. Itf-N). The IRPAgent supports IRP(s).
379
+
380
+ Figure 4.7.1: System Context A
381
+
382
+ ![Diagram of System Context B showing an IRPManager in an NM connected to an IRPAgent in an NE, which is connected via a management interface (e.g. Itf-N). The IRPAgent supports IRP(s).](f57a881fcbcaf494a7dedc4f61224991_img.jpg)
383
+
384
+ The diagram illustrates System Context B. On the left, a box labeled 'NM' contains a sub-box labeled 'IRPManager'. A solid line connects 'IRPManager' to a vertical dashed line representing the 'management interface (e.g. Itf-N)'. On the right of the interface, a box labeled 'NE' contains a sub-box labeled 'IRPAgent'. A solid line connects the 'IRPAgent' to the interface. A curved arrow points from the interface to the 'IRPAgent', labeled 'Supported IRP(s)'.
385
+
386
+ Diagram of System Context B showing an IRPManager in an NM connected to an IRPAgent in an NE, which is connected via a management interface (e.g. Itf-N). The IRPAgent supports IRP(s).
387
+
388
+ Figure 4.7.2: System Context B
389
+
390
+ # --- Annex A (informative): Void
391
+
392
+ # Annex B (normative): Void
393
+
394
+ # Annex C (informative): Void
395
+
396
+ # Annex D (informative): Void
397
+
398
+ # Annex E (normative): Void
399
+
400
+ # Annex F (informative): Void
401
+
402
+ # Annex G (normative): IOC Properties and Inheritance
403
+
404
+ ## G.1 Property
405
+
406
+ The properties of an IOC (including Support IOC) are specified in terms of the following:
407
+
408
+ - a) An IOC attribute(s) including its semantics and syntax, its legal value ranges and support qualifications. The IOC attributes are not restricted to Configuration Management but also include those related to, for example, 1) Performance Management (i.e., measurement types), 2) Trace Management and 3) Accounting Management.
409
+ - b) The non-attribute-specific behaviour associated with an IOC (see Note 1).
410
+
411
+ NOTE 1: As an example, the Link between MscServerFunction and CsMgwFunction is optional. It is mandatory if the MscServerFunction instance belongs to one ManagedElement instance while the CsMgwFunction instance belongs to another ManagedElement instance. This Link behaviour is a non-attribute-specific behaviour. It is expected that this behaviour, like others, will be inherited.
412
+
413
+ - c) An IOC relationship(s) with another IOC(s).
414
+ - d) An IOC notification type(s) and their qualifications.
415
+ - e) An IOC's relation with its parents (see Note 2). There are three mutually exclusive cases:
416
+ - 1) The IOC can have any parent. In UML diagram, the class has a parent *Any*.
417
+ - 2) The IOC is abstract and all of the possible parent(s) have been designated and whether subclass IOCs can be designated as a root IOC. In UML diagram, the class has zero or more possible parents of specific classes (except *Any*).
418
+ - 3) The IOC is concrete and all of the possible parent(s) have been designated and whether the IOC can be designated as a root IOC. In UML diagram, the class has one or more possible parents of specific classes (except *Any*).
419
+
420
+ An IOC instance is either a root IOC or it has one and only one parent. Only 3GPP SA5 may designate an IOC class as a potential root IOC. Currently, only SubNetwork, ManagedElement or MeContext IOCs can be root IOCs.
421
+
422
+ NOTE 2: The parent and child relation in this clause is the parent name-containing the child relation.
423
+
424
+ - f) An IOC's relation with its children. There are three mutually exclusive cases:
425
+ - 1) An IOC shall not have any children (name-containment relation) IOCs. In UML diagram, the class has no child.
426
+ - 2) An IOC can have children IOC(s). The maximum number of instances per children IOC can be specified. An IOC may designate that vendor specific objects are not allowed as children IOCs. In UML diagram, the class has a child *Any*.
427
+ - 3) An IOC can only have the specific children IOC(s) (or their subclasses). The maximum number of instances per children IOC can be specified. An IOC may designate that vendor specific objects are not allowed as children IOCs. In UML diagram, the class has one or more children of specific classes (except *Any*).
428
+ - g) Whether An IOC can be instantiated or not (i.e., whether An IOC is an abstract IOC).
429
+ - h) An attribute for naming purpose.
430
+ - i) An optional attribute for holding IOC name. An IOC name is unique among all 3GPP-defined IOCs and vendor-defined IOCs. An IOC name must be unambiguous.
431
+
432
+ Editor's Note: No agreement on above point i) achieved yet. This is FFS.]
433
+
434
+ ---
435
+
436
+ ## G.2 Inheritance
437
+
438
+ An IOC (the subclass) inherits from another IOC (the superclass) in that the subclass shall have all the properties of the superclass.
439
+
440
+ The subclass can change the inherited support-qualification(s) from optional to mandatory but not vice versa. The subclass can change the inherited support-qualification from conditional-optional to conditional-mandatory but not vice versa.
441
+
442
+ An IOC can be a superclass of many IOC(s). A subclass cannot have more than one superclass.
443
+
444
+ The subclass can:
445
+
446
+ - a) Add (compared to those of its superclass) unique attributes including their behaviour, legal value ranges and support-qualifications. Each additional attribute shall have its own unique attribute name (among all added and inherited attributes).
447
+ - b) Add non-attribute behaviour on an IOC basis. This behaviour may not contradict inherited superclass behaviour.
448
+ - c) Add relationship(s) with IOC(s). Each additional relationship shall have its own unique name (among all added and inherited relations).
449
+ - d) Add additional notification types and their qualifications.
450
+ - e) Designate all of the possible parent(s) (and their subclasses) if the superclass has Property-e-1 such that an IOC will have Property-e-2 or Property-e-3. Restrict possible parent(s) (and their subclasses) and/or remove the capability of the subclass from being a root IOC, if the superclass has Property-e-2 or Property-e-3.
451
+ - f) Add children IOC(s) if the superclass has Property-f-2 such that an IOC will have Property-f-3. Restrict the allowed children IOC(s) (or their subclasses) if the superclass has Property-f-3.
452
+ - g) Specify whether an IOC can be instantiated or not (i.e. the IOC is an abstract IOC).
453
+ - h) Restrict the legal value range of a superclass attribute that has a legal value range.
454
+
455
+ # --- Annex H (normative): Interface Properties and Inheritance
456
+
457
+ ## H.1 Property
458
+
459
+ To be defined.
460
+
461
+ ## --- H.2 Inheritance
462
+
463
+ To be defined.
464
+
465
+ # --- Annex I (normative): Entity (Interface, IOC and Attribute) Import
466
+
467
+ IRP specifications define entities(e.g., IOCs, interfaces and attribute). To facilitate re-use of entity definitions among IRP specifications, an import mechanism is used. When an IRP specification (the subject IRP specification) imports an entity defined in another IRP specification, the subject IRP specification is considered to have defined the imported entity in its specification. Furthermore, the subject IRP specification cannot change the properties of this imported entity. If it requires an entity that is not identical but similar to the imported entity, it should define a new entity that inherits the imported entity and introduce changes in the new entity definition.
468
+
469
+ # Annex H (informative): Change history
470
+
471
+ | Change history | | | | | | | | | |
472
+ |----------------|-------|-----------|------|-----|------------------------------------------------------------------------------------------------------|-----|--------|--------|--|
473
+ | Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Cat | Old | New | |
474
+ | Mar 2006 | SP-31 | SP-060099 | 0006 | -- | Extension/Generalization of the IRP definition and concept (OAM7-NIM-NGN) | C | 6.5.0 | 7.0.0 | |
475
+ | Dec 2006 | SP-34 | SP-060723 | 0007 | -- | Correct existing definitions of the IRPs and gather all IRP-related definitions | F | 7.0.0 | 7.1.0 | |
476
+ | Jan 2007 | -- | -- | -- | -- | Editorial: added two returns in 3.1 Definitions | -- | 7.1.0 | 7.1.1 | |
477
+ | Mar 2007 | SP-35 | SP-070045 | 0008 | -- | Delete the incorrect reference | F | 7.1.1 | 7.2.0 | |
478
+ | Jun 2007 | SP-36 | SP-070309 | 0009 | -- | Identify the use case of XSD schema | B | 7.2.0 | 8.0.0 | |
479
+ | Jun 2007 | SP-36 | SP-070309 | 0010 | -- | Add IOC Property Inheritance and Import definitions | B | 7.2.0 | 8.0.0 | |
480
+ | Mar 2008 | SP-39 | SP-080058 | 0012 | -- | Generalization of the IRP definition for NGN management - Align with 32.101 and TISPAN | A | 8.0.0 | 8.1.0 | |
481
+ | Jun 2008 | SP-40 | SP-080329 | 0013 | -- | Remove CMIP and add SOAP reference as supported technology for IRP Solution Sets - Align with 32.101 | F | 8.1.0 | 8.2.0 | |
482
+ | Mar 2009 | SP-43 | SP-090207 | 0014 | -- | Remove parts moved to 32.153 | F | 8.2.0 | 8.3.0 | |
483
+ | Dec 2009 | -- | -- | -- | -- | Update to Rel-9 version (MCC) | - | 8.3.0 | 9.0.0 | |
484
+ | Mar 2010 | SP-47 | SP-100035 | 0015 | -- | Introduce the use of ProxyClass Any to represent parent and child relation property of IOC | F | 9.0.0 | 9.1.0 | |
485
+ | Jun 2010 | SP-48 | SP-100264 | 0016 | -- | Move common definitions from TS 32.600 and clarify SS definition | F | 9.1.0 | 10.0.0 | |
486
+ | Sep 2010 | SP-49 | SP-100488 | 0017 | -- | Clarification on the meaning of the imported entities | A | 10.0.0 | 10.1.0 | |
487
+ | Mar 2011 | SP-51 | SP-110103 | 0019 | 1 | Reference updates related to IRP SS Improvements WID | D | 10.1.0 | 10.2.0 | |
marked/Rel-10/32_series/32151/raw.md ADDED
@@ -0,0 +1,705 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+ # **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management;** 3GPP TS 32.151 V10.1.0 (2010-09) --- **Integration Reference Point (IRP) Information Service (IS) template (Release 10)**
4
+
5
+ ---
6
+
7
+ ![3GPP logo](30a26f2d17ca95672702bf50fb4f0242_img.jpg)
8
+
9
+ The 3GPP logo, featuring the letters '3GPP' in a stylized, bold font. The '3' is black, 'G' is black, 'P' is black, and 'P' is black. There is a small red signal icon below the 'G'.
10
+
11
+ 3GPP logo
12
+
13
+ Keywords
14
+ UMTS, management
15
+
16
+ # **3GPP**
17
+
18
+ Postal address
19
+
20
+ ---
21
+
22
+ 3GPP support office address
23
+
24
+ ---
25
+
26
+ 650 Route des Lucioles - Sophia Antipolis
27
+ Valbonne - FRANCE
28
+ Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
29
+
30
+ Internet
31
+
32
+ ---
33
+
34
+ <http://www.3gpp.org>
35
+
36
+ ## **Copyright Notification**
37
+
38
+ No part may be reproduced except as authorized by written permission.
39
+ The copyright and the foregoing restriction extend to reproduction in all media.
40
+
41
+ © 2010, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TTA, TTC).
42
+ All rights reserved.
43
+
44
+ UMTS™ is a Trade Mark of ETSI registered for the benefit of its members
45
+ 3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
46
+ LTE™ is a Trade Mark of ETSI currently being registered for the benefit of its Members and of the 3GPP Organizational Partners
47
+ GSM® and the GSM logo are registered and owned by the GSM Association
48
+
49
+ # Contents
50
+
51
+ | | |
52
+ |---------------------------------------------------------------------------|----|
53
+ | Foreword ..... | 5 |
54
+ | Introduction ..... | 5 |
55
+ | 1 Scope..... | 6 |
56
+ | 2 References..... | 6 |
57
+ | 3 Definitions and abbreviations ..... | 7 |
58
+ | 3.1 Definitions..... | 7 |
59
+ | 3.2 Abbreviations ..... | 7 |
60
+ | 4 Information Service (IS) template..... | 7 |
61
+ | W1 Scope..... | 9 |
62
+ | W2 Scope..... | 9 |
63
+ | X Information Object Classes..... | 9 |
64
+ | X.1 Imported information entities and local labels..... | 9 |
65
+ | X.2 Class diagram..... | 10 |
66
+ | X.2.1 Attributes and relationships ..... | 10 |
67
+ | X.2.2 Inheritance ..... | 10 |
68
+ | X.3 Information object class definitions..... | 11 |
69
+ | X.3.a <code>InformationObjectClassName</code> ..... | 11 |
70
+ | X.3.a.1 Definition ..... | 11 |
71
+ | X.3.a.2 Attributes ..... | 11 |
72
+ | X.3.a.3 Attribute constraints..... | 12 |
73
+ | X.3.a.4 Relationships..... | 12 |
74
+ | X.3.a.5 State diagram ..... | 12 |
75
+ | X.3.a.6 Notifications..... | 13 |
76
+ | X.4 Information relationship definitions..... | 14 |
77
+ | X.4.a <code>InformationRelationshipName (supportQualifier)</code> ..... | 14 |
78
+ | X.4.a.1 Definition ..... | 14 |
79
+ | X.4.a.2 Roles ..... | 14 |
80
+ | X.4.a.3 Constraints ..... | 14 |
81
+ | X.5 Information attribute definitions ..... | 15 |
82
+ | X.5.1 Definition and Legal Values..... | 15 |
83
+ | X.5.2 Constraints ..... | 15 |
84
+ | X.6 Common Notifications ..... | 15 |
85
+ | X.7 System State Model..... | 15 |
86
+ | Y Interface Definition ..... | 16 |
87
+ | Y.1 Class diagram representing interfaces..... | 16 |
88
+ | Y.2 Generic rules ..... | 16 |
89
+ | Y.b <code>InterfaceName Interface (supportQualifier)</code> ..... | 16 |
90
+ | Y.b.a Operation <code>OperationName (supportQualifier)</code> ..... | 17 |
91
+ | Y.b.a.1 Definition ..... | 17 |
92
+ | Y.b.a.2 Input parameters ..... | 17 |
93
+ | Y.b.a.3 Output parameters..... | 17 |
94
+ | Y.b.a.4 Pre-condition..... | 19 |
95
+ | Y.b.a.5 Post-condition ..... | 19 |
96
+ | Y.b.a.6 Exceptions..... | 19 |
97
+ | Y.b.a.6.c <code>exceptionName</code> ..... | 20 |
98
+ | Y.b.a.7 Constraints ..... | 20 |
99
+ | Y.b.a Notification <code>NotificationName (supportQualifier)</code> ..... | 21 |
100
+ | Y.b.a.1 Definition ..... | 21 |
101
+ | Y.b.a.2 Input parameters ..... | 21 |
102
+ | Y.b.a.3 Triggering event..... | 21 |
103
+ | Y.b.a.3.1 From state..... | 22 |
104
+ | Y.b.a.3.2 To state ..... | 22 |
105
+ | Y.b.a.4 Constraints ..... | 22 |
106
+
107
+ Y.c Scenario................................................................................................................................................................ 22
108
+
109
+ Annex A (informative): Change history................................................................................................................ 23
110
+
111
+ # --- Foreword
112
+
113
+ This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP).
114
+
115
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
116
+
117
+ Version x.y.z
118
+
119
+ where:
120
+
121
+ - x the first digit:
122
+ - 1 presented to TSG for information;
123
+ - 2 presented to TSG for approval;
124
+ - 3 or greater indicates TSG approved document under change control.
125
+ - y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
126
+ - z the third digit is incremented when editorial only changes have been incorporated in the document.
127
+
128
+ # --- Introduction
129
+
130
+ The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below:
131
+
132
+ - TS 32.150: Integration Reference Point (IRP) Concept and definitions
133
+ - TS 32.151: Integration Reference Point (IRP) Information Service (IS) template**
134
+ - TS 32.152: Integration Reference Point (IRP) Information Service (IS) Unified Modelling Language (UML) repertoire
135
+ - TS 32.153: Integration Reference Point (IRP) technology specific templates
136
+ - TS 32.154: Backward and Forward Compatibility (BFC); Concept and definitions
137
+ - TS 32.155: Requirements template
138
+
139
+ # --- 1 Scope
140
+
141
+ The present document contains the template to be used for the production of all Integration Reference Point (IRP) Information Service (IS) specifications within the 3GPP 32-series.
142
+
143
+ # --- 2 References
144
+
145
+ The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
146
+
147
+ - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
148
+ - For a specific reference, subsequent revisions do not apply.
149
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
150
+
151
+ - [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements".
152
+ - [2] 3GPP TS 32.102: "Telecommunication management; Architecture".
153
+ - [3] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions".
154
+ - [4] 3GPP TS 32.152: "Telecommunication management; Integration Reference Point (IRP) Information Service (IS) Unified Modelling Language (UML) repertoire".
155
+ - [5] 3GPP TS 32.622: "Telecommunication management; Configuration Management (CM); Generic network resources Integration Reference Point (IRP): Network Resource Model (NRM)".
156
+ - [6] 3GPP TS 32.111-2: "Telecommunication management; Fault Management; Part 2: Alarm Integration Reference Point (IRP): Information Service".
157
+ - [7] 3GPP TS 32.302: "Telecommunication Management; Configuration Management (CM); Notification Integration Reference Point (IRP): Information Service (IS)".
158
+ - [8] ITU-T Recommendation M.3020 (2009): Management interface specification methodology – Annex E Information type definitions – type repertoire.
159
+ - [9] 3GPP TS 32.602: "Telecommunication Management; Configuration Management (CM): Basic CM IRP: Information Service (IS)".
160
+ - [10] 3GPP TS 32.612: "Telecommunication Management; Configuration Management (CM): Bulk CM IRP: Information Service (IS)".
161
+
162
+ # --- 3 Definitions and abbreviations
163
+
164
+ ## 3.1 Definitions
165
+
166
+ For the purposes of the present document, the terms and definitions given in 3GPP TS 32.101 [1], 3GPP TS 32.102 [2], 3GPP TS 32.150 [3] and the following apply:
167
+
168
+ **IRP Agent:** See 3GPP TS 32.150 [3].
169
+
170
+ **IRP Manager:** See 3GPP TS 32.150 [3].
171
+
172
+ ## 3.2 Abbreviations
173
+
174
+ For the purposes of the present document, the abbreviations given in 3GPP TS 32.101 [1], 3GPP TS 32.102 [2], 3GPP TS 32.150 [3] and the following apply:
175
+
176
+ | | |
177
+ |-----|----------------------------------|
178
+ | IOC | Information Object Class |
179
+ | IRP | Integration Reference Point |
180
+ | IS | Information Service |
181
+ | OMG | Object Management Group |
182
+ | UML | Unified Modelling Language (OMG) |
183
+
184
+ # --- 4 Information Service (IS) template
185
+
186
+ The present document contains the templates to be used for the production of all Integration Reference Point (IRP) Information Service (IS) specifications within the 3GPP 32-series.
187
+
188
+ For the introductory clause 1 (Scope) of all NRM IRP ISs, clause W1 shall be used.
189
+
190
+ For the introductory clause 1 (Scope) of all Interface IRP ISs, clause W2 shall be used.
191
+
192
+ For the introductory clauses 2 and 3 of all IRP ISs, the text shall be written conforming to the standard 3GPP TS template (i.e. not this IRP IS template).
193
+
194
+ The other clauses in this template that shall be used in the IS specifications following their introductory clauses are numbered starting with "X", which in general should correspond to clause 4 that is the beginning of the main part of the TS. However, if there is a need in a specific IS to introduce additional clauses in the body, X may correspond to a number higher than 4.
195
+
196
+ For a NRM IRP IS, only clause X shall be used.
197
+
198
+ For an Interface IRP IS, both clauses X and Y shall be used.
199
+
200
+ The IS template uses qualifiers M, O, CM, CO and C. The semantics of these qualifiers are defined in TS 32.150 [3].
201
+
202
+ The IS template uses Information Type as one characteristic to describe IOC attributes and operation/notification parameters. The valid Information Type(s) that can be used and their semantics are defined in ITU-T M.3020 Annex E [8].
203
+
204
+ Usage of fonts shall be according to the following table.
205
+
206
+ | Item | Font |
207
+ |-------------------------------------------------------------|-------------|
208
+ | Class names | Courier New |
209
+ | Attribute names | Courier New |
210
+ | Operation names | Courier New |
211
+ | Parameter names | Courier New |
212
+ | Assertion names | Courier New |
213
+ | Notification names | Courier New |
214
+ | Exception names | Courier New |
215
+ | State names | Arial |
216
+ | Matching Information | Courier New |
217
+ | Information Type | Courier New |
218
+ | Legal Values | Courier New |
219
+ | NOTE: These font requirements do not apply to UML diagrams. | |
220
+
221
+ ## --- W1 Scope
222
+
223
+ *The following quoted text is relevant for all NRM IRP ISs. It shall be copied as the first two paragraphs of the NRM IRP IS specification. IRP IS author may add additional paragraph(s) if necessary.*
224
+
225
+
226
+
227
+ The present document specifies the <<n>> (where <<n>> shall be substituted by the name of the NRM IRP IS concerned such as ‘HNS’, ‘E\_UTRAN’, ‘GERAN’) network resource information that can be communicated between an IRP Agent and one or several IRP Managers for network management purposes.
228
+
229
+ This document specifies the semantics and behaviour of information object class attributes and relations visible across the reference point in a protocol and technology neutral way. It does not define their syntax and encoding.
230
+
231
+
232
+
233
+ ## --- W2 Scope
234
+
235
+ *The following quoted text is relevant for all Interface IRP ISs. It shall be copied as the first two paragraphs of the Interface IRP IS specification. IRP IS author may add additional paragraph(s) if necessary.*
236
+
237
+
238
+
239
+ The present document specifies the <<n>> (where <<n>> shall be substituted by the name of the Interface IRP IS concerned such as “Alarm”, “Test”, “Entry Point”) management operations and notifications that can be communicated between an IRP Agent and one or several IRP Managers.
240
+
241
+ This document specifies the semantics and behaviour of operations, notifications and their parameters visible across the reference point in a protocol and technology neutral way. It does not define their syntax and encoding.
242
+
243
+
244
+
245
+ # --- X Information Object Classes
246
+
247
+ *This “X” clause shall be used for NRM IRP ISs. This “X” clause shall also be used for Interface IRP ISs.*
248
+
249
+ *“X” represents a clause number in the actual Information Service TS.*
250
+
251
+ ## X.1 Imported information entities and local labels
252
+
253
+ *This clause identifies a list of information entities (e.g. information object class, interface, information relationship, information attribute) that have been defined in other specifications and that are imported in the present specification. All imported entities shall be treated as if it is defined locally in present specification. One usage of import is for inheritance purpose. Each element of this list is a pair (label reference, local label). The label reference contains the name of the specification where it is defined, the type of the information entity and its name. The local label of imported information entities can then be used throughout the specification instead of the label reference.*
254
+
255
+ This information is provided in a table. An example of such a table is given here below:
256
+
257
+ | Label reference | Local label |
258
+ |---------------------------------------------------|-------------|
259
+ | 3GPP TS 32.622 [5], information object class, Top | Top |
260
+
261
+ ## X.2 Class diagram
262
+
263
+ ### X.2.1 Attributes and relationships
264
+
265
+ *This first set of diagrams represents all information object classes defined in this IS with all their relationships and all their attributes, including relationships with imported IOCs (if any). These diagrams shall contain information object class cardinalities (for associations as well as containment relationships) and may also contain association names and role names. These shall be UML compliant class diagrams (see also 3GPP TS 32.152 [4]).*
266
+
267
+ *Characteristics (attributes, relationships) of imported information object classes need not to be repeated in the diagrams. Information object classes should be defined using the stereotype <<InformationObjectClass>>.*
268
+
269
+ ### X.2.2 Inheritance
270
+
271
+ *This second set of diagrams represents the inheritance hierarchy of all information object classes defined in this IS. These diagrams do not need to contain the complete inheritance hierarchy but shall at least contain the parent information object classes of all information object classes defined in the present document. By default, an information object class inherits from the information object class "top". These shall be UML compliant class diagrams.*
272
+
273
+ *Characteristics (attributes, relationships) of imported information object classes need not to be repeated in the diagrams. Information object classes should be defined using the stereotype <<InformationObjectClass>>.*
274
+
275
+ *NOTE: some inheritance relationships presented in clause X.2.2 can be repeated in clause X.2.1 to enhance readability.*
276
+
277
+ ## X.3 Information object class definitions
278
+
279
+ Each information object class is defined using the following structure.
280
+
281
+ *Inherited items (attributes etc.) shall not be shown, as they are defined in the parent IOC(s) and thus valid for all subclasses.*
282
+
283
+ ### X.3.a InformationObjectClassName
284
+
285
+ *InformationObjectClassName is the name of the information object class.*
286
+
287
+ *"a" represents a number, starting at 1 and increasing by 1 with each new definition of an IOC.*
288
+
289
+ #### X.3.a.1 Definition
290
+
291
+ *The <definition> subclause is written in natural language. The <definition> subclause refers to the information object class itself. The characteristics related to the relationships that the object class can have with other object classes can't be found in the definition. The reader has to refer to relationships definition to find such kind of information. Information related to inheritance shall be precised here.*
292
+
293
+ *For NRM IRP ISs, information on traceability back to one or more requirements supported by this IOC should also be defined here, in the following form:*
294
+
295
+ | Referenced TS | Requirement label | Comment |
296
+ |---------------------|-------------------|------------------------|
297
+ | 3GPP TS 32.xyz [xy] | REQ-SM-CON-23 | Optional clarification |
298
+ | 3GPP TS 32.xyz [xy] | REQ-SM-FUN-11 | Optional clarification |
299
+
300
+ #### X.3.a.2 Attributes
301
+
302
+ *The <attributes> subclause presents the list of attributes, which are the manageable properties of the object class. Each element is a tuple (attributeName, supportQualifier, readQualifier, writeQualifier):*
303
+
304
+ - The supportQualifier indicates whether the attribute is Mandatory (M), Optional (O), Conditional-Mandatory (CM), Conditional-Optional (CO), SS-Conditional (C) or Not supported (—).*
305
+ - The readQualifier indicates whether the attribute shall be readable by the IRPManager. Allowed values are: Mandatory (M), Optional (O) and Not supported (—).*
306
+ - The writeQualifier indicates whether the attribute shall be writeable by the IRPManager. Allowed values are: Mandatory (M), Optional (O) and Not supported (—).*
307
+
308
+ *The semantics of the above used qualifiers are defined in TS 32.150 [3].*
309
+
310
+ *There is a dependency relationship between the supportQualifier, readQualifier, and writeQualifier. The supportQualifier indicates the requirements for the support of the attribute. For any given attribute, regardless of the value of the supportQualifier, at least one of the readQualifier or writeQualifier must be "M". The implication of the "O" supportQualifier is that the attribute is optional, however the read and write qualifiers indicate how the optional attribute shall be supported, should the optional attribute be supported.*
311
+
312
+ *Private or IRPAgent Internal attributes are per definition not readable by the IRPManager. Their readQualifier is hence always "—".*
313
+
314
+ *Private or IRPAgent Internal attributes are per definition not writable by the IRPManager. Their writeQualifier is hence always "—".*
315
+
316
+ *The readQualifier and writeQualifier of a supported attribute, that is public, may not be both "—".*
317
+
318
+ *The use of "—" in supportQualifier is reserved for documenting support of attributes defined by an «Archetype» IOC. Attributes with a supportQualifier of "—" are not implemented by the IOC that is realizing a subset of the attributes defined by the «Archetype». The readQualifier and writeQualifier are of no relevance in this case. However, a not supported attribute is neither readable nor writable. For this reason the readQualifier and writeQualifier shall be "—" for unsupported attributes.*
319
+
320
+ For any IOC that uses one or more attributes from an «Archetype», a separate table shall be used to indicate the supported attributes. This table is absent if no «Archetype» attributes are supported. For example, if a particular IOC has defined attributes (i.e. attributes not defined by an «Archetype») and encapsulates attributes from two «Archetype»s, then the totality of the attributes of said IOC will be contained in three separate tables.
321
+
322
+ This information is provided in a table. An example of such a table is given below:
323
+
324
+ | Attribute name | Support Qualifier | Read Qualifier | Write Qualifier |
325
+ |-------------------|-------------------|----------------|-----------------|
326
+ | ntfSubscriptionId | M | M | O |
327
+
328
+ Another example, where the support qualifier is "O" is given here below:
329
+
330
+ | Attribute name | Support Qualifier | Read Qualifier | Write Qualifier |
331
+ |-------------------|-------------------|----------------|-----------------|
332
+ | ntfSubscriptionId | O | M | O |
333
+
334
+ In this example, the ntfSubscriptionId is an optional attribute. If the implementation chose to support ntfSubscriptionId, then the said implementation is required to support read and may support write.
335
+
336
+ NOTE: This subclause shall state “There is no attribute defined.” when there is no attribute to define.
337
+
338
+ #### X.3.a.3 Attribute constraints
339
+
340
+ The <attribute constraints> subclause presents constraints for the attributes, and one use is to present the predicates for conditional qualifiers (CM/CO).
341
+
342
+ This information is provided in a table. An example of such a table is given here below:
343
+
344
+ | Name | Definition |
345
+ |----------------------------------------|-------------------------------------------------------------------------------------------------------------------------|
346
+ | pci CM write qualifier | Centralized PCI assignment (see TS 32.500, ref [15] subclause 6.1.6) is supported. |
347
+ | pciList CM support qualifier | Distributed PCI assignment (see TS 32.500, ref [15] subclause 6.1.6) is supported. |
348
+ | partOfSectorPower CM support qualifier | The IOC SectorEquipmentFunction is used. |
349
+ | attributeX max value | The value of attributeX shall be within the specified value range but may never be higher than the value of attributeY. |
350
+
351
+ NOTE: This subclause shall state “There is no attribute constraint defined.” when there is no attribute constraints to define.
352
+
353
+ #### X.3.a.4 Relationships
354
+
355
+ The <relationship> subclause presents the list of relationships in which this class is involved. Each element is a relationshipName.
356
+
357
+ NOTE: This subclause shall state “There is no attribute constraint defined.” when there is no relationship represented in the class diagram in clause X.2.1.
358
+
359
+ #### X.3.a.5 State diagram
360
+
361
+ The <state diagram> subclause contains state diagrams. A state diagram of an information object class defines permitted states of this information object class and the transitions between those states. A state is expressed in terms of individual attribute values or a combination of attribute values or involvement in relationships of the information object class being defined. This shall be a UML compliant state diagram.
362
+
363
+ NOTE: This subclause shall state “There is no State diagram defined.” when there is no State diagram defined.
364
+
365
+ #### X.3.a.6 Notifications
366
+
367
+ The <Notifications> subclause, for this IOC, presents:
368
+
369
+ - a) *optionally, a reference to the common notifications defined in subclause X.6 as valid for this IOC, and*
370
+ - b) *optionally, a list of notifications that shall be excluded from the list of common notifications (defined in subclause X.6) for this IOC (note: inherited notifications from the parent IOC(s) can not be excluded), and*
371
+ - c) *optionally, a list of notifications applicable to this IOC, and which may or may not be defined in the common notifications in subclause X.6.*
372
+
373
+ *The notifications identified in this subclause are notifications that can be emitted across the Itf-N, where the "object class" and "object instance" parameters of the notification header (see note 2) of these notifications identifies an instance of the IOC defined by the encapsulating subclause (i.e. clause X.3.a).*
374
+
375
+ *The notifications identified in this subclause, may originate from implementation object(s) whose identifier is mapped in the implementation, to the object instance identifier used over the Itf-N. Hence the presence of notifications in this clause (i.e. clause X.3.a.6) does not imply nor identify those notifications as being originated from an instance of the IOC defined by the encapsulating subclause (i.e. clause X.3.a).*
376
+
377
+ *The information related to option c) above is provided in a table. An example of such a table is given below:*
378
+
379
+ | Name | Qualifier | Notes |
380
+ |------------------------------------|-----------|-----------------------|
381
+ | notifyCMSynchronizationRecommended | O | Example notification. |
382
+
383
+ *NOTE 1: This subclause shall state "There is no notification defined for this IOC" when there is no notification defined for the IOC.*
384
+
385
+ *NOTE 2: The notification header is defined in the notification IRP Information service TS 32.302 [7].*
386
+
387
+ *NOTE 3: The qualifier of a notification, specified in Notification Table, indicates if such notification can carry the instance DN in the notification. The qualifier of a notification, specified in an Interface IRP, indicates the Interface IRP support level regarding the emission of the subject notification.*
388
+
389
+ *An IRPManager can receive notification-XYZ that carries DN of class-ABC instance if and only if:*
390
+
391
+ - a) *The class-ABC Notification Table defines the notification-XYZ and*
392
+ - b) *The class-ABC instance implementation supports this notification-XYZ and*
393
+ - c) *An Interface IRP defines the notification-XYZ and*
394
+ - d) *The Interface IRP implementation supports this notification-XYZ.*
395
+
396
+ ## X.4 Information relationship definitions
397
+
398
+ *Each information relationship is defined using the following structure.*
399
+
400
+ *Inherited relationships shall not be shown, as they are defined by the parent IOC(s) and thus valid for all subclasses.*
401
+
402
+ ### X.4.a InformationRelationshipName (supportQualifier)
403
+
404
+ *InformationRelationshipName is the name of the information relationship followed by a qualifier indicating whether the relationship is Mandatory (M), Optional (O), Conditional-Mandatory (CM), Conditional-Optional (CO), or SS-Conditional (C).*
405
+
406
+ *"a" represents a number, starting at 1 and increasing by 1 with each new definition of an information relationship.*
407
+
408
+ #### X.4.a.1 Definition
409
+
410
+ *The <definition> subclause is written in natural language.*
411
+
412
+ #### X.4.a.2 Roles
413
+
414
+ *The <roles> subclause identifies the roles played in the relationship by object classes. Each element is a pair (roleName, roleDefinition).*
415
+
416
+ This information is provided in a table. An example of such a table is given here below:
417
+
418
+ | Name | Definition |
419
+ |----------------|--------------------------------------------------|
420
+ | isSubscribedBy | This role represents the one who has subscribed. |
421
+
422
+ #### X.4.a.3 Constraints
423
+
424
+ *The <constraints> subclause contains the list of properties specifying the semantic invariants that must be preserved on the relationship. Each element is a pair (propertyName, propertyDefinition). Those properties are always held to be true during the lifetime of the relationship and don't need to be repeated in pre or post conditions of operations or notifications.*
425
+
426
+ This information is provided in a table. An example of such a table is given here below:
427
+
428
+ | Name | Definition |
429
+ |---------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
430
+ | inv_notificationCategoriesAllDistinct | The notification categories contained in the ntfNotificationCategorySet attribute of NtfSubscription playing the role theNtfSubscription are all distinct from each other. |
431
+
432
+ ## X.5 Information attribute definitions
433
+
434
+ *Each information attribute is defined using the following structure.*
435
+
436
+ *Inherited attributes shall not be shown, as they are defined in the parent IOC(s) and thus valid for all subclasses.*
437
+
438
+ ### X.5.1 Definition and Legal Values
439
+
440
+ *This subclause contains for each attribute being defined its Attribute Name, its Definition written in natural language, its Information Type (see [8]) and an optional list of Legal Values supported by the attribute.*
441
+
442
+ *In the case where the Legal Values can be enumerated, each element is a pair (Legal Value Name, Legal Value Semantics), unless a Legal Value Semantics applies to several values in which case the Semantics is provided only once. When the Legal Values cannot be enumerated, the list of Legal Values is defined by a single definition.*
443
+
444
+ This information is provided in a table. An example of such a table is given here below:
445
+
446
+ | Attribute Name | Definition | Information Type / Legal Values |
447
+ |----------------------|-----------------------------------------------------|------------------------------------------------------------------------------------------------------------|
448
+ | ntfSubscriptionId | It identifies uniquely a subscription | INTEGER / -- |
449
+ | ntfSubscriptionState | It indicates the activation state of a subscription | ENUMERATED /<br>"suspended": the subscription is suspended.<br>"notSuspended": the subscription is active. |
450
+
451
+ ### X.5.2 Constraints
452
+
453
+ *The <constraints> subclause indicates whether there are any constraints affecting attributes. Each constraint is defined by a pair (propertyName, propertyDefinition). PropertyDefinitions are expressed in natural language.*
454
+
455
+ An example is given here below:
456
+
457
+ | Name | Definition |
458
+ |----------------------|-------------------------------------------------------------|
459
+ | inv_TimerConstraints | The ntfTimeTickTimer is lower than or equal to ntfTimeTick. |
460
+
461
+ ## X.6 Common Notifications
462
+
463
+ *This <Common Notifications> subclause presents a list of notifications that can be referred to by any IOC defined by this IRP specification. These notifications are only applicable to IOCs referring to this subclause in subclause “X.3.a.6”. This information is provided in a table. An example of such a table is given below:*
464
+
465
+ | Name | Qualifier | Notes |
466
+ |----------------------------|-----------|-----------------------------|
467
+ | notifyAttributeValueChange | O | Example common notification |
468
+ | notifyObjectCreation | O | Example |
469
+ | notifyObjectDeletion | O | Example |
470
+
471
+ *NOTE: This clause does not need to be present when there are no common notifications.*
472
+
473
+ ## X.7 System State Model
474
+
475
+ *Some configurations of information are special or complex enough to justify the usage of a state diagram to clarify them. A state diagram in this clause defines permitted states of the system and the transitions between those states. A state is expressed in terms of a combination of attribute values constraints or involvement in relationships of one or more information object classes.*
476
+
477
+ # --- Y Interface Definition
478
+
479
+ *This "Y" clause shall be used for Interface IRP ISs.*
480
+
481
+ *"Y" represents a number, immediately following "X".*
482
+
483
+ ## Y.1 Class diagram representing interfaces
484
+
485
+ *Each interface is defined in the diagram. This shall be a UML compliant class diagram (see also 3GPP TS 32.152 [4]).*
486
+
487
+ *Interfaces are defined using a stereotype <<Interface>>. Each interface contains a set of either operations or notifications which are mandatory or either a single operation or a single notification which is optional. The support of an interface by an information object class is represented by a relationship between the 2 entities with a cardinality (1..1) if all the operations or notifications contained in the interface are mandatory, and (0..1) if the operation or notification contained in the interface is optional. On the class diagram, each operation and notification in an interface shall be qualified as "public" by the addition of a symbol "+" before each operation and notification.*
488
+
489
+ ## Y.2 Generic rules
490
+
491
+ *The following rules are relevant for all ISs. They shall simply be copied as part of the specification.*
492
+
493
+ *Rule 1: each operation with at least one input parameter supports a pre-condition valid\_input\_parameter which indicates that all input parameters shall be valid with regards to their information type. Additionally, each such operation supports an exception operation\_failed\_invalid\_input\_parameter which is raised when pre-condition valid\_input\_parameter is false. The exception has the same entry and exit state.*
494
+
495
+ *Rule 2: Each operation with at least one optional input parameter supports a set of pre-conditions supported\_optional\_input\_parameter\_yyy where "yyy" is the name of the optional input parameter and the pre-condition indicates that the operation supports the named optional input parameter. Additionally, each such operation supports an exception operation\_failed\_unsupported\_optional\_input\_parameter\_yyy which is raised when (a) the pre-condition supported\_optional\_input\_parameter\_yyy is false and (b) the named optional input parameter is carrying information. The exception has the same entry and exit state.*
496
+
497
+ *Rule 3: each operation shall support a generic exception operation\_failed\_internal\_problem which is raised when an internal problem occurs and that the operation cannot be completed. The exception has the same entry and exit state.*
498
+
499
+ ## Y.b InterfaceName Interface (supportQualifier)
500
+
501
+ *InterfaceName is the name of the interface followed by a qualifier indicating whether the interface is Mandatory (M), Optional (O), Conditional-Mandatory (CM), Conditional-Optional (CO), or SS-Conditional (C).*
502
+
503
+ *"b" represents a number, starting at 3 and increasing by 1 with each new definition of an interface.*
504
+
505
+ *Each interface is defined by its name and by a sequence of operations or notifications.*
506
+
507
+ *Interfaces related to operations shall be listed before the interfaces related to notifications.*
508
+
509
+ *If the interface is related to operation(s), the following Y.b.a "Operation OperationName (supportQualifier)" shall be applied.*
510
+
511
+ *If the interface is related to notification(s), the next Y.b.a "Notification NotificationName (supportQualifier)" below shall be applied.*
512
+
513
+ ### Y.b.a Operation OperationName (supportQualifier)
514
+
515
+ *OperationName is the name of the operation followed by a qualifier indicating whether the operation is Mandatory (M), Optional (O), Conditional-Mandatory (CM), Conditional-Optional (CO), or SS-Conditional (C).*
516
+
517
+ *"a" represents a number, starting at 1 and increasing by 1 with each new definition of an operation.*
518
+
519
+ #### Y.b.a.1 Definition
520
+
521
+ *The <definition> subclause is written in natural language.*
522
+
523
+ *Information on traceability back to one or more requirements supported by this operation should also be defined here, in the following form:*
524
+
525
+ | Referenced TS | Requirement label | Comment |
526
+ |---------------------|-------------------|-------------------------------|
527
+ | 3GPP TS 32.xyz [xy] | REQ-SM-CON-23 | <i>Optional clarification</i> |
528
+ | 3GPP TS 32.xyz [xy] | REQ-SM-FUN-11 | <i>Optional clarification</i> |
529
+
530
+ #### Y.b.a.2 Input parameters
531
+
532
+ *List of input parameters of the operation. Each element is a tuple (Parameter Name, Support Qualifier, Information Type (see [8] and Note 1) and an optional list of Legal Values supported by the parameter, Comment). Legal Values for the Support Qualifier are: Mandatory (M), Optional (O), Conditional-Mandatory (CM), Conditional-Optional (CO), or SS-Conditional (C).*
533
+
534
+ This information is provided in a table. An example of such a table is given here below:
535
+
536
+ | Parameter Name | Support Qualifier | Information Type / Legal Values | Comment |
537
+ |----------------|-------------------|---------------------------------|-------------------------------|
538
+ | eventIdList | M | SET OF INTEGER / -- | One or more event identifiers |
539
+
540
+ Note 1: Information Type qualifies the parameter of Parameter Name. In the case where the Legal Values can be enumerated, each element is a pair (Legal Value Name, Legal Value Semantics), unless a Legal Value Semantics applies to several values in which case the definition is provided only once. When the Legal Values cannot be enumerated, the list of Legal Values is defined by a single definition.
541
+
542
+ #### Y.b.a.3 Output parameters
543
+
544
+ *List of output parameters of the operation. Each element is a tuple (Parameter Name, Support Qualifier, Matching Information / Information Type (see [8]) (Note 1) and an optional list of Legal Values supported by the parameter, Comment). Legal Values for the Support Qualifier are: Mandatory (M), Optional (O), Conditional-Mandatory (CM), Conditional-Optional (CO), or SS-Conditional (C).*
545
+
546
+ This information is provided in a table. An example of such a table is given here below:
547
+
548
+ | Parameter Name | Support Qualifier | Matching Information / Information Type / Legal Values | Comment |
549
+ |----------------|-------------------|---------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
550
+ | eventTime | M | AlarmInformation.alarmRaisedTime / GeneralizedTime / -- | The parameter carries the <ul style="list-style-type: none"> <li>alarmRaisedTime in case notificationType carries notifyNewAlarm,</li> <li>alarmChangedTime in case notificationType carries notifyChangedAlarm,</li> <li>alarmClearedTime in case notificationType carries notifyClearedAlarm.</li> </ul> |
551
+
552
+ Note 1: Information Type qualifies the parameter of Parameter Name. In the case where the Legal Values can be enumerated, each element is a pair (Legal Value Name, Legal Value Semantics), unless a Legal Value Semantics applies to several values in which case the definition is provided only once. When the Legal Values cannot be enumerated, the list of Legal Values is defined by a single definition.
553
+
554
+ *This table shall also include a special parameter 'status' to indicate the completion status of the operation (success, partial success, failure reason etc.).*
555
+
556
+ #### Y.b.a.4 Pre-condition
557
+
558
+ *A pre-condition is a collection of assertions joined by AND, OR, and NOT logical operators. The pre-condition must be held to be true before the operation is invoked. An example is given here below:*
559
+
560
+ ```
561
+ notificationCategoriesNotAllSubscribed OR
562
+ notificationCategoriesParameterAbsentAndNotAllSubscribed
563
+ ```
564
+
565
+ Each assertion is defined by a pair (propertyName, propertyDefinition). All assertions constituting the pre-condition are provided in a table. An example of such a table is given here below:
566
+
567
+ | Assertion Name | Definition |
568
+ |----------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
569
+ | notificationCategoriesNotAllSubscribed | At least one notificationCategory identified in the notificationCategories input parameter is supported by IRPAGENT and is not a member of the ntfNotificationCategorySet attribute of an NtfSubscription which is involved in a subscription relationship with the NtfSubscriber identified by the managerReference input parameter. |
570
+ | notificationCategoriesParameterAbsentAndNotAllSubscribed | The notificationCategories input parameter is absent and at least one notificationCategory supported by IRPAGENT is not a member of the ntfNotificationCategorySet attribute of an ntfSubscription which is involved in a subscription relationship with the NtfSubscriber identified by the managerReference input parameter. |
571
+
572
+ #### Y.b.a.5 Post-condition
573
+
574
+ *A post-condition is a collection of assertions joined by AND, OR, and NOT logical operators. The post-condition must be held to be true after the completion of the operation. When nothing is said in a post-condition regarding an information entity, the assumption is that this information entity has not changed compared to what is stated in the pre-condition. An example is given here below:*
575
+
576
+ ```
577
+ subscriptionDeleted OR allSubscriptionDeleted
578
+ ```
579
+
580
+ Each assertion is defined by a pair (propertyName, propertyDefinition). All assertions constituting the post-condition are provided in a table. An example of such a table is given here below:
581
+
582
+ | Assertion Name | Definition |
583
+ |------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
584
+ | subscriptionDeleted | The ntfSubscription identified by subscriptionId input parameter is no more involved in a subscription relationship with the ntfSubscriber identified by the managerReference input parameter and has been deleted. If this ntfSubscriber has no more ntfSubscription, it is deleted as well. |
585
+ | allSubscriptionDeleted | In the case subscriptionId input parameter was absent, the ntfSubscriber identified by the managerReference input parameter is no more involved in any subscription relationship and is deleted, the corresponding ntfSubscription have been deleted as well. |
586
+
587
+ #### Y.b.a.6 Exceptions
588
+
589
+ *List of exceptions that can be raised by the operation. Each element is a tuple (exceptionName, condition, ReturnedInformation, exitState).*
590
+
591
+ ##### Y.b.a.6.c exceptionName
592
+
593
+ *ExceptionName is the name of an exception.*
594
+
595
+ *"c" represents a number, starting at 1 and increasing by 1 with each new definition of an exception.*
596
+
597
+ This information is provided in a table. An example of such a table is given here below:
598
+
599
+ | Exception Name | Definition |
600
+ |----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
601
+ | ope_failed_existing_subscription | <b>Condition:</b> (notificationCategoriesNotAllSubscribed OR notificationCategoriesParameterAbsentAndNotAllSubscribed) not verified.<br><b>Returned information:</b> output parameter status is set to OperationFailedExistingSubscription.<br><b>Exit state:</b> Entry State. |
602
+
603
+ *Each notification is defined using the following structure.*
604
+
605
+ #### Y.b.a.7 Constraints
606
+
607
+ *The < constraints> subclause presents constraints for the operation or its parameters.*
608
+
609
+ NOTE: This subclause does not need to be present when there are no constraints to define.
610
+
611
+ ### Y.b.a Notification NotificationName (supportQualifier)
612
+
613
+ *NotificationName is the name of the notification followed by a qualifier indicating whether the notification is Mandatory (M), Optional (O), Conditional-Mandatory (CM), Conditional-Optional (CO) or SS-Conditional (C).*
614
+
615
+ *"a" represents a number, starting at 1 and increasing by 1 with each new definition of a notification.*
616
+
617
+ #### Y.b.a.1 Definition
618
+
619
+ *The <definition> subclause is written in natural language.*
620
+
621
+ *Information on traceability back to one or more requirements supported by this notification should also be defined here, in the following form:*
622
+
623
+ | Referenced TS | Requirement label | Comment |
624
+ |---------------------|-------------------|-------------------------------|
625
+ | 3GPP TS 32.xyz [xy] | REQ-SM-CON-23 | <i>Optional clarification</i> |
626
+ | 3GPP TS 32.xyz [xy] | REQ-SM-FUN-11 | <i>Optional clarification</i> |
627
+
628
+ #### Y.b.a.2 Input parameters
629
+
630
+ *List of input parameters of the notification. Each element is a tuple (Parameter Name, Qualifiers, Matching Information / Information Type (see [8]) (Note 1) and an optional list of Legal Values supported by the parameter, Comment).*
631
+
632
+ *The column "Qualifiers" contains the two qualifiers, Support Qualifier and Filtering Qualifier, separated by a comma. The Support Qualifier indicates whether the attribute is Mandatory (M), Optional (O), Conditional-Mandatory (CM), Conditional-Optional (CO), or SS-Conditional (C). The Filtering Qualifier indicates whether the parameter of the notification can be filtered or not. Values are Yes (Y) or No (N).*
633
+
634
+ This information is provided in a table. An example of such a table is given here below:
635
+
636
+ | Parameter Name | Qualifiers | Matching Information / Information Type / Legal Values | Comment |
637
+ |------------------|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------|
638
+ | managerReference | M,Y | ntfSubscriber.ntfManagerReference / STRING / -- | It specifies the reference of IRPManager to which notifications shall be sent. |
639
+ | alarmType | M,Y | AlarmInformation.eventType / ENUMERATED /<br>"Communications Alarm": a communication error alarm.<br>"Processing Error Alarm": a processing error alarm.<br>"Environmental Alarm": an environmental violation alarm.<br>"Quality Of Service Alarm": a quality of service violation alarm.<br>"Equipment Alarm": an alarm related to equipment malfunction. | |
640
+
641
+ Note 1: Information Type qualifies the parameter of Parameter Name. In the case where the Legal Values can be enumerated, each element is a pair (Legal Value Name, Legal Value Semantics), unless a Legal Value Semantics applies to several values in which case the definition is provided only once. When the Legal Values cannot be enumerated, the list of Legal Values is defined by a single definition.
642
+
643
+ #### Y.b.a.3 Triggering event
644
+
645
+ *The triggering event for the notification to be sent is the transition from the information state defined by the "from state" subclause to the information state defined by the "to state" subclause.*
646
+
647
+ ##### Y.b.a.3.1 From state
648
+
649
+ *This subclause is a collection of assertions joined by AND, OR, and NOT logical operators. An example is given here below:*
650
+
651
+ *alarmMatched AND alarmInformationNotCleared*
652
+
653
+ *Each assertion is defined by a pair (propertyName, propertyDefinition). All assertions constituting the state "from state" are provided in a table. An example of such a table is given here below:*
654
+
655
+ | Assertion Name | Definition |
656
+ |----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|
657
+ | alarmMatched | The matching-criteria-attributes of the newly generated network alarm has values that are identical (matches) with ones in one AlarmInformation in AlarmList.. |
658
+ | alarmInformationNotCleared | The perceivedSeverity of the newly generated network alarm is not Cleared. |
659
+
660
+ ##### Y.b.a.3.2 To state
661
+
662
+ *This subclause is a collection of assertions joined by AND, OR and NOT logical operators. When nothing is said in a to-state regarding an information entity, the assumption is that this information entity has not changed compared to what is stated in the from state. An example is given here below:*
663
+
664
+ *resetAcknowledgementInformation AND perceivedSeverityUpdated*
665
+
666
+ *Each assertion is defined by a pair (propertyName, propertyDefinition). All assertions constituting the state "to state" are provided in a table. An example of such a table is given here below:*
667
+
668
+ | Assertion Name | Definition |
669
+ |---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
670
+ | resetAcknowledgementInformation | The matched AlarmInformation identified in inv_alarmMatched in pre-condition has been updated according to the following rule:<br>ackTime, ackUserId and ackSystemId are updated to contain no information;<br>ackState is updated to "unacknowledged". |
671
+ | perceivedSeverityUpdated | The perceivedSeverity attribute of matched AlarmInformation identified in inv_alarmMatched in pre-condition has been updated. |
672
+
673
+ #### Y.b.a.4 Constraints
674
+
675
+ *The < constraints> subclause presents constraints for the notification or its parameters.*
676
+
677
+ NOTE: This subclause does not need to be present when there are no constraints to define.
678
+
679
+ ## Y.c Scenario
680
+
681
+ *This subclause contains one or more sequence diagrams, each describing a possible scenario. These shall be UML compliant sequence diagrams. This is an optional subclause.*
682
+
683
+ # Annex A (informative): Change history
684
+
685
+ | Change history | | | | | | | | |
686
+ |----------------|-----------|---------------|----------|-----|----------------------------------------------------------------------------|---------|--------|--------|
687
+ | Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Ca<br>t | Old | New |
688
+ | Sep 2006 | SA_3<br>3 | SP-<br>060548 | 000<br>4 | -- | Update of 32.151 to use a MCC supported font | F | 6.3.0 | 7.0.0 |
689
+ | Dec 2006 | SA_3<br>4 | SP-<br>060724 | 000<br>5 | -- | Correct the clause numbering instructions for Operations and Notifications | F | 7.0.0 | 7.1.0 |
690
+ | Mar 2007 | SA_3<br>5 | SP-<br>070045 | 000<br>6 | -- | Suppress inherited items | F | 7.1.0 | 7.2.0 |
691
+ | Mar 2007 | SA_3<br>5 | SP-<br>070045 | 000<br>7 | -- | Improve specification of Common notifications | F | 7.1.0 | 7.2.0 |
692
+ | Mar 2007 | SA_3<br>5 | SP-<br>070045 | 000<br>8 | -- | Correct the references of IRP Agent and IRP Manager | F | 7.1.0 | 7.2.0 |
693
+ | Sep 2007 | SA_3<br>7 | SP-<br>070610 | 000<br>9 | -- | Correct open issues in the IS template | F | 7.2.0 | 8.0.0 |
694
+ | Sep 2007 | SA_3<br>7 | SP-<br>070610 | 001<br>0 | -- | Add missing instructions for Interface IRP ISs | F | 7.2.0 | 8.0.0 |
695
+ | Sep 2007 | SA_3<br>7 | SP-<br>070614 | 001<br>1 | -- | Remove visibility qualifier usage | C | 7.2.0 | 8.0.0 |
696
+ | Jun 2008 | SA_4<br>0 | SP-<br>080329 | 001<br>2 | -- | Introduction of traceability in the IS template | C | 8.0.0 | 8.1.0 |
697
+ | Mar 2009 | SA_4<br>3 | SP-<br>090207 | 001<br>3 | -- | Correct subclause numbering | F | 8.1.0 | 8.2.0 |
698
+ | Mar 2009 | -- | -- | -- | -- | Editorial modifications | -- | 8.2.0 | 8.2.1 |
699
+ | Jun 2009 | SA_4<br>4 | SP-<br>090290 | 001<br>4 | -- | Introduce Information Type in IS template | C | 8.2.1 | 9.0.0 |
700
+ | Sep 2009 | SA_4<br>5 | SP-<br>090627 | 001<br>5 | -- | Introduce Information Type in IS template | D | 9.0.0 | 9.1.0 |
701
+ | Dec 2009 | SA-46 | SP-<br>090719 | 001<br>6 | -- | Add template text for Scope section for all IRP IS | F | 9.1.0 | 9.2.0 |
702
+ | Mar 2010 | SA-47 | SP-<br>100035 | 001<br>7 | -- | Clarify support qualifier usage in Notification Table in 32.151 | F | 9.2.0 | 9.3.0 |
703
+ | Mar 2010 | SA-47 | SP-<br>100036 | 001<br>8 | -- | Clarify Attribute constraints | C | 9.3.0 | 10.0.0 |
704
+ | Mar 2010 | SA-47 | SP-<br>100036 | 001<br>9 | -- | Correct the pseudo subclause numbering | F | 9.3.0 | 10.0.0 |
705
+ | Sep 2010 | SA-49 | SP-<br>100488 | 008<br>2 | -- | Clarification on the meaning of the imported entities | A | 10.0.0 | 10.1.0 |
marked/Rel-10/32_series/32152/raw.md ADDED
@@ -0,0 +1,1024 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+ # **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; Integration Reference Point (IRP) Information Service (IS) Unified Modelling Language (UML) repertoire (Release 10)**
4
+
5
+ ![LTE Advanced logo](935eed7aa61f7777f62cfc032e11bee9_img.jpg)
6
+
7
+ The logo for LTE Advanced, featuring the word "lte" in bold lowercase letters with a red signal icon above the "e", and the word "ADVANCED" in smaller uppercase letters to the right. A trademark symbol (TM) is at the bottom right.
8
+
9
+ LTE Advanced logo
10
+
11
+ ![3GPP logo](30a26f2d17ca95672702bf50fb4f0242_img.jpg)
12
+
13
+ The 3GPP logo, consisting of the letters "3GPP" in a stylized font with a red signal icon below the "P", and the text "A GLOBAL INITIATIVE" in smaller uppercase letters below the logo. A trademark symbol (TM) is at the bottom right of the logo.
14
+
15
+ 3GPP logo
16
+
17
+ Keywords
18
+ UMTS, management
19
+
20
+ # **3GPP**
21
+
22
+ Postal address
23
+
24
+ ---
25
+
26
+ 3GPP support office address
27
+
28
+ ---
29
+
30
+ 650 Route des Lucioles - Sophia Antipolis
31
+ Valbonne - FRANCE
32
+ Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
33
+
34
+ Internet
35
+
36
+ ---
37
+
38
+ <http://www.3gpp.org>
39
+
40
+ # ***Copyright Notification***
41
+
42
+ No part may be reproduced except as authorized by written permission.
43
+ The copyright and the foregoing restriction extend to reproduction in all media.
44
+
45
+ © 2017, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
46
+ All rights reserved.
47
+
48
+ UMTS™ is a Trade Mark of ETSI registered for the benefit of its members
49
+ 3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
50
+ LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
51
+ GSM® and the GSM logo are registered and owned by the GSM Association
52
+
53
+ # Contents
54
+
55
+ | | |
56
+ |-----------------------------------------------------------------------------------------------------------|-----------|
57
+ | Foreword ..... | 5 |
58
+ | Introduction ..... | 5 |
59
+ | 1 Scope..... | 6 |
60
+ | 2 References..... | 6 |
61
+ | 3 Definitions and abbreviations ..... | 7 |
62
+ | 3.1 Definitions..... | 7 |
63
+ | 3.2 Abbreviations ..... | 7 |
64
+ | 4 Requirements ..... | 7 |
65
+ | 5 Model Elements and Notations..... | 8 |
66
+ | 5.1 Basic model elements..... | 8 |
67
+ | 5.1.1 attribute..... | 8 |
68
+ | 5.1.2 aggregation ..... | 8 |
69
+ | 5.1.3 operation..... | 8 |
70
+ | 5.1.4 association and association name ..... | 8 |
71
+ | 5.1.5 realization relationship ..... | 9 |
72
+ | 5.1.6 generalization relationship..... | 9 |
73
+ | 5.1.7 dependency relationship ..... | 9 |
74
+ | 5.1.8 note ..... | 10 |
75
+ | 5.1.9 multiplicity, a.k.a. cardinality..... | 10 |
76
+ | 5.1.10 rolename ..... | 10 |
77
+ | 5.1.11 Xor constraint..... | 10 |
78
+ | 5.2 Stereotype..... | 11 |
79
+ | 5.2.1 <<Interface>> ..... | 11 |
80
+ | 5.2.1.1 Sample ..... | 12 |
81
+ | 5.2.2 Void ..... | 12 |
82
+ | 5.2.3 <<ProxyClass>>..... | 12 |
83
+ | 5.2.3.1 Sample ..... | 12 |
84
+ | 5.2.4 <<Archetype>> ..... | 12 |
85
+ | 5.2.4.1 Sample ..... | 13 |
86
+ | 5.2.5 <<InformationObjectClass>>..... | 13 |
87
+ | 5.2.5.1 Sample ..... | 13 |
88
+ | 5.2.6 <<use>> and <<may use>>..... | 13 |
89
+ | 5.2.6.1 Sample for target <<Interface>> ..... | 14 |
90
+ | 5.2.6.2 Sample for target <<Notification>> ..... | 14 |
91
+ | 5.2.7 <<may realize>>..... | 15 |
92
+ | 5.2.7.1 Sample ..... | 15 |
93
+ | 5.2.8 Void ..... | 15 |
94
+ | 5.2.9 <<names>> ..... | 15 |
95
+ | 5.2.9.1 Sample ..... | 16 |
96
+ | 5.2.10 <<opt>> ..... | 16 |
97
+ | 5.2.10.1 Sample ..... | 16 |
98
+ | 5.2.11 <<Notification>>..... | 16 |
99
+ | 5.2.11.1 Sample ..... | 16 |
100
+ | 5.2.12 <<agent-internal-usage>> ..... | 17 |
101
+ | 5.2.12.1 Sample ..... | 17 |
102
+ | 5.2.13 <<SupportIOC>>..... | 17 |
103
+ | 5.2.13.1 Sample ..... | 17 |
104
+ | 5.3 Void..... | 18 |
105
+ | 5.4 Association classes..... | 18 |
106
+ | 5.4 Association classes..... | 19 |
107
+ | 5.5 Abstract Class..... | 20 |
108
+ | 5.5.1 Sample ..... | 20 |
109
+ | <b>Annex A (informative): Samples of using &lt;&lt;ProxyClass&gt;&gt; to model Link related IOCs.....</b> | <b>21</b> |
110
+
111
+ A.1 First Sample ..... 21
112
+
113
+ A.2 Second Sample..... 22
114
+
115
+ X.Y.1 AsFunction ..... 22
116
+
117
+ X.Y.1.1 Definition ..... 22
118
+
119
+ **Annex B (normative): Application of <<InformationObjectClass>> and <SupportIOC>> ..... 23**
120
+
121
+ Annex C (informative): Change history..... 24
122
+
123
+ # --- Foreword
124
+
125
+ This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP).
126
+
127
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
128
+
129
+ Version x.y.z
130
+
131
+ where:
132
+
133
+ - x the first digit:
134
+ - 1 presented to TSG for information;
135
+ - 2 presented to TSG for approval;
136
+ - 3 or greater indicates TSG approved document under change control.
137
+ - y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
138
+ - z the third digit is incremented when editorial only changes have been incorporated in the document.
139
+
140
+ # --- Introduction
141
+
142
+ The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below:
143
+
144
+ TS 32.150: Integration Reference Point (IRP) Concept and definitions
145
+
146
+ TS 32.151: Integration Reference Point (IRP) Information Service (IS) template
147
+
148
+ **TS 32.152: Integration Reference Point (IRP) Information Service (IS) Unified Modelling Language (UML) repertoire**
149
+
150
+ TS 32.153 Integration Reference Point (IRP) technology specific templates
151
+
152
+ TS 32.154 Backward and Forward Compatibility (BFC); Concept and definitions
153
+
154
+ TS 32.155 Requirements template
155
+
156
+ # --- 1 Scope
157
+
158
+ 3GPP has chosen UML to capture systems behaviour in the IRP IS context.
159
+
160
+ UML provides a rich set of concepts, notations and model elements to model distributive systems. Usage of all UML notations and model elements is not necessary for the purpose of IRP IS specifications. This TS documents the necessary and sufficient set of UML notations and model elements, including the ones built by the UML extension mechanism <<stereotype>>, for use by 3GPP IRP IS authors. Collectively, this set of notations and model elements is called the 3GPP IRP IS modelling repertoire.
161
+
162
+ The selection of the UML notations and model elements in this repertoire is based on the needs of the existing 3GPP IRP IS specifications. Future IRP IS releases may require the use of additional UML notations or model elements.
163
+
164
+ IRP IS specifications shall employ the UML notation and model elements of this repertoire and may also employ other UML notation and model elements considered necessary. However, before any other UML notation and model elements may be employed in an approved 3GPP IRP specification, the other notation and model elements should be agreed for inclusion first in this repertoire.
165
+
166
+ # --- 2 References
167
+
168
+ The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
169
+
170
+ - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
171
+ - For a specific reference, subsequent revisions do not apply.
172
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
173
+ - [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements".
174
+ - [2] 3GPP TS 32.102: "Telecommunication management; Architecture".
175
+ - [3] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions".
176
+ - [4] 3GPP TS 32.151: "Telecommunication management; Integration Reference Point (IRP) Information Service (IS) template".
177
+ - [5] OMG: "Unified Modelling Language Specification, Version 1.5".
178
+ <http://www.omg.org/spec/UML/1.5/>
179
+ - [6] 3GPP TS 32.602 "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP): Information Service (IS)".
180
+ - [7] 3GPP TS 32.612: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP): Information Service (IS)".
181
+ - [8] 3GPP TS 32.302: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP): Information Service (IS)".
182
+ - [9] 3GPP TS 32.404: "Telecommunication management; Performance Management (PM); Performance measurements - Definitions and template".
183
+ - [10] 3GPP TS 32.300: "Name convention for Managed Objects".
184
+
185
+ # --- 3 Definitions and abbreviations
186
+
187
+ ## 3.1 Definitions
188
+
189
+ For the purposes of the present document, the terms and definitions given in 3GPP TS 32.101 [1], 3GPP TS 32.102 [2], 3GPP TS 32.150 [3] and the following apply:
190
+
191
+ **Distinguished Name:** See 3GPP TS 32.300 [10].
192
+
193
+ **IRP Agent:** See 3GPP TS 32.150 [3].
194
+
195
+ **IRP Manager:** See 3GPP TS 32.150 [3].
196
+
197
+ **Naming attribute:** See 3GPP TS 32.300 [10].
198
+
199
+ **Notification:** See 3GPP TS 32.302 [8].
200
+
201
+ ## 3.2 Abbreviations
202
+
203
+ For the purposes of the present document, the abbreviations given in 3GPP TS 32.101 [1], 3GPP TS 32.102 [2], 3GPP TS 32.150 [3] and the following apply:
204
+
205
+ | | |
206
+ |-------|----------------------------------|
207
+ | CM | Configuration Management |
208
+ | DN | Distinguished Name |
209
+ | GERAN | GSM/EDGE Radio Access Network |
210
+ | IRP | Integration Reference Point |
211
+ | IS | Information Service |
212
+ | NRM | Network Resource Model |
213
+ | OMG | Object Management Group |
214
+ | UML | Unified Modelling Language (OMG) |
215
+
216
+ # --- 4 Requirements
217
+
218
+ IRP Agent can be characterized by several different but related models. The models can be exterior or interior to the IRP Agent. Exterior models are use case models and interior models are object models.
219
+
220
+ Current version of this TS focuses on the interior model aspects of IRP Agents.
221
+
222
+ The notation elements captured in this repertoire shall be used to model all aspects of NRM IRP IS (such as GERAN NRM IRP: IS) and (interface) IRP (such as Alarm IRP: IS).
223
+
224
+ All quotes are from [5].
225
+
226
+ Capitalized words are defined by various 3GPP IRP IS specifications or the reference [5].
227
+
228
+ # 5 Model Elements and Notations
229
+
230
+ ## 5.1 Basic model elements
231
+
232
+ UML defined a number of basic model elements. This subclause lists the selected subset for use in the repertoire. The semantics of the selected ones are defined in [5].
233
+
234
+ ### 5.1.1 attribute
235
+
236
+ See subclause 3.25 of [5].
237
+
238
+ This sample shows some attributes, listed as strings in the attribute compartment of the class `AlarmInformation`.
239
+
240
+ ![UML class diagram for AlarmInformation](731f533b0599c8e42a063f06e4332045_img.jpg)
241
+
242
+ A UML class diagram for `AlarmInformation`. The class is shown as a yellow rectangle with a red border. The top compartment contains the stereotype `<<SupportIOC>>` and the class name `AlarmInformation`. The second compartment lists the attributes: `alarmId`, `notificationId`, `clearUserId`, and `other attributes ...`. The third compartment is empty.
243
+
244
+ UML class diagram for AlarmInformation
245
+
246
+ ### 5.1.2 aggregation
247
+
248
+ See subclause 3.43.2.5 of [5].
249
+
250
+ This sample shows a hollow diamond attached to the end of a path to indicate aggregation. The diamond is attached to the class that is the aggregate.
251
+
252
+ ![UML diagram showing aggregation between ManagedElement and MscFunction](740442c999390734911677f01af0316d_img.jpg)
253
+
254
+ A UML diagram showing an aggregation relationship between two classes. On the left is a class box for `ManagedElement` (stereotype `<<InformationObjectClass>>`). On the right is a class box for `MscFunction` (stereotype `<<InformationObjectClass>>`). A horizontal line connects the two boxes. At the `ManagedElement` end of the line is a hollow diamond, indicating that `ManagedElement` is the aggregate.
255
+
256
+ UML diagram showing aggregation between ManagedElement and MscFunction
257
+
258
+ ### 5.1.3 operation
259
+
260
+ See subclause 3.26 of [5].
261
+
262
+ This sample shows two operations, shown as strings in the operation compartment of class `NotificationIRPManagement`, that the instance of `NotificationIRPManagement` may be requested to perform. The operation has a name, e.g. `subscribe` and a list of arguments (not shown).
263
+
264
+ ![UML class diagram for NotificationIRPManagement interface](6f119d066b5e51370df585ce69c94fb4_img.jpg)
265
+
266
+ A UML class diagram for the `NotificationIRPManagement` interface. The class is shown as a yellow rectangle with a red border. The top compartment contains the stereotype `<< Interface>>` and the class name `NotificationIRPManagement`. The second compartment lists the operations: `subscribe()` and `unsubscribe()`.
267
+
268
+ UML class diagram for NotificationIRPManagement interface
269
+
270
+ ### 5.1.4 association and association name
271
+
272
+ See subclause 3.41 of [5].
273
+
274
+ These two samples show a binary association between exactly two model elements. The association can include the possibility of relating a model element to itself. The first sample shows a bi-directional association in that each model element is aware of the other. The second sample shows a unidirectional association (shown with an open arrow at the target model element end) in that only the source model element is aware of the target model element and not vice-versa.
275
+
276
+ Association can be named, such as *abcd* and *label6* in the following samples.
277
+
278
+ ![UML diagrams showing associations between InformationObjectClass elements.](b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg)
279
+
280
+ ```
281
+
282
+ classDiagram
283
+ class YClass["<<InformationObjectClass>>\nYClass"]
284
+ class XClass["<<InformationObjectClass>>\nXClass"]
285
+ YClass -- XClass : abcd
286
+
287
+ class AClass["<<InformationObjectClass>>\nAClass"]
288
+ class BClass["<<InformationObjectClass>>\nBClass"]
289
+ AClass --> BClass : label6
290
+
291
+ ```
292
+
293
+ Two UML diagrams illustrating associations. The first shows a non-directional association between `<<InformationObjectClass>> YClass` and `<<InformationObjectClass>> XClass` labeled "abcd". The second shows a directed association from `<<InformationObjectClass>> AClass` to `<<InformationObjectClass>> BClass` labeled "label6".
294
+
295
+ UML diagrams showing associations between InformationObjectClass elements.
296
+
297
+ ### 5.1.5 realization relationship
298
+
299
+ See subclause 2.5.2.1 of [5].
300
+
301
+ This sample shows the realization relationship between a source model element, `AlarmIRP`, and a target model element, `AlarmIRPOperations_1`. The source model element implements the target model element. The target model element needs to be an `<<Interface>>`.
302
+
303
+ ![UML diagram showing a realization relationship between AlarmIRP and AlarmIRPOperations_1.](0b87abe67b21a93777287649c33e755d_img.jpg)
304
+
305
+ ```
306
+
307
+ classDiagram
308
+ class AlarmIRP["<<SupportIOC>>\nAlarmIRP"]
309
+ class AlarmIRPOperations_1["<<Interface>>\nAlarmIRPOperations_1"]
310
+ AlarmIRPOperations_1 : +getAlarmList()
311
+ AlarmIRPOperations_1 : +acknowledgeAlarms()
312
+ AlarmIRP ..|> AlarmIRPOperations_1
313
+
314
+ ```
315
+
316
+ A UML diagram illustrating a realization relationship. The source element `<<SupportIOC>> AlarmIRP` realizes the target interface `<<Interface>> AlarmIRPOperations_1`, which contains methods `getAlarmList()` and `acknowledgeAlarms()`. The relationship is shown with a solid line and a large open triangular arrowhead pointing to the interface.
317
+
318
+ UML diagram showing a realization relationship between AlarmIRP and AlarmIRPOperations\_1.
319
+
320
+ ### 5.1.6 generalization relationship
321
+
322
+ See subclause 3.50 of [5].
323
+
324
+ This sample shows a generalization relationship between a more general element (the `IRPAgent`) and a more specific element (the `IRPAgent_vendor_A`) that is fully consistent with the first element and that adds additional information.
325
+
326
+ ![UML diagram showing a generalization relationship between IRPAgent and IRPAgent_vendor_A.](0bf9346902e9a3bdabf05ceacc1947f5_img.jpg)
327
+
328
+ ```
329
+
330
+ classDiagram
331
+ class IRPAgent["<<InformationObjectClass>>\nIRPAgent"]
332
+ class IRPAgent_vendor_A["<<InformationObjectClass>>\nIRPAgent_vendor_A"]
333
+ IRPAgent_vendor_A --|> IRPAgent
334
+
335
+ ```
336
+
337
+ A UML diagram illustrating a generalization relationship. The specific element `<<InformationObjectClass>> IRPAgent_vendor_A` inherits from the general element `<<InformationObjectClass>> IRPAgent`. The relationship is shown with a solid line and a large open triangular arrowhead pointing to the general class.
338
+
339
+ UML diagram showing a generalization relationship between IRPAgent and IRPAgent\_vendor\_A.
340
+
341
+ ### 5.1.7 dependency relationship
342
+
343
+ See subclause 3.51 of [5].
344
+
345
+ This sample shows that `BClass` instances have a semantic relationship with `AClass` instances. It indicates a situation in which a change to the target element will require a change to the source element in the dependency.
346
+
347
+ ![UML diagram showing a dependency relationship between AClass and BClass.](9283a3f6b39120df9dc9aee4712b3a0a_img.jpg)
348
+
349
+ ```
350
+
351
+ classDiagram
352
+ class AClass["<<InformationObjectClass>>\nAClass"]
353
+ class BClass["<<InformationObjectClass>>\nBClass"]
354
+ BClass ..> AClass
355
+
356
+ ```
357
+
358
+ A UML diagram illustrating a dependency relationship. The source element `<<InformationObjectClass>> BClass` depends on the target element `<<InformationObjectClass>> AClass`. The relationship is shown with a dashed line and an open arrowhead pointing to the target class.
359
+
360
+ UML diagram showing a dependency relationship between AClass and BClass.
361
+
362
+ ### 5.1.8 note
363
+
364
+ See subclause 3.11 of [5].
365
+
366
+ This sample shows a note, as a rectangle with a "bent corner" in the upper right corner. The note contains arbitrary text. It appears on a particular diagram and may be attached to zero or more modelling elements by dashed lines.
367
+
368
+ ![Diagram showing a note attached to an Information Object Class box.](e6df2733626a85205c1db682e6259c46_img.jpg)
369
+
370
+ A diagram showing a yellow box labeled "<<InformationObjectClass>> SubNetwork". To its right, a note box with a folded top-right corner contains the text "This is a sample of a note." A line connects the right side of the class box to the note box.
371
+
372
+ Diagram showing a note attached to an Information Object Class box.
373
+
374
+ ### 5.1.9 multiplicity, a.k.a. cardinality
375
+
376
+ See subclause 3.44 of [5].
377
+
378
+ This sample shows a multiplicity attached to the end of an association path. The meaning of this multiplicity is that one to many. Network instance(s) is associated with zero, one or more SubNetwork instances.
379
+
380
+ In Release 7 and earlier versions, the cardinality zero can indicate that the IOC has the so-called “transient state” characteristic. For example, it indicates that the instance is not yet created but it is in the process of being created. In Release 8 and onwards, the cardinality zero will not be used to indicate this characteristic since such characteristic is considered inherent in all IOCs. In Release 8 and onwards, all IOCs defined are considered to have such inherent “transient state” characteristics.
381
+
382
+ ![Diagram showing a Network class associated with a SubNetwork class with a 0..* multiplicity.](54fabc351eda5228d2fa28cd9ba07971_img.jpg)
383
+
384
+ A diagram showing two yellow boxes. The left box is labeled "<<InformationObjectClass>> Network" and the right box is labeled "<<InformationObjectClass>> SubNetwork". A horizontal line with an arrow points from the Network box to the SubNetwork box. Near the arrowhead, the multiplicity "0..\*" is displayed.
385
+
386
+ Diagram showing a Network class associated with a SubNetwork class with a 0..\* multiplicity.
387
+
388
+ ### 5.1.10 rolename
389
+
390
+ See subclause 3.43.2.6 of [5].
391
+
392
+ This sample shows a Person (say instance John) is associated with a Company (say whose DN is “Company=XYZ”). We navigate the association by using the opposite association-end such that John’s Person.theCompany would hold the DN, i.e."Company=XYZ". Use noun for the rolename.
393
+
394
+ ![Diagram showing a Person class associated with a Company class with the rolename +theCompany.](fc69ceb1dee1da7e33bd6c38fc4ceab9_img.jpg)
395
+
396
+ A diagram showing two yellow boxes. The left box is labeled "<<InformationObjectClass>> Company" and the right box is labeled "<<InformationObjectClass>> Person". A horizontal line with an arrow points from the Person box to the Company box. Near the arrowhead, the rolename "+theCompany" is displayed.
397
+
398
+ Diagram showing a Person class associated with a Company class with the rolename +theCompany.
399
+
400
+ ### 5.1.11 Xor constraint
401
+
402
+ See subclause 2.5.2.3 and 3.42.5.1 of [5].
403
+
404
+ This sample shows an Account (e.g. account 0960) that is associated with a Person (e.g. John Smith) or a Corporation (e.g. ABC Inc).
405
+
406
+ ![UML Class Diagram showing Account as a base class for Person and Corporation with an {xor} constraint.](5a4e62bead259c258d069fd3663ea670_img.jpg)
407
+
408
+ ```
409
+
410
+ classDiagram
411
+ class Account {
412
+ <<InformationObjectClass>>
413
+ }
414
+ class Person {
415
+ <<InformationObjectClass>>
416
+ }
417
+ class Corporation {
418
+ <<InformationObjectClass>>
419
+ }
420
+ Account <|-- Person : {xor}
421
+ Account <|-- Corporation : {xor}
422
+
423
+ ```
424
+
425
+ UML Class Diagram showing Account as a base class for Person and Corporation with an {xor} constraint.
426
+
427
+ ## 5.2 Stereotype
428
+
429
+ This subclause lists all allowable stereotypes to be used in IRP IS specifications. One stereotype <<Interface>> is defined in [5]. This document lists it out for ease of reference and completeness. Other stereotypes are defined in this document.
430
+
431
+ **Table: Stereotypes**
432
+
433
+ | Stereotype | Base Class | Affected Metamodel Elements |
434
+ |------------------------|----------------------------------------|-----------------------------|
435
+ | Interface | Class | |
436
+ | ProxyClass | Class | |
437
+ | Notification | Class | |
438
+ | Archetype | Classifier (subclause 2.5.2.10 of [5]) | |
439
+ | InformationObjectClass | Classifier | |
440
+ | SupportIOC | Classifier | |
441
+ | agent-internal-usage | Association | |
442
+ | use | Association | |
443
+ | may use | Association | |
444
+ | may realize | Association | |
445
+ | names | Composition | -- |
446
+
447
+ ### 5.2.1 <<Interface>>
448
+
449
+ Subclause 2.5.2.25 of [5]:
450
+
451
+ "An interface is a named set of operations that characterize the behaviour of an element. In the metamodel, an Interface contains a set of Operations that together define a service offered by a Classifier realizing the Interface. A Classifier may offer several services, which means that it may realize several Interfaces, and several Classifiers may realize the same Interface.
452
+
453
+ Interfaces may not have Attributes, Associations, or Methods. An Interface may participate in an Association provided the Interface cannot see the Association; that is, a Classifier (other than an Interface) may have an Association to an Interface that is navigable from the Classifier but not from the Interface."
454
+
455
+ Subclause 2.5.4.6 of [5]: "The purpose of an interface is to collect a set of operations that constitute a coherent service offered by classifiers. Interfaces provided a way to partition and characterize groups of operations. An interface is only a collection of operations with a name. It cannot be directly instantiated. Instantiable classifiers, such as class or use case, may use interfaces for specifying different services offered by their instances. Several classifiers may realize the same interface. All of them must contain at least the operations matching those contained in the interface. The specification of an operation contains the signature of the operation (i.e. its name, the types of the parameters and the return type). An interface does not imply any internal structure of the realizing classifier. For example, it does not include which algorithm to use for realizing an operation."
456
+
457
+ An operation may, however, include a specification of the effects [e.g. with pre and post-conditions] of its invocation.
458
+
459
+ #### 5.2.1.1 Sample
460
+
461
+ This sample shows an AlarmIRPOperations\_1 <<Interface>> that has two operations. The input and output parameters of the operations are hidden (i.e. not shown). The AlarmIRP has a unidirectional mandatory realization relationship with the <<Interface>>.
462
+
463
+ ![UML diagram showing the <<Interface>> Notation. A class box labeled <<SupportIOC>> AlarmIRP is connected by a solid line with an open triangle arrowhead to an interface box labeled <<Interface>> AlarmIRPOperations_1. The interface box contains two methods: getAlarmList() and acknowledgeAlarms().](27b06ec9f42b5d727a2630f61a5f1861_img.jpg)
464
+
465
+ ```
466
+
467
+ classDiagram
468
+ class AlarmIRP {
469
+ <<SupportIOC>>
470
+ }
471
+ class AlarmIRPOperations_1 {
472
+ <<Interface>>
473
+ getAlarmList()
474
+ acknowledgeAlarms()
475
+ }
476
+ AlarmIRP --|> AlarmIRPOperations_1
477
+
478
+ ```
479
+
480
+ UML diagram showing the <> Notation. A class box labeled <> AlarmIRP is connected by a solid line with an open triangle arrowhead to an interface box labeled <> AlarmIRPOperations\_1. The interface box contains two methods: getAlarmList() and acknowledgeAlarms().
481
+
482
+ **<<Interface>> Notation**
483
+
484
+ ### 5.2.2 Void
485
+
486
+ ### 5.2.3 <<ProxyClass>>
487
+
488
+ It is a form or template representing a number of <<InformationObjectClass>>. It encapsulates attributes, links, methods (or operations), and interactions that are present in the represented <<InformationObjectClass>>.
489
+
490
+ The semantics of a <<ProxyClass>> is that all behaviour of the <<ProxyClass>> is present in the represented <<InformationObjectClass>>. Since this class is simply a representation of other classes, this class cannot define its own behaviour other than those already defined by the represented <<InformationObjectClass>>.
491
+
492
+ A particular <<InformationObjectClass>> can be represented by zero, one or more <<ProxyClass>> or <<Archetype>>. For example, the ManagedElement <<InformationObjectClass>> can have MonitoredEntity <<ProxyClass>> and ManagedEntity <<ProxyClass>>.
493
+
494
+ The attributes of the <<ProxyClass>> are accessible by the source entity that has an association with the <<ProxyClass>>.
495
+
496
+ #### 5.2.3.1 Sample
497
+
498
+ This shows a <<ProxyClass>> named MonitoredEntity. It represents all NRM <<InformationObjectClass>> (e.g. GgsnFunction <<InformationObjectClass>>) whose instances are being monitored for alarm conditions.
499
+
500
+ Note that <<MonitoredEntity>> does not define any attribute. The attributes are already defined by all NRM <<InformationObjectClass>>.
501
+
502
+ ![UML diagram showing the <<ProxyClass>> Notation. A class box labeled <<ProxyClass>> MonitoredEntity is connected by a solid line to a callout box containing the text: 'It represents all NRM IOCs that can have alarms.'](426efb7efdc753a13f2fa16f7bff9429_img.jpg)
503
+
504
+ ```
505
+
506
+ classDiagram
507
+ class MonitoredEntity {
508
+ <<ProxyClass>>
509
+ }
510
+ MonitoredEntity --> Callout : It represents all NRM IOCs that can have alarms.
511
+
512
+ ```
513
+
514
+ UML diagram showing the <> Notation. A class box labeled <> MonitoredEntity is connected by a solid line to a callout box containing the text: 'It represents all NRM IOCs that can have alarms.'
515
+
516
+ **<<ProxyClass>> Notation**
517
+
518
+ See Annex A for more samples that use <<ProxyClass>>.
519
+
520
+ ### 5.2.4 <<Archetype>>
521
+
522
+ It is a form or template representing common class properties (e.g. attributes, links, operations and interactions) of a number of represented <<InformationObjectClass>>.
523
+
524
+ The semantics of an <<Archetype>> is that all attributes, links operations and interactions encapsulated by the <<Archetype>> may or may not be present in the represented <<InformationObjectClass>>. The <<Archetype>> represents a placeholder class that is most useful in technology neutral analysis models that will require further specification and/or mapping within a more complete construction model.
525
+
526
+ #### 5.2.4.1 Sample
527
+
528
+ This shows an <<Archetype>> StateManagement. It also shows an <<InformationObjectClass>> IRPAgent that depends on this StateManagement. Note that the StateManagement has defined a number of attributes (not shown in the UML diagram).
529
+
530
+ The classes that depend on this `StateManagement` may or may not use all of the `StateManagement` attributes. In other words, at least one of the attributes of `StateManagement` is present in the `IRPAgent`. The precise set of `StateManagement` attributes used by the `IRPAgent` is specified in specification that defines the `IRPAgent`.
531
+
532
+ ![UML diagram showing a dependency from IRPAgent to StateManagement. The StateManagement class is labeled with <<Archetype>> and the IRPAgent class is labeled with <<InformationObjectClass>>. A dashed arrow points from IRPAgent to StateManagement.](cab0834804fb031b43865554cc8d06ab_img.jpg)
533
+
534
+ ```
535
+
536
+ classDiagram
537
+ class StateManagement {
538
+ <<Archetype>>
539
+ }
540
+ class IRPAgent {
541
+ <<InformationObjectClass>>
542
+ }
543
+ IRPAgent --|> StateManagement
544
+
545
+ ```
546
+
547
+ UML diagram showing a dependency from IRPAgent to StateManagement. The StateManagement class is labeled with <> and the IRPAgent class is labeled with <>. A dashed arrow points from IRPAgent to StateManagement.
548
+
549
+ **<<Archetype>> Notation**
550
+
551
+ ### 5.2.5 <<InformationObjectClass>>
552
+
553
+ It is the descriptor for a set of network resources and network management capabilities. Each `<<InformationObjectClass>>` represents a set of instances with similar structure, behaviour and relationships.
554
+
555
+ This `<<InformationObjectClass>>` and other information classes such as `<<Interface>>` are mapped into technology specific model elements. The mapping of IS modelling constructs to technology specific modelling constructs are captured in the corresponding IRP Solution Set specifications.
556
+
557
+ The name of an `<<InformationObjectClass>>` has scope within the 3GPP IRP IS document in which it is specified and the name must be unique among all `<<InformationObjectClass>>` names within that 3GPP IRP IS document. The IRP IS document name is considered in the similar way as the UML Package-name.
558
+
559
+ The `<<InformationObjectClass>>` is identical to UML *class* except that it does not include/define methods or operations.
560
+
561
+ Subclause 3.22.1 of [5]: "A *class* represents a concept within the system being modelled. Classes have data structure and behaviour and relationships to other elements."
562
+
563
+ See Annex B for information on various application of this Stereotype when compared to that of `<<SupportIOC>>`.
564
+
565
+ #### 5.2.5.1 Sample
566
+
567
+ This sample shows an `RncFunction` `<<InformationObjectClass>>`.
568
+
569
+ ![UML diagram showing an InformationObjectClass named RncFunction. The class is represented by a yellow box with the stereotype <<InformationObjectClass>> and the name RncFunction.](cce70c739081f63a6af83dc9483f98ce_img.jpg)
570
+
571
+ ```
572
+
573
+ classDiagram
574
+ class RncFunction {
575
+ <<InformationObjectClass>>
576
+ }
577
+
578
+ ```
579
+
580
+ UML diagram showing an InformationObjectClass named RncFunction. The class is represented by a yellow box with the stereotype <> and the name RncFunction.
581
+
582
+ **<<InformationObjectClass>> Notation**
583
+
584
+ ### 5.2.6 <<use>> and <<may use>>
585
+
586
+ The `<<use>>` and `<<may use>>` are unidirectional associations. The target must be an `<<Interface>>` or `<<Notification>>`.
587
+
588
+ In the case where the target is `<<Interface>>`, the `<<use>>` states that the source class must have the capability to use the target `<<Interface>>` in that it can invoke the operations defined by the `<<Interface>>`. Support of the capability by the source entity is mandatory. The `<<may use>>` states that the source class may have the capability to use the target `<<Interface>>` in that it may invoke the operations defined by the `<<Interface>>`. Support of the capability by the source entity is optional.
589
+
590
+ In the case the target is `<<Notification>>`, the `<<use>>` states that the source class must be the originator of the notifications defined by the target `<<Notification>>`. Support of the capability by the source entity is mandatory. The `<<may use>>` states that the source class may be the originator of the notifications defined by the target `<<Notification>>`. Support of the capability by the source entity is optional.
591
+
592
+ #### 5.2.6.1 Sample for target <<Interface>>
593
+
594
+ This shows that the IRPManager shall use the operations defined by AlarmIRPOperations\_1 and may use the operations defined by AlarmIRPOperations\_2.
595
+
596
+ ![UML diagram showing IRPManager using AlarmIRPOperations_1 and AlarmIRPOperations_2.](a26e142d3df5bef41a84a9dd099d7825_img.jpg)
597
+
598
+ ```
599
+ classDiagram
600
+ class IRPManager {
601
+ <<SupportIOC>>
602
+ }
603
+ class AlarmIRPOperations_1 {
604
+ <<Interface>>
605
+ getAlarmList()
606
+ acknowledgeAlarms()
607
+ }
608
+ class AlarmIRPOperations_2 {
609
+ <<Interface>>
610
+ getAlarmCount()
611
+ }
612
+ IRPManager --> AlarmIRPOperations_1 : <<use>>
613
+ IRPManager --> AlarmIRPOperations_2 : <<may use>>
614
+ ```
615
+
616
+ The diagram illustrates the relationship between a SupportIOC and two Interfaces. On the left is a box labeled <<SupportIOC>> IRPManager. Two arrows originate from this box. The first arrow points to a box labeled <<Interface>> AlarmIRPOperations\_1, which contains the operations getAlarmList() and acknowledgeAlarms(). This arrow is labeled <<use>>. The second arrow points to a box labeled <<Interface>> AlarmIRPOperations\_2, which contains the operation getAlarmCount(). This arrow is labeled <<may use>>.
617
+
618
+ UML diagram showing IRPManager using AlarmIRPOperations\_1 and AlarmIRPOperations\_2.
619
+
620
+ **<<use>> and <<may use>> Notation for target <<Interface>>**
621
+
622
+ #### 5.2.6.2 Sample for target <<Notification>>
623
+
624
+ This shows that the PMIRP shall have the capability to emit or originate notifications defined by PMIRPNotifications\_1 and may have the capability to emit or originate notifications defined by PMIRPNotifications\_2.
625
+
626
+ ![UML diagram showing PMIRP using PMIRPNotifications_1 and PMIRPNotifications_2.](c036e2540a94b31357ceb0002f0cacab_img.jpg)
627
+
628
+ ```
629
+ classDiagram
630
+ class PMIRP {
631
+ <<SupportIOC>>
632
+ }
633
+ class PMIRPNotifications_1 {
634
+ <<Notification>>
635
+ notifyMeasurementJobStatusChanger...
636
+ }
637
+ class PMIRPNotifications_2 {
638
+ <<Notification>>
639
+ notifyThresholdMonitorStatusChanger...
640
+ notifyThresholdMonitorObjectCreation()
641
+ notifyThresholdMonitorObjectDeletion()
642
+ }
643
+ PMIRP --> PMIRPNotifications_1 : <<use>>
644
+ PMIRP --> PMIRPNotifications_2 : <<may use>>
645
+ ```
646
+
647
+ The diagram illustrates the relationship between a SupportIOC and two Notifications. On the left is a box labeled <<SupportIOC>> PMIRP. Two arrows originate from this box. The first arrow points to a box labeled <<Notification>> PMIRPNotifications\_1, which contains the operation notifyMeasurementJobStatusChanger... This arrow is labeled <<use>>. The second arrow points to a box labeled <<Notification>> PMIRPNotifications\_2, which contains the operations notifyThresholdMonitorStatusChanger..., notifyThresholdMonitorObjectCreation(), and notifyThresholdMonitorObjectDeletion(). This arrow is labeled <<may use>>.
648
+
649
+ UML diagram showing PMIRP using PMIRPNotifications\_1 and PMIRPNotifications\_2.
650
+
651
+ **<<use>> and <<may use>> Notation for target <<Notification>>**
652
+
653
+ ### 5.2.7 <<may realize>>
654
+
655
+ The <<may realize>> is an unidirectional association. The target must be an <<Interface>>. The <<may realize>> shows that the source entity may realize the operations defined by the target <<Interface>>.
656
+
657
+ Note that the UML basic element has defined the realize association (and therefore, there is no need to define a stereotype of such association). The realize association shows that the source entity must realize (or implement) the operations defined by the target <<Interface>>.
658
+
659
+ #### 5.2.7.1 Sample
660
+
661
+ This shows that the AlarmIRP may realize the operation of AlarmIRPOperations\_2.
662
+
663
+ ![UML diagram showing a <<may realize>> association between AlarmIRP and AlarmIRPOperations_2.](c67d21fb3d9042e88cdc669f071b4e7c_img.jpg)
664
+
665
+ ```
666
+
667
+ classDiagram
668
+ class AlarmIRP {
669
+ <<SupportIOC>>
670
+ }
671
+ class AlarmIRPOperations_2 {
672
+ <<Interface>>
673
+ getAlarmCount()
674
+ }
675
+ AlarmIRP --> AlarmIRPOperations_2 : <<may realize>>
676
+
677
+ ```
678
+
679
+ UML diagram showing a <> association between AlarmIRP and AlarmIRPOperations\_2.
680
+
681
+ <<may realize>> Notations
682
+
683
+ ### 5.2.8 Void
684
+
685
+ ### 5.2.9 <<names>>
686
+
687
+ It specifies a unidirectional composition. The target instance is uniquely identifiable, within the namespace of the source entity, among all other targeted instances of the same target classifier and among other targeted instances of other classifiers that have the same <<names>> composition with the source.
688
+
689
+ The source classifier and target classifier shall both have a naming attribute.
690
+
691
+ Composition used as the act of name containment provides a semantic of a whole-part relationship between the domain and the named elements that are contained, even if only by name. From the management perspective access to the part is through the whole. Multiplicity shall be indicated at both ends of the relationship.
692
+
693
+ A target instance can not have multiple <<names>> with multiple sources, i.e. a target instance can not participate in or belong to multiple namespaces.
694
+
695
+ #### 5.2.9.1 Sample
696
+
697
+ This shows that all instances of MscFunction are uniquely identifiable within a ManagedElement instance's namespace.
698
+
699
+ ![UML diagram showing a <<names>> composition between ManagedElement and MscFunction.](95cd9f56a54683029052b8c644228506_img.jpg)
700
+
701
+ ```
702
+
703
+ classDiagram
704
+ class ManagedElement {
705
+ <<InformationObjectClass>>
706
+ }
707
+ class MscFunction {
708
+ <<InformationObjectClass>>
709
+ }
710
+ ManagedElement "1" *--> "0..*" MscFunction : <<names>>
711
+
712
+ ```
713
+
714
+ UML diagram showing a <> composition between ManagedElement and MscFunction.
715
+
716
+ <<names>> Notation
717
+
718
+ ### 5.2.10 <<opt>>
719
+
720
+ The <<opt>> (alternatively <<optional>>) enables the indication of optionality of attributes, parameters and operations (respectively) within the UML diagrams. The semantics of optionality are defined in TS 32.150 [3].
721
+
722
+ In the absence of the stereotype, the attribute, parameter, or operation in question is mandatory.
723
+
724
+ #### 5.2.10.1 Sample
725
+
726
+ ![UML class diagram for BulkCMActive interface](16152cf1d84aea10848758f51a91ff6a_img.jpg)
727
+
728
+ ```
729
+
730
+ classDiagram
731
+ class BulkCMActive {
732
+ << Interface >>
733
+ download()
734
+ <<opt>> validate()
735
+ <<opt>> preactivate()
736
+ activate()
737
+ fallback()
738
+ }
739
+
740
+ ```
741
+
742
+ UML class diagram for BulkCMActive interface
743
+
744
+ <<opt>> Notation for operations
745
+
746
+ ### 5.2.11 <<Notification>>
747
+
748
+ <<Notification>> is a named set of notifications.
749
+
750
+ #### 5.2.11.1 Sample
751
+
752
+ This sample shows a <<Notification>> named “PMIRPNotifications\_1” and another <<Notification>> named “PMIRPNotifications\_2”. Both of them have notification(s). An example of a notification can be notifyMeasurementJobStatusChanged().
753
+
754
+ ![UML class diagram showing PMIRP associated with two Notification classes](f57a881fcbcaf494a7dedc4f61224991_img.jpg)
755
+
756
+ ```
757
+
758
+ classDiagram
759
+ class PMIRP {
760
+ <<SupportIOC>>
761
+ }
762
+ class PMIRPNotifications_1 {
763
+ <<Notification>>
764
+ notifyMeasurementJobStatusChanged()
765
+ }
766
+ class PMIRPNotifications_2 {
767
+ <<Notification>>
768
+ notifyThresholdMonitorStatusChanged()
769
+ notifyThresholdMonitorObjectCreated()
770
+ notifyThresholdMonitorObjectDeleted()
771
+ }
772
+ PMIRP --> PMIRPNotifications_1
773
+ PMIRP --> PMIRPNotifications_2
774
+
775
+ ```
776
+
777
+ UML class diagram showing PMIRP associated with two Notification classes
778
+
779
+ <<Notification>> Notation
780
+
781
+ ### 5.2.12 <<agent-internal-usage>>
782
+
783
+ This is a unidirectional association. The source passes network management information to target. The source and target are entities or processes running in different IRP instances such as AlarmIRP, PMIRP. The instances may be name-contained by the same IRP Agent or different IRP Agent instances. The precise network management information passed and the information transfer mechanism are not standardized and are vendor-specific.
784
+
785
+ #### 5.2.12.1 Sample
786
+
787
+ This shows that NLIRP (NotificationLog IRP) can pass some network management information to FTIRP.
788
+
789
+ ![UML diagram showing a directed association between two SupportIOC elements. The source element is labeled NLIRP and the target element is labeled FileTransferRP. The association is labeled with the stereotype <<agent-internal-usage>>. Below the diagram is the caption '<<agent-internal-usage>> Notation'.](8307f6b04df072c9332f9987e034272c_img.jpg)
790
+
791
+ **<<agent-internal-usage>> Notation**
792
+
793
+ UML diagram showing a directed association between two SupportIOC elements. The source element is labeled NLIRP and the target element is labeled FileTransferRP. The association is labeled with the stereotype <>. Below the diagram is the caption '<> Notation'.
794
+
795
+ ### 5.2.13 <<SupportIOC>>
796
+
797
+ It is the descriptor for a set of management capabilities.
798
+
799
+ The <<SupportIOC>> is identical to UML *class* except that it does not include/define methods or operations.
800
+
801
+ Subclause 3.22.1 of [5]: "A *class* represents a concept within the system being modelled. Classes have data structure and behaviour and relationships to other elements."
802
+
803
+ #### 5.2.13.1 Sample
804
+
805
+ This sample shows an AlarmList <<SupportIOC>>.
806
+
807
+ ![UML diagram showing a single SupportIOC element labeled AlarmList. Below the diagram is the caption '<<SupportIOC>> Notation'.](90ee16ccc0ad16aeca48087797d7b07f_img.jpg)
808
+
809
+ **<<SupportIOC>> Notation**
810
+
811
+ UML diagram showing a single SupportIOC element labeled AlarmList. Below the diagram is the caption '<> Notation'.
812
+
813
+ ## 5.3 Void
814
+
815
+ ## 5.4 Association classes
816
+
817
+ Subclause 3.46 of OMG: "Unified Modelling Language Specification defines an association class as
818
+
819
+ "An association class is an association that also has class properties (or a class that has association properties). Even though it is drawn as an association and a class, it is really just a single model element."
820
+
821
+ ## 5.4 Association classes
822
+
823
+ Subclause 3.46 of OMG: "Unified Modelling Language Specification, Version 1.51" [5]
824
+
825
+ <http://www.omg.org/technology/documents/formal/uml.html> defines an association class as
826
+
827
+ "An association class is an association that also has class properties (or a class that has association properties). Even though it is drawn as an association and a class, it is really just a single model element."
828
+
829
+ Association classes are appropriate for use when an «InformationObjectClass» needs to maintain associations to several other «InformationObjectClass»'s and there are relationships between the members of the associations within the scope of the "containing" «InformationObjectClass». For example, a namespace maintains a set of bindings, a binding ties a name to an object. A Binding «IOC» can be modelled as an Association Class that provides the binding semantics to the relationship between a name and some other «InformationObjectClass». This is depicted in the following figure (exemplary only, not taken from another 3GPP specification).
830
+
831
+ ![UML Class Diagram illustrating an Association Class. A Namespace (InformationObjectClass) has a composition relationship with a Binding (InformationObjectClass) class, indicated by a solid diamond and a multiplicity of 0..* at the Binding end. The Binding class is connected to a Name class (multiplicity 1) and an Object (InformationObjectClass) class (multiplicity 1) via a dashed association line, making it an association class for the Name-Object relationship.](40f30e4d577a17052f8b1e6dc802a0d8_img.jpg)
832
+
833
+ ```
834
+ classDiagram
835
+ class Namespace {
836
+ <<InformationObjectClass>>
837
+ }
838
+ class Binding {
839
+ <<InformationObjectClass>>
840
+ }
841
+ class Name
842
+ class Object {
843
+ <<InformationObjectClass>>
844
+ }
845
+ Namespace "1" *-- "0..*" Binding
846
+ Name "1" -- "1" Object
847
+ Binding -.-> Name
848
+ Binding -.-> Object
849
+ ```
850
+
851
+ UML Class Diagram illustrating an Association Class. A Namespace (InformationObjectClass) has a composition relationship with a Binding (InformationObjectClass) class, indicated by a solid diamond and a multiplicity of 0..\* at the Binding end. The Binding class is connected to a Name class (multiplicity 1) and an Object (InformationObjectClass) class (multiplicity 1) via a dashed association line, making it an association class for the Name-Object relationship.
852
+
853
+ **Example of an Association Class**
854
+
855
+ ## 5.5 Abstract Class
856
+
857
+ It specifies a <<InformationObjectClass>> as a base class to be inherited by subclasses. An abstract class can not be.
858
+
859
+ Abstract class notation is the use of italics in the class name of the corresponding <<InformationObjectClass>> in the diagram.
860
+
861
+ ### 5.5.1 Sample
862
+
863
+ This shows that ManagedGenericIRP is an abstract <<InformationObjectClass>>.
864
+
865
+ ![UML Class Diagram showing ManagedGenericIRP as an abstract class inherited by NotificationIRP.](1a85642ed2356d183ce598f2c8b3ee8b_img.jpg)
866
+
867
+ ```
868
+ classDiagram
869
+ class ManagedGenericIRP {
870
+ <<InformationObjectClass>>
871
+ ManagedGenericIRP
872
+ (from 32.312)
873
+ }
874
+ class NotificationIRP {
875
+ <<InformationObjectClass>>
876
+ NotificationIRP
877
+ (from 32.302)
878
+ }
879
+ ManagedGenericIRP <|-- NotificationIRP
880
+ ```
881
+
882
+ The diagram illustrates the inheritance relationship between two classes. At the top is the base class, **<<InformationObjectClass>> ManagedGenericIRP (from 32.312)**, which is an abstract class. At the bottom is the subclass, **<<InformationObjectClass>> NotificationIRP (from 32.302)**. A vertical inheritance arrow points from the subclass to the base class, indicating that NotificationIRP inherits from ManagedGenericIRP.
883
+
884
+ UML Class Diagram showing ManagedGenericIRP as an abstract class inherited by NotificationIRP.
885
+
886
+ **Abstract Class Notation**
887
+
888
+ # Annex A (informative): Samples of using <<ProxyClass>> to model Link related IOCs
889
+
890
+ ## A.1 First Sample
891
+
892
+ This shows a <<ProxyClass>> named YyyFunction. It represents all IOCs listed in the Note under the UML diagram. All the listed IOCs, in the context of this sample, inherit from ManagedFunction IOC.
893
+
894
+ The use of <<ProxyClass>> eliminates the need to draw multiple UML <<InformationObjectClass>> boxes, i.e. those whose names are listed in the Note, in the UML diagram.
895
+
896
+ ![UML Class Diagram showing ManagedFunction as an InformationObjectClass and YyyFunction as a ProxyClass inheriting from it.](73dff6b45b2b9ffd384bab3235f869af_img.jpg)
897
+
898
+ ```
899
+ classDiagram
900
+ class ManagedFunction {
901
+ <<InformationObjectClass>>
902
+ (from TS 32.622)
903
+ }
904
+ class YyyFunction {
905
+ <<ProxyClass>>
906
+ }
907
+ YyyFunction --|> ManagedFunction
908
+ ```
909
+
910
+ The diagram shows two classes. The top class is labeled <<InformationObjectClass>> ManagedFunction (from TS 32.622). The bottom class is labeled <<ProxyClass>> YyyFunction. A generalization arrow points from YyyFunction to ManagedFunction.
911
+
912
+ UML Class Diagram showing ManagedFunction as an InformationObjectClass and YyyFunction as a ProxyClass inheriting from it.
913
+
914
+ Note: The YyyFunction <<ProxyClass>> represents AsFunction, AucFunction, BgFunction, ...
915
+
916
+ **<<ProxyClass>> Notation Sample A.1**
917
+
918
+ ## A.2 Second Sample
919
+
920
+ This shows a <<ProxyClass>> named YyyFunction. It represents all IOCs listed in the Note right under the UML diagram. All the listed IOCs, in the context of this sample, have link (internal and external) relations.
921
+
922
+ The actual names of the IOC represented by InternalYyyFunction <<ProxyClass>> and by the ExternalYyyFunction <<ProxyClass>> are listed under the subsection of X.Y of the associated YyyFunction. For example, under X.Y.1 for AsFunction, two paragraphs are added to list all peer internal entities and external entities that are linked with AsFunction. See sample in quotation below that is using AsFunction as a sample for YyyFunction.
923
+
924
+ The actual names of the IOC represented by Link\_a\_z <<ProxyClass>> and by ExternalLink\_a\_z <<ProxyClass>> are listed under the subsection of X.Y of the associated YyyFunction. For example, under X.Y.1 for AsFunction, two paragraphs are added to list the names of the IOCs represented by Link\_a\_z and by ExternalLink\_a\_z. See the quoted text below that is using AsFunction as a sample for YyyFunction.
925
+
926
+
927
+
928
+ ### X.Y.1 AsFunction
929
+
930
+ #### X.Y.1.1 Definition
931
+
932
+ This IOC represents As functionality. For more information about the As, see 3GPP TS 23.002 [15].
933
+
934
+ The linked InternalYyyFunction <<ProxyClass>> represents SlsFunction, CsefFunction, HlrFunction ...
935
+
936
+ The linked ExternalYyyFunction <<ProxyClass>> represents ...
937
+
938
+ The Link\_a\_z <<ProxyClass>> represents Link\_As\_Scesf, Link\_Bgcf\_Scesf ...
939
+
940
+ The ExternalLink\_a\_z <<ProxyClass>> represents ...
941
+
942
+
943
+
944
+ ![UML Class Diagram showing relationships between proxy classes. A central class 'YyyFunction' is connected to 'InternalYyyFunction' on its left and 'ExternalYyyFunction' on its right. Above 'YyyFunction', two classes 'Link_a_z' and 'ExternalLink_a_z' are shown, each connected to 'YyyFunction' by a vertical line. All classes are represented by yellow boxes with three compartments, with the first compartment containing the <<ProxyClass>> stereotype and the class name.](f68a5f1f8845159744eff3e0e786731e_img.jpg)
945
+
946
+ ```
947
+
948
+ classDiagram
949
+ class Link_a_z {
950
+ <<ProxyClass>>
951
+ }
952
+ class ExternalLink_a_z {
953
+ <<ProxyClass>>
954
+ }
955
+ class InternalYyyFunction {
956
+ <<ProxyClass>>
957
+ }
958
+ class YyyFunction {
959
+ <<ProxyClass>>
960
+ }
961
+ class ExternalYyyFunction {
962
+ <<ProxyClass>>
963
+ }
964
+ Link_a_z -- YyyFunction
965
+ ExternalLink_a_z -- YyyFunction
966
+ InternalYyyFunction -- YyyFunction
967
+ ExternalYyyFunction -- YyyFunction
968
+
969
+ ```
970
+
971
+ UML Class Diagram showing relationships between proxy classes. A central class 'YyyFunction' is connected to 'InternalYyyFunction' on its left and 'ExternalYyyFunction' on its right. Above 'YyyFunction', two classes 'Link\_a\_z' and 'ExternalLink\_a\_z' are shown, each connected to 'YyyFunction' by a vertical line. All classes are represented by yellow boxes with three compartments, with the first compartment containing the <> stereotype and the class name.
972
+
973
+ NOTE: The 'Yyy' of YyyFunction <<ProxyClass>> represents AsFunction, AucFunction, ...
974
+
975
+ #### <<ProxyClass>> Notation Sample A.2
976
+
977
+ # Annex B (normative): Application of <<InformationObjectClass>> and <<SupportIOC>>
978
+
979
+ The <<InformationObjectClass>> and <<SupportIOC>> are stereotypes. These two stereotypes serve similar purpose in that each is a named set of network resource properties. However, their applications, in the context of supporting network management over Itf-N, can be different. This Annex highlights their similarities and differences of such application.
980
+
981
+ | | <<InformationObjectClass>> | <<SupportIOC>> |
982
+ |------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
983
+ | Can it be an abstract class? | Yes | Yes |
984
+ | Can it be a concrete class? | Yes | Yes |
985
+ | Can it inherit from <<InformationObjectClass>>? | Yes | No |
986
+ | Can it inherit from <<SupportIOC>>? | No | Yes |
987
+ | Can it be name-contained by <<InformationObjectClass>>? | Yes | Yes |
988
+ | Can it be name-contained by <<SupportIOC>>? | No | Yes |
989
+ | Can an instance have a DN? | <<InformationObjectClass>> must be a class of a naming-tree meaning all its instances must have a DN. | <<SupportIOC>> may be used by specification author for a class within a naming-tree. If so, it means that all its instances will have a DN. |
990
+ | Can IRPManager use operations of Basic CM IRP [6] and Bulk CM IRP [7] to access the information in an instance? | IRPManager can use the Basic CM IRP and Bulk CM IRP operations to access information of all <<InformationObjectClass>> defined in all NRM IRPs, in accordance to the qualifier values of the <<InformationObjectClass>>. | IRPManager can use the Basic CM IRP and Bulk CM IRP operations to access information of instances of <<SupportIOC>> defined in their respective Interface IRP, in accordance to the qualifier values of the <<SupportIOC>>. |
991
+ | Can IRPManager use operations of Interface IRP, except Basic CM IRP [6] and Bulk CM IRP [7] (e.g. Alarm IRP), to access the information? | No | IRPManager can use the Interface IRP operations to access information of <<SupportIOC>> defined in their respective Interface IRP, in accordance to qualifier values of the <<SupportIOC>>. |
992
+ | Can IRPManager receive information via Notification [8] whose objectClass and objectInstance parameters carry the instance DN? | Yes.<br>The types of notification emitted are shown by the Notification Table associated with the class definition. | Yes if <<SupportIOC>> is a class of a naming-tree.<br>The types of notification emitted are shown by the Notification Table associated with the class definition.<br><br>No if <<SupportIOC>> is not a class of a naming-tree. |
993
+ | Measurement [9] | Measurements can be associated with <<InformationObjectClass>> instances. | Measurements can be associated with <<SupportIOC>> instances if <<SupportIOC>> class is used in a naming-tree. |
994
+
995
+ # Annex C (informative): Change history
996
+
997
+ | Change history | | | | | | | | |
998
+ |----------------|-----------|---------------|----------|------|-------------------------------------------------------------------------------|-----|-----------|------------|
999
+ | Date | TSG # | TSG Doc. | CR | Re v | Subject/Comment | Cat | Old | New |
1000
+ | Dec 2003 | SA_2<br>2 | SP-<br>030615 | -- | -- | Submitted to TSG SA#22 for Information | -- | 1.0.<br>0 | |
1001
+ | Mar 2004 | SA_2<br>3 | SP-<br>040115 | -- | -- | Submitted to TSG SA#23 for Approval | -- | 2.0.<br>0 | 6.0.0 |
1002
+ | Oct 2006 | -- | -- | -- | -- | Corrected TS ver. and Rel #; added GSM logo in line with 41.101 | -- | 6.0.<br>0 | 6.0.1 |
1003
+ | Jun 2004 | SA_2<br>4 | SP-<br>040242 | 000<br>1 | -- | UML Repertoire Updates (Associations) | C | 6.0.<br>1 | 6.1.0 |
1004
+ | Mar 2005 | SA_2<br>7 | SP-<br>050023 | 000<br>2 | -- | Add "abstract" adornment | F | 6.1.<br>0 | 6.2.0 |
1005
+ | Jun 2005 | SA_2<br>8 | SP-<br>050284 | 000<br>3 | -- | Add the stereotype "Notification" to UML repertoire. Align with TS 32.412 | F | 6.2.<br>0 | 6.3.0 |
1006
+ | Jun 2005 | SA_2<br>8 | SP-<br>050284 | 000<br>4 | -- | Correction of stereotype name capitalization and visibility qualifiers | F | 6.2.<br>0 | 6.3.0 |
1007
+ | Dec 2005 | SA_3<br>0 | SP-<br>050729 | 000<br>5 | -- | Apply IS template - Align with 32.151 | F | 6.3.<br>0 | 7.0.0 |
1008
+ | Mar 2007 | SA_3<br>5 | SP-<br>070045 | 000<br>6 | -- | Add samples to illustrate the use of ProxyClass to model Link related objects | F | 7.0.<br>1 | 7.1.0 |
1009
+ | Mar 2007 | SA_3<br>5 | SP-<br>070045 | 000<br>7 | -- | Correct the references of IRPAgent and IRPManager | F | 7.0.<br>1 | 7.1.0 |
1010
+ | Mar 2007 | -- | -- | -- | -- | Deleted reference to CMIP SS, discontinued from R7 onwards | -- | 7.0.<br>1 | 7.1.0 |
1011
+ | Sep 2007 | SA_3<br>7 | SP-<br>070614 | 000<br>8 | -- | Modify usage of cardinality zero for IOC | C | 7.1.<br>0 | 8.0.0 |
1012
+ | Sep 2007 | SA_3<br>7 | SP-<br>070614 | 000<br>9 | -- | Remove visibility qualifier stereotype | C | 7.1.<br>0 | 8.0.0 |
1013
+ | Sep 2007 | SA_3<br>7 | SP-<br>070614 | 001<br>0 | -- | Add "agent internal usage" stereotype description | C | 7.1.<br>0 | 8.0.0 |
1014
+ | Sep 2009 | SA_4<br>5 | SP-<br>090627 | 001<br>1 | -- | Introduce SupportIOC Stereotype | F | 8.0.<br>0 | 9.0.0 |
1015
+ | Sep 2009 | SA_4<br>5 | SP-<br>090534 | 001<br>2 | -- | Align Repertoire with practice | F | 8.0.<br>0 | 9.0.0 |
1016
+ | Dec 2009 | SA_4<br>6 | SP-<br>090719 | 001<br>3 | -- | Add a new Annex B on Application of Stereotypes SupportIOC and IOC | F | 9.0.<br>0 | 9.1.0 |
1017
+ | Dec 2009 | SA_4<br>6 | SP-<br>090719 | 001<br>4 | -- | Clarify rules for <<names>> stereotype | F | 9.0.<br>0 | 9.1.0 |
1018
+ | Mar 2010 | SA_4<br>7 | SP-<br>100035 | 001<br>5 | -- | Clarify class support of notification re 32.152 | F | 9.1.<br>0 | 9.2.0 |
1019
+ | Sep 2010 | SA_4<br>9 | SP-<br>100489 | 001<br>6 | -- | Introduction of additional basic model element {xor} | F | 9.1.<br>0 | 10.0.<br>0 |
1020
+
1021
+ | Change history | | | | | | | |
1022
+ |----------------|---------|-----------|------|-----|-----|-----------------------------------------------------------|-------------|
1023
+ | Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version |
1024
+ | 2017-06 | SA#75 | SP-170509 | 0021 | 2 | F | Correcting the definition of the realization relationship | 10.1.0 |
marked/Rel-10/32_series/32153/raw.md ADDED
@@ -0,0 +1,1259 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+ # **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; Integration Reference Point (IRP) technology-specific templates, rules and guidelines (Release 10)**
4
+
5
+ ![LTE Advanced logo](935eed7aa61f7777f62cfc032e11bee9_img.jpg)
6
+
7
+ The logo for LTE Advanced, featuring the word "lte" in a bold, lowercase font with a red signal icon above the "l". The word "ADVANCED" is written in a smaller, uppercase font above the "e". A trademark symbol (TM) is located to the right of the "e".
8
+
9
+ LTE Advanced logo
10
+
11
+ ![3GPP logo](30a26f2d17ca95672702bf50fb4f0242_img.jpg)
12
+
13
+ The logo for 3GPP, featuring the letters "3GPP" in a stylized, bold font. The "3" and "G" are connected at the top, and the "P" and "P" are connected at the top. A red signal icon is located below the "G". A trademark symbol (TM) is located to the right of the "P". Below the logo, the text "A GLOBAL INITIATIVE" is written in a smaller, uppercase font.
14
+
15
+ 3GPP logo
16
+
17
+ Keywords
18
+ UMTS, management
19
+
20
+ # **3GPP**
21
+
22
+ Postal address
23
+
24
+ ---
25
+
26
+ 3GPP support office address
27
+
28
+ ---
29
+
30
+ 650 Route des Lucioles - Sophia Antipolis
31
+ Valbonne - FRANCE
32
+ Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
33
+
34
+ Internet
35
+
36
+ ---
37
+
38
+ <http://www.3gpp.org>
39
+
40
+ # ***Copyright Notification***
41
+
42
+ No part may be reproduced except as authorized by written permission.
43
+ The copyright and the foregoing restriction extend to reproduction in all media.
44
+
45
+ © 2016, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
46
+ All rights reserved.
47
+
48
+ UMTS™ is a Trade Mark of ETSI registered for the benefit of its members
49
+ 3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
50
+ LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
51
+ GSM® and the GSM logo are registered and owned by the GSM Association
52
+
53
+ # Contents
54
+
55
+ | | |
56
+ |-----------------------------------------------------------------------------------------------------|-----------|
57
+ | Foreword ..... | 5 |
58
+ | Introduction ..... | 5 |
59
+ | 1 Scope..... | 6 |
60
+ | 2 References..... | 6 |
61
+ | 3 Definitions and abbreviations ..... | 7 |
62
+ | 3.1 Definitions..... | 7 |
63
+ | 3.2 Abbreviations ..... | 7 |
64
+ | 4 Interface IRP SS template..... | 8 |
65
+ | 5 NRM IRP SS template ..... | 14 |
66
+ | <b>Annex A (normative): General rules for Solution Sets (SS) .....</b> | <b>16</b> |
67
+ | A.1 Introduction..... | 16 |
68
+ | A.2 Solution Set (SS) versioning..... | 16 |
69
+ | A.3 Referenced Information Service (IS) specification..... | 16 |
70
+ | <b>Annex B (normative): Technology specific rules &amp; guidelines for CORBA Solution Sets.....</b> | <b>17</b> |
71
+ | B.1 Rules..... | 17 |
72
+ | B.1.1 Introduction ..... | 17 |
73
+ | B.1.2 Rules for specification of CORBA Solution Sets ..... | 17 |
74
+ | B.1.2.1 Introduction ..... | 17 |
75
+ | B.1.2.2 Pragma prefix ..... | 17 |
76
+ | B.1.3 Implementation aspects of Interface IRP CORBA Solution Sets ..... | 17 |
77
+ | B.1.3.1 Introduction ..... | 17 |
78
+ | B.1.3.2 IRP Agent behaviour on incoming optional method..... | 18 |
79
+ | B.1.3.3 IRP Agent behaviour on incoming optional parameter of operation..... | 18 |
80
+ | B.1.3.4 IRP Agent behaviour on outgoing attributes of notification ..... | 18 |
81
+ | B.1.3.5 Encoding rule of absence semantics..... | 18 |
82
+ | B.1.4 Rules for NRM IRP CORBA SS extensions..... | 19 |
83
+ | B.1.4.1 Allowed extensions..... | 19 |
84
+ | B.1.4.2 Extensions not allowed ..... | 19 |
85
+ | B.2 Guidelines (Style Guide for CORBA SS IDL) ..... | 20 |
86
+ | B.2.1 Modules and File..... | 20 |
87
+ | B.2.1.1 Use of Modules..... | 20 |
88
+ | B.2.1.2 File Names..... | 20 |
89
+ | B.2.1.3 Include Conventions..... | 20 |
90
+ | B.2.1.4 File Structure ..... | 21 |
91
+ | B.2.1.4.1 File Internal Identification ..... | 21 |
92
+ | B.2.1.4.2 File Guard ..... | 21 |
93
+ | B.2.1.4.3 Required Contents..... | 21 |
94
+ | B.2.1.4.4 Example illustrating a File Structure ..... | 21 |
95
+ | B.2.2 Identifiers ..... | 22 |
96
+ | B.2.2.1 Mixed Case, Beginning Upper, No Underscores ..... | 22 |
97
+ | B.2.2.2 Lower Case with Underscores..... | 22 |
98
+ | B.2.2.3 Upper Case with Underscores ..... | 23 |
99
+ | B.2.2.4 Naming IDL Sequence Types ..... | 23 |
100
+ | B.2.3 Interface IRP ..... | 24 |
101
+ | B.2.3.1 Constant String and Type Definitions ..... | 24 |
102
+ | B.2.3.2 Operations..... | 25 |
103
+ | B.2.3.3 Notifications ..... | 25 |
104
+ | B.2.4 NRM IRP..... | 27 |
105
+ | <b>Annex C (normative): Technology specific rules &amp; guidelines for SOAP SSs.....</b> | <b>28</b> |
106
+
107
+ | | | |
108
+ |-------------------------------|--------------------------------------------------------------------------------|-----------|
109
+ | C.1 | Rules..... | 28 |
110
+ | C.1.1 | Introduction ..... | 28 |
111
+ | C.1.2 | Rules for specification of SOAP Solution Sets ..... | 28 |
112
+ | C.1.2.1 | Introduction..... | 28 |
113
+ | C.1.2.2 | File names ..... | 28 |
114
+ | C.1.2.3 | Void ..... | 28 |
115
+ | C.1.2.4 | XML version encoding ..... | 28 |
116
+ | C.1.2.5 | Namespaces ..... | 29 |
117
+ | C.1.3 | Implementation aspects of Interface IRP SOAP Solution Sets ..... | 29 |
118
+ | C.1.3.1 | Introduction..... | 29 |
119
+ | C.1.3.n | XXXX rule..... | 29 |
120
+ | C.2 | Guidelines (Style Guide for SOAP SS WSDL) ..... | 29 |
121
+ | C.2.1 | File structure ..... | 29 |
122
+ | C.2.1.1 | Definitions ..... | 29 |
123
+ | C.2.1.2 | Namespaces ..... | 29 |
124
+ | C.2.1.3 | Documentation..... | 29 |
125
+ | C.2.1.4 | Types..... | 29 |
126
+ | C.2.1.5 | Message ..... | 30 |
127
+ | C.2.1.6 | Port type..... | 30 |
128
+ | C.2.1.7 | Binding..... | 30 |
129
+ | C.2.1.8 | Port..... | 30 |
130
+ | C.2.1.9 | Service ..... | 30 |
131
+ | C.2.2 | Identifiers..... | 30 |
132
+ | C.2.2.n | Rule n ..... | 30 |
133
+ | C.3 | XML Schema Guidelines ..... | 30 |
134
+ | C.3.1 | XSD guidelines for messages definition ..... | 30 |
135
+ | C.3.1.1 | Request message ..... | 30 |
136
+ | C.3.1.2 | Response messages ..... | 30 |
137
+ | C.3.1.3 | Fault messages ..... | 30 |
138
+ | C.3.2 | XSD guidelines for parameters definition..... | 30 |
139
+ | C.3.1.1 | General guidelines ..... | 30 |
140
+ | C.3.1.1 | Simple type definitions ..... | 30 |
141
+ | C.3.1.2 | Complex type definition ..... | 31 |
142
+ | C.3.3 | Identifiers..... | 31 |
143
+ | <b>Annex D (normative):</b> | <b>Technology specific rules &amp; guidelines for XML specifications .....</b> | <b>32</b> |
144
+ | D.1 | Rules..... | 32 |
145
+ | D.1.1 | XSD Use Cases ..... | 32 |
146
+ | D.1.1.1 | Background..... | 32 |
147
+ | D.1.1.2 | Use Cases Set 1 ..... | 32 |
148
+ | D.1.1.3 | Use Cases Set 2..... | 33 |
149
+ | D.1.2 | Rules for NRM IRP XML specification extensions..... | 33 |
150
+ | D.1.3 | XML version encoding..... | 33 |
151
+ | D.2 | Guidelines ..... | 34 |
152
+ | <b>Annex E (informative):</b> | <b>Change history.....</b> | <b>35</b> |
153
+
154
+ # --- Foreword
155
+
156
+ This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP).
157
+
158
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
159
+
160
+ Version x.y.z
161
+
162
+ where:
163
+
164
+ - x the first digit:
165
+ - 1 presented to TSG for information;
166
+ - 2 presented to TSG for approval;
167
+ - 3 or greater indicates TSG approved document under change control.
168
+ - y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
169
+ - z the third digit is incremented when editorial only changes have been incorporated in the document.
170
+
171
+ ## --- Introduction
172
+
173
+ The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below:
174
+
175
+ - TS 32.150 "Integration Reference Point (IRP) Concept and definitions"
176
+ - TS 32.151 "Integration Reference Point (IRP) Information Service (IS) template"
177
+ - TS 32.152 "Integration Reference Point (IRP) Information Service (IS) Unified Modelling Language (UML) repertoire"
178
+ - TS 32.153 "Integration Reference Point (IRP) technology specific templates, rules and guidelines"**
179
+ - TS 32.154 "Backward and Forward Compatibility (BFC); Concept and definitions"
180
+ - TS 32.155 "Requirements template".
181
+
182
+ ## --- 1 Scope
183
+
184
+ The present document contains the templates to be used for the production of Integration Reference Point (IRP) technology-specific specifications.
185
+
186
+ # --- 2 References
187
+
188
+ The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
189
+
190
+ - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
191
+ - For a specific reference, subsequent revisions do not apply.
192
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
193
+
194
+ - [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements".
195
+ - [2] 3GPP TS 32.102: "Telecommunication management; Architecture".
196
+ - [3] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions".
197
+ - [4] Void.
198
+ - [5] Void.
199
+ - [6] 3GPP TS 32.111-2: "Telecommunication management; Fault Management; Part 2: Alarm Integration Reference Point (IRP): Information Service (IS)".
200
+ - [7] Void.
201
+ - [8] W3C SOAP 1.2 specification (<http://www.w3.org/TR/soap12-part1/>).
202
+ - [9] OMG IDL Style Guide, ab/98-06-03, June 17, 1998.
203
+ - [10] W3C WSDL 1.1 specification (<http://www.w3.org/TR/wsdl>) .
204
+ - [11] Void.
205
+ - [12] Void.
206
+ - [13] Void.
207
+ - [14] Void.
208
+ - [15] W3C XML Specifications (<http://www.w3.org/XML/Core/>).
209
+ - [16] IETF RFC 3629 (<http://tools.ietf.org/html/rfc3629#ref-UNICODE>).
210
+ - [17] 3GPP TS 32.642: "Telecommunication management; Universal Terrestrial Radio Access Network (UTRAN) Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)".
211
+
212
+ ## --- 3 Definitions and abbreviations
213
+
214
+ ### 3.1 Definitions
215
+
216
+ For the purposes of the present document, the terms and definitions given in 3GPP TS 32.101 [1], 3GPP TS 32.102 [2], 3GPP TS 32.150 [3] and the following apply:
217
+
218
+ **IRP Agent:** See 3GPP TS 32.150 [3].
219
+
220
+ **IRP Manager:** See 3GPP TS 32.150 [3].
221
+
222
+ **SOAP:** See [8].
223
+
224
+ ### 3.2 Abbreviations
225
+
226
+ For the purposes of the present document, the abbreviations given in 3GPP TS 32.101 [1], 3GPP TS 32.102 [2], 3GPP TS 32.150 [3] and the following apply:
227
+
228
+ | | |
229
+ |-------|-------------------------------------------------|
230
+ | CM | Conditional Mandatory |
231
+ | CM | Configuration Management |
232
+ | CO | Conditional Optional |
233
+ | CORBA | Common Object Request Broker Architecture (OMG) |
234
+ | FF | File Format |
235
+ | IDL | Interface Definition Language |
236
+ | IOC | Information Object Class |
237
+ | IOC | Information Object Class |
238
+ | IRP | Integration Reference Point |
239
+ | IS | Information Service |
240
+ | M | Mandatory |
241
+ | MO | Managed Object |
242
+ | MOC | Managed Object Class |
243
+ | NRM | Network Resource Model |
244
+ | O | Optional |
245
+ | OMG | Object Management Group |
246
+ | TS | Technical Specification |
247
+ | SOAP | W3C acronym |
248
+ | SS | Solution Set |
249
+ | SuM | Subscription Management |
250
+ | UML | Unified Modelling Language (OMG) |
251
+ | URI | Uniform Resource Identifier |
252
+ | WSDL | Web Service Description Language |
253
+ | XML | eXtensible Markup Language |
254
+ | XSD | XML Schema Definition |
255
+
256
+ # --- 4 Interface IRP SS template
257
+
258
+ This clause contains the Interface IRP SS template.
259
+
260
+ The clauses in this template (that shall be used in the SS specifications) are numbered starting with "X", which in general should correspond to clause 4 that is the beginning of the normative part of a TS. However, if there is a need in a specific SS to introduce additional clauses in the TS body, X may correspond to a number higher than 4.
261
+
262
+ The SS templates use qualifiers M, O, CM and CO. The semantics of these qualifiers are defined in TS 32.150 [3].
263
+
264
+ The introductory clauses (from clause 1 to clause 3) for the SS should be modelled similarly to that of clause 1 to 3 of this specification.
265
+
266
+ Instructions are written in *italics*.
267
+
268
+ Usage of fonts shall be according to the following table.
269
+
270
+ **Table: Usage of fonts**
271
+
272
+ | Item | Font |
273
+ |--------------------|-------------|
274
+ | Class names | Courier New |
275
+ | Attribute names | Courier New |
276
+ | Operation names | Courier New |
277
+ | Parameter names | Courier New |
278
+ | Assertion names | Courier New |
279
+ | Notification names | Courier New |
280
+ | Exception names | Courier New |
281
+ | State names | Arial |
282
+ | Enumerated values | Arial |
283
+
284
+ ## X Architectural Features
285
+
286
+ *"X" represents a clause number in the actual SS. It contains at least the following this subclause:*
287
+
288
+ ### X.1 General
289
+
290
+ *This subclause contains the following paragraph:*
291
+
292
+ "The overall architectural feature of <subject IRP> is specified in 3GPP TS <relevant specification number> [<relevant reference>]. This clause specifies features that are specific to the <specific technology> SS."
293
+
294
+ *Example:*
295
+
296
+ "The overall architectural feature of Alarm IRP is specified in 3GPP TS 32.111-2 [6]. This clause specifies features that are specific to the CORBA SS."
297
+
298
+ *Specific for SOAP SS: the supported XSD, WSDL and SOAP versions shall be indicated together with the style and encoding style, and the namespaces with corresponding prefixes used in the WSDL specifications. Therefore the SOAP SS also contains the information quoted below:*
299
+
300
+ "The SOAP <supported version> specification [relevant reference], XSD <supported version> specification [relevant reference] and WSDL <supported version> specification [relevant reference] are supported.
301
+
302
+ This specification uses "<RPC/Document>" style in WSDL file.
303
+
304
+ This specification uses "<Literal/Encoded>" encoding style in WSDL file.
305
+
306
+ This specification uses a number of namespace prefixes which are listed in Table X.1.
307
+
308
+ | Prefix | Namespace |
309
+ |-----------------------|---------------------------------------------------------------------------------------------------|
310
+ | http | <a href="http://schemas.xmlsoap.org/wsdl/http/">http://schemas.xmlsoap.org/wsdl/http/</a> |
311
+ | soap | <a href="http://schemas.xmlsoap.org/wsdl/soap/">http://schemas.xmlsoap.org/wsdl/soap/</a> |
312
+ | xs or xsd | <a href="http://www.w3.org/2001/XMLSchema">http://www.w3.org/2001/XMLSchema</a> |
313
+ | xsi | <a href="http://www.w3.org/2001/XMLSchema-instance">http://www.w3.org/2001/XMLSchema-instance</a> |
314
+ | <IRP specific prefix> | <Namespace's URI> |
315
+
316
+ **Table X.1: Prefixes and Namespaces used in this specification**
317
+
318
+
319
+
320
+ ### X.a <Feature [a-1]>
321
+
322
+ *<Description of architectural feature "a">*
323
+
324
+ *"a" represents a number, starting at 2 and increasing by 1 with each new feature.*
325
+
326
+ *NOTE: This subclause is optional.*
327
+
328
+ ## Y Mapping
329
+
330
+ *"Y" represents a clause number, immediately following "X".*
331
+
332
+ ### Y.1 Operation and Notification mapping
333
+
334
+ *It contains this leading paragraph:*
335
+
336
+ "The <subject IRP>: IS (see 3GPP TS <relevant specification number> [<relevant reference number>]) defines semantics of operation and notification visible across the Itf-N. Table Y.1.1 indicates mapping of these operations and notifications to their equivalents defined in this SS."
337
+
338
+ *Example:*
339
+
340
+ "Alarm IRP: IS 3GPP TS 32.111-2 [6] defines semantics of operation and notification visible across the Itf-N. Table Y.1.1 indicates mapping of these operations and notifications to their equivalents defined in this SS."
341
+
342
+ *The table includes all operations and notifications, including those inherited. The table lists the operations first and then the notifications. The list order is the same as the one used in the IS. Semantics for the Qualifier is defined in Ref [x].*
343
+
344
+ **Table Y.1.1: Mapping from IS Operation/Notification to SS equivalents**
345
+
346
+ | IS Operation/Notification<br>in 3GPP TS <relevant TS number > [<relevant reference number>] | SS Method | Qualifier |
347
+ |---------------------------------------------------------------------------------------------|-----------|----------------|
348
+ | <operation1> | <method1> | M, O, CM or CO |
349
+ | <operation2> | <method2> | M, O, CM or CO |
350
+ | ... | | |
351
+ | .. | | |
352
+ | notify<notification1> | <notify1> | M, O, CM or CO |
353
+ | ... | ... | |
354
+
355
+ ### Y.2 Operation parameter mapping
356
+
357
+ *It contains this leading paragraph:*
358
+
359
+ "Reference 3GPP TS <relevant version> [<relevant reference number>] defines semantics of parameters carried in operations across the Itf-N. The following set of tables indicate the mapping of these parameters, as per operation, to their equivalents defined in this SS."
360
+
361
+ *Example:*
362
+
363
+ "Reference 3GPP TS 32.111-2 [6] defines semantics of parameters carried in operations across the Itf-N. The following set of tables indicate the mapping of these parameters, as per operation, to their equivalents defined in this SS."
364
+
365
+ **Table Y.2.1: Mapping from IS <operation1> parameters to SS equivalents**
366
+
367
+ | IS Operation parameter | SS Method parameter | Qualifier |
368
+ |------------------------|--------------------------------|----------------|
369
+ | <parameter-1> | <type definition> <parameter1> | M, O, CM or CO |
370
+ | <parameter-2> | <type definition> <parameter2> | M, O, CM or CO |
371
+ | ... | ... | ... |
372
+ | ... | ... | ... |
373
+ | status | ... | M |
374
+
375
+ **Table Y.2.2: Mapping from IS <operation2> parameters to SS equivalents**
376
+
377
+ | IS Operation parameter | SS Method parameter | Qualifier |
378
+ |------------------------|--------------------------------|----------------|
379
+ | <parameter-1> | <type definition> <parameter1> | M, O, CM or CO |
380
+ | ... | ... | ... |
381
+ | status | ... | M |
382
+
383
+ **Table Y.2.x:**
384
+
385
+ | IS Operation parameter | SS Method parameter | Qualifier |
386
+ |------------------------|---------------------|-----------|
387
+ | ... | ... | ... |
388
+ | ... | ... | ... |
389
+ | status | ... | M |
390
+
391
+ ### Y.3 Notification parameter mapping
392
+
393
+ *It contains this leading paragraph:*
394
+
395
+ "Reference 3GPP TS <relevant version number> [<relevant referenced number>] defines semantics of parameters carried in notifications. The following tables indicate the mapping of these parameters to their SS equivalents."
396
+
397
+ *Specific for CORBA SS: CORBA SS uses OMG CORBA Structured Event to carry IS-defined notification parameters. The Structured Event has the OMG defined parameters. These parameters will be related to the SS equivalents. So, the SS contains this paragraph.*
398
+
399
+ "
400
+
401
+ The following tables indicate the mapping of these parameters to their OMG CORBA Structured Event (defined in OMG Notification Service [<relevant reference number>]) equivalents. The composition of OMG Structured Event, as defined in the OMG Notification Service [<relevant reference number>], is:
402
+
403
+ Header
404
+
405
+ - Fixed Header
406
+ - domain\_name
407
+ - type\_name
408
+ - event\_name
409
+ - Variable Header
410
+
411
+ Body
412
+
413
+ - filterable\_body\_fields
414
+ - remaining\_body
415
+
416
+ The following tables list all OMG Structured Event attributes in the second column. The first column identifies the <subject> IRP: IS [<relevant reference number>] defined notification parameters.
417
+
418
+ "
419
+
420
+ Table Y.3.1: Mapping for **notifyKkk**
421
+
422
+ | IS Parameters | <SS> Parameters | Qualifier | Comment |
423
+ |---------------|-----------------|-----------|---------|
424
+ | <parameter-1> | <parameter-A> | M or O | ... |
425
+ | <parameter-2> | <parameter-B> | M or O | ... |
426
+ | ... | ... | M or O | ... |
427
+
428
+ ## Z Notification Interface
429
+
430
+ "Z" represents a number, immediately following "Y".
431
+
432
+ This sub-clause captures SS technology specific details required to realize the IS-defined <interface> for notifications.
433
+
434
+ Specific for CORBA SS:
435
+
436
+ The SS contains this:
437
+
438
+ "
439
+
440
+ OMG CORBA Notification push operation is used to realise the notification of AlarmIRPNotifications. All the notifications in this interface are implemented using this `push_structured_event` method.
441
+
442
+ ### <Z>.1 Method push (M)
443
+
444
+ ```
445
+ module CosNotifyComm {
446
+ ...
447
+ Interface SequencePushConsumer : NotifyPublish {
448
+ void push_structured_events(
449
+ in CosNotification::EventBatch notifications)
450
+ raises( CosEventComm::Disconnected);
451
+ ...
452
+ }; // SequencePushConsumer
453
+ ...
454
+ }; // CosNotifyComm
455
+ ```
456
+
457
+ NOTE 1: The `push_structured_events` method takes an input parameter of type `EventBatch` as defined in the OMG `CosNotification` module (OMG Notification Service [1]). This data type is the same as a sequence of Structured Events. Upon invocation, this parameter will contain a sequence of Structured Events being delivered to IRPManager by IRPAgent to which it is connected.
458
+
459
+ NOTE 2: The maximum number of events that will be transmitted within a single invocation of this operation is controlled by IRPAgent wide configuration parameter.
460
+
461
+ NOTE 3: The amount of time the supplier (IRPAgent) of a sequence of Structured Events will accumulate individual events into the sequence before invoking this operation is controlled by IRPAgent wide configuration parameter as well.
462
+
463
+ NOTE 4: IRPAgent may push `EventBatch` with only one Structured Event.
464
+
465
+ "
466
+
467
+ # 5 NRM IRP SS template
468
+
469
+ This clause contains the NRM IRP SS template.
470
+
471
+ The clauses in this template (that shall be used in the SS specifications) are numbered starting with "X", which in general should correspond to clause 4 that is the beginning of the normative part of a TS. However, if there is a need in a specific SS to introduce additional clauses in the TS body, X may correspond to a number higher than 4.
472
+
473
+ The introductory clauses (from clause 1 to clause 3) for the SS should be modelled similarly to that of this specification.
474
+
475
+ Usage of fonts shall be according to the following table.
476
+
477
+ **Table: Usage of fonts**
478
+
479
+ | Item | Font |
480
+ |--------------------|-------------|
481
+ | Class names | Courier New |
482
+ | Attribute names | Courier New |
483
+ | Assertion names | Courier New |
484
+ | Notification names | Courier New |
485
+ | State names | Arial |
486
+ | Enumerated values | Arial |
487
+
488
+ ## X Architectural Features
489
+
490
+ *"X" represents a clause number in the actual SS. It contains at least the following subclause:*
491
+
492
+ ### X.1 General
493
+
494
+ *This subclause contains the following paragraph:*
495
+
496
+ "The overall architectural feature of <subject IRP> is specified in 3GPP TS <relevant specification number> [<relevant reference>]. This clause specifies features that are specific to the <specific technology> SS."
497
+
498
+ *Example:*
499
+
500
+ "The overall architectural feature of UTRAN Network Resources IRP is specified in 3GPP TS 32.642 [17]. This clause specifies features that are specific to the CORBA SS."
501
+
502
+ ### X.a <Feature [a-1]>
503
+
504
+ *<Description of architectural feature "a">*
505
+
506
+ *"a" represents a number, starting at 2 and increasing by 1 with each new feature.*
507
+
508
+ *NOTE: This subclause is optional.*
509
+
510
+ ## Y Mapping
511
+
512
+ *"Y" represents a number, immediately following "X".*
513
+
514
+ ### Y.1 General
515
+
516
+ *This subclause contains a general introduction to the mapping.*
517
+
518
+ *For CORBA SSs, it contains the following paragraph:*
519
+
520
+ "Attributes modelling associations as defined in the NRM (here also called "reference attributes") are in this SS mapped to attributes. The names of the reference attributes in the NRM are mapped to the corresponding attribute names in the MOC. When the cardinality for an association is 0..1 or 1..1 the datatype for the reference attribute is defined as an MOReference. The value of an MO reference contains the distinguished name of the associated MO. When the cardinality for an association allows more than one referred MO, the reference attribute will be of type MOReferenceSet, which contains a sequence of MO references."
521
+
522
+ *For XML FF specifications, it contains the following paragraph:*
523
+
524
+ "An IOC maps to an XML element of the same name as the IOC's name in the IS. An IOC attribute maps to a sub-element of the corresponding IOC's XML element, and the name of this sub-element is the same as the attribute's name in the IS."
525
+
526
+ ### Y.2 Information Object Class (IOC) mapping
527
+
528
+ *This subclause is only applicable to NRM IRP CORBA Solution Sets. This clause contains the mapping tables of all iS-defined IOCs to corresponding SS-level MOCs, excluding those inherited.*
529
+
530
+ #### Y.2.a IOC <IOC name >
531
+
532
+ *It contains one table with Mapping from NRM IS IOC attribute name to the SS equivalent MOC attribute name and attribute types.*
533
+
534
+ *"a" in the subclause heading represents a number, starting at 1 and increasing by 1 for each IOC.*
535
+
536
+ | Attribute of IOC <IOC name > in<br>3GPP TS <relevant TS number> [<relevant<br>reference number>] | SS<br>Attribute | SS<br>Type | Support<br>Qualifier | Read<br>Qualifier | Write<br>Qualifier |
537
+ |--------------------------------------------------------------------------------------------------|-----------------|------------|----------------------|-------------------|--------------------|
538
+ | attribute-a | attribute-1 | <type> | ... | ... | ... |
539
+ | attribute-b | attribute-2 | <type> | ... | ... | ... |
540
+ | ... | ... | ... | ... | ... | ... |
541
+
542
+ ### Y.2 Information Object Class (IOC) mapping
543
+
544
+ *This subclause is only applicable to NRM IRP XML FF specifications. This subclause describes the mapping of all IS-defined IOCs to corresponding XML definitions, excluding the inherited IOCs.*
545
+
546
+ *Note: This subclause is also numbered Y.2, directly following Y.1, since every NRM SS-level TS is made for only one SS technology.*
547
+
548
+ # --- Annex A (normative): General rules for Solution Sets (SS)
549
+
550
+ ## A.1 Introduction
551
+
552
+ The intent of this annex is twofold.
553
+
554
+ The first intent is for 3GPP-internal use to document how a 3GPP Solution Set is (SS) produced and what it shall contain.
555
+
556
+ The second intent is to give the reader of an Information Service (IS) or a Solution Set (SS) a better understanding on how to interpret the IS or SS specifications.
557
+
558
+ ## --- A.2 Solution Set (SS) versioning
559
+
560
+ *Editor's note: For Further Study.*
561
+
562
+ ## --- A.3 Referenced Information Service (IS) specification
563
+
564
+ A sentence shall be included in the clause "Scope" of all SS specifications. The sentence shall read as follows:
565
+
566
+ "This Solution Set specification is related to Z".
567
+
568
+ where Z is the 3GPP Information Service (IS) specification number including the version, such as "TS 32.111-2 V4.1.X" for the case of Alarm Integration Reference Point (IRP): Information Service (IS).
569
+
570
+ NOTE: that "X", rather than the actual digit, is actually used in the sentence. This is because the value of X is not relevant for the reference purpose since different values of X identify different 3GPP published specifications that reflect only editorial changes.
571
+
572
+ # --- Annex B (normative): Technology specific rules & guidelines for CORBA Solution Sets
573
+
574
+ ## B.1 Rules
575
+
576
+ ### B.1.1 Introduction
577
+
578
+ The intent of this annex is threefold.
579
+
580
+ - 1) The first intent is for 3GPP internal use to document how a 3GPP CORBA SS is produced and how it is structured.
581
+ - 2) The second intent with the annex is to give the reader or implementer of a CORBA SS a better understanding on how to interpret the CORBA SS specification.
582
+ - 3) The third and maybe most important intent is to put requirement on an implementer of a CORBA SS.
583
+
584
+ It is expected that this annex is to be extended in later versions of the present document.
585
+
586
+ ### B.1.2 Rules for specification of CORBA Solution Sets
587
+
588
+ #### B.1.2.1 Introduction
589
+
590
+ This subclause identifies rules for specification of CORBA SSs. This subclause is mainly for 3GPP-internal use. It is only for information for the implementer of a CORBA SS.
591
+
592
+ #### B.1.2.2 Pragma prefix
593
+
594
+ All IDL-code shall define the pragma prefix using the following statement:
595
+
596
+ ```
597
+ #pragma prefix "3gppsa5.org"
598
+ ```
599
+
600
+ See clause B.2.1.4.3 for information of this `#pragma` statement in relation to other IDL statements.
601
+
602
+ ### B.1.3 Implementation aspects of Interface IRP CORBA Solution Sets
603
+
604
+ #### B.1.3.1 Introduction
605
+
606
+ This subclause identifies rules for the implementation of CORBA SSs. This subclause is normative for the implementer of a CORBA SS.
607
+
608
+ #### B.1.3.2 IRP Agent behaviour on incoming optional method
609
+
610
+ The IRP Agent, claiming compliance to a particular SS version of a particular IRP such as the Alarm IRP, shall implement all Mandatory and all Optional methods. Each method implementation shall have a signature specifying all Mandatory and all Optional parameters.
611
+
612
+ - If the IRP Agent does not support a particular optional method, it shall throw the `OperationNotSupportedException` when the IRP Manager invokes that method.
613
+ - If the IRP Agent have not implemented a particular method (because it is compiled with an IDL version that does not define the method), the CORBA ORB of the IRP Agent shall throw a system exception if the IRP Manager invokes that method.
614
+
615
+ In all the above cases when an exception is thrown, the IRP Agent shall restore its state before the method invocation.
616
+
617
+ #### B.1.3.3 IRP Agent behaviour on incoming optional parameter of operation
618
+
619
+ An IRP Agent must implement all optional parameters, as well as mandatory parameters, in all methods.
620
+
621
+ If the IRP Agent supports the implemented method but does not support its (one or more) optional input parameters, upon method invocation, the IRP Agent shall check if those parameters carry "no information" or absence semantics (defined later in subclause B.1.3.5). If the check is negative, the IRP Agent shall throw the `ParameterNotSupportedException` exception with a string carrying the name of the unsupported optional parameter.
622
+
623
+ #### B.1.3.4 IRP Agent behaviour on outgoing attributes of notification
624
+
625
+ CORBA SS uses OMG defined structured event to carry notification. The structured event is partitioned into header and body.
626
+
627
+ The absence semantics of attribute in the header is realized by a string of zero length.
628
+
629
+ The body consists of one or more name-value pair attributes. The absence semantics of these attributes is realized by their absence.
630
+
631
+ For optional sub-attributes of an attribute carried by the name-value pair, their absence semantics is realized by the encoding rule of "absence semantics". See subclause B.1.3.5.
632
+
633
+ #### B.1.3.5 Encoding rule of absence semantics
634
+
635
+ The operation parameters are mapped to method parameters of CORBA SS. The absence semantics for an operation (input and output) parameter is method parameter type dependent.
636
+
637
+ - For a string type, if the parameter is specified as a string type, the absence semantics is a string of zero length. If the parameter is specified as a union structure (preferred), the absence semantics is conveyed via a `FALSE` Boolean value switch.
638
+ - For an integer type, if the parameter is specified as a signed, unsigned, long, etc type, the absence semantics is the highest possible positive number. If the parameter is specified as a union structure (preferred), the absence semantics is conveyed via a `FALSE` Boolean value switch.
639
+ - For a boxed `valueType` (supported by CORBA 2.3), it is the null value.
640
+
641
+ The notification parameters are mapped to attributes of the CORBA Structured Events. The absence semantics for a notification parameter is attribute position (within the Structured Event) dependent.
642
+
643
+ - For the fixed header of the Structured Event header, the absence semantics is realized by a string of zero length.
644
+ - For the filterable body fields of the Structured Event body, the absence semantics is realized by the absence of the corresponding attribute.
645
+
646
+ ### B.1.4 Rules for NRM IRP CORBA SS extensions
647
+
648
+ This clause discusses how the models and IDL definitions provided in a particular NRM IRP CORBA SS can be extended for a particular implementation and still remain compliant with IRP specifications.
649
+
650
+ Note: Protocol-neutral rules for NRM IRP IS-level extensions are defined in TS 32.150 [3] Annex G.
651
+
652
+ #### B.1.4.1 Allowed extensions
653
+
654
+ Vendor-specific MOCs may be supported. The vendor-specific MOCs may support new types of attributes. The standardised notifications may be issued referring to the vendor-specific MOCs and vendor-specific attributes. New MOCs shall be distinguishable from standardised MOCs by name. Standardised and vendor-specific attributes may be used in vendor-specific MOCs. Vendor-specific attribute names shall be distinguishable from existing attribute names.
655
+
656
+ MOCs may be subclassed. Subclassed MOCs shall maintain the specified behaviour of the superior classes. They may add vendor-specific behaviour with vendor-specific attributes. When subclassing, naming attributes cannot be changed. The subclassed MOC shall support all attributes of its superior class. Vendor-specific attributes cannot be added to MOCs without subclassing.
657
+
658
+ When subclassing, the standardised containment rules and their specified cardinality shall still be followed. As an example, ManagementNode (or its subclasses) shall be contained under SubNetwork (or its subclasses).
659
+
660
+ Managed Object Instances may be instantiated as CORBA objects. This requires that the MOCs be represented in IDL. MOCs are not currently specified in IDL, but may be specified in IDL for instantiation or subclassing purposes. However, management information models should not require that IRPManagers access the instantiated managed objects other than through supported methods in the present document.
661
+
662
+ Extension rules related to notifications (Notification categories, Event Types, Extended Event Types etc.) are for further study.
663
+
664
+ #### B.1.4.2 Extensions not allowed
665
+
666
+ The IDL specifications in the present document cannot be edited or altered. Any additional IDL specifications shall be specified in separate IDL files.
667
+
668
+ IDL interfaces (note: not MOCs) specified in the present document may not be subclassed or extended. New interfaces may be defined with vendor-specific methods.
669
+
670
+ ## --- B.2 Guidelines (Style Guide for CORBA SS IDL)
671
+
672
+ This subclause describes the style guide for writing IDL statements for Interface IRP and NRM IRP. The guidelines are largely based on the OMG IDL Style Guide (OMG document: ab/98-06-03) [9] with extensions for IRP use.
673
+
674
+ The guide sets out consistent naming, structural conventions and usage of SS interface for the IDL in IRP CORBA SS specifications.
675
+
676
+ ### B.2.1 Modules and File
677
+
678
+ #### B.2.1.1 Use of Modules
679
+
680
+ All declarations of IDL shall be contained in modules. No declarations of interfaces and definitions shall appear in the global scope.
681
+
682
+ Nesting modules is a useful technique when dealing with large namespaces to avoid name clashes and clarify relationships. A module nested within another module shall not have the same name as a top-level module in any other IRP CORBA SS specification.
683
+
684
+ #### B.2.1.2 File Names
685
+
686
+ CORBA SS specifications contain IDL statements.
687
+
688
+ The rule defined below specifies:
689
+
690
+ - a) How to partition/extract these IDL statements to be placed in a file; and
691
+ - b) How to name the file.
692
+
693
+ Note that IDL uses "#include "X"" statement where X is a name of a file containing IDL statements.
694
+
695
+ ##### Rule:
696
+
697
+ In the annex where IDL statements are defined, use a special marker to indicate that a set of IDL statements shall be contained in one file. The name of the file shall be the name of the first IDL module, concatenated with four characters ".idl". Within a CORBA SS, multiple markers (implying multiple files), can be used.
698
+
699
+ It is not allowed to have an IDL module split into multiple files.
700
+
701
+ #### B.2.1.3 Include Conventions
702
+
703
+ All included IDL files shall be specified using the <...> form of #include. For example:
704
+
705
+ ```
706
+ #include <ManagedGenericIRPConstDefs.idl>
707
+ ```
708
+
709
+ #### B.2.1.4 File Structure
710
+
711
+ ##### B.2.1.4.1 File Internal Identification
712
+
713
+ The first line of the IDL file shall contain ">//File:" followed by a single space followed by the name of the file. For example,
714
+
715
+ ```
716
+ //File: ExampleIRPConstDefs.idl
717
+ ```
718
+
719
+ ##### B.2.1.4.2 File Guard
720
+
721
+ An IDL file shall use a *guard* (consisting of three pre-processor lines) to avoid multiple definition errors. An example of a guard for the file called TestManagementIRPConstDefs.idl is:
722
+
723
+ ```
724
+ #ifndef _TestManagementIRPConstDefs_idl_
725
+ #define _TestManagementIRPConstDefs_idl_
726
+
727
+ ...remainder of the IDL
728
+
729
+ #endif // _TestManagementIRPConstDefs_idl_
730
+ ```
731
+
732
+ ##### B.2.1.4.3 Required Contents
733
+
734
+ If any other files are to be included, the #include statements come after the guard.
735
+
736
+ After #include lines, if any, and immediately before the module statement, the following line shall appear:
737
+
738
+ ```
739
+ #pragma prefix "3gppsa5.org"
740
+ ```
741
+
742
+ ##### B.2.1.4.4 Example illustrating a File Structure
743
+
744
+ ```
745
+ //File: ExampleIRPConstDefs.idl
746
+ #ifndef _EXAMPLE_IRP_CONST_DEFS_IDL_
747
+ #define _EXAMPLE_IRP_CONST_DEFS_IDL_
748
+
749
+ // This module describes/is part of...
750
+ #include "ExampleIncludeOne.idl"
751
+ #include "ExampleIncludeTwo.idl"
752
+
753
+ #pragma prefix "3gppsa5.org"
754
+ module ExampleIRPConstDefs {
755
+
756
+ // IDL Definitions here
757
+
758
+ };
759
+
760
+ #endif // _EXAMPLE_IRP_CONST_DEFS_IDL_
761
+ ```
762
+
763
+ ### B.2.2 Identifiers
764
+
765
+ #### B.2.2.1 Mixed Case, Beginning Upper, No Underscores
766
+
767
+ The following categories of identifiers follow the *Mixed Case, Beginning Upper, No Underscores* rules:
768
+
769
+ - module
770
+ - interface
771
+ - typedef
772
+ - Constructed types (struct, union, enum)
773
+ - exception
774
+
775
+ The "No underscores" rule is also applicable to all words that begin with an upper case letter with the remaining letters being lower case.
776
+
777
+ As a further note on naming, it is not necessary to append the value "Type" to an identifier. The fact that it is a type is obvious from the consistent application of this naming convention.
778
+
779
+ Examples:
780
+
781
+ ```
782
+ module PMIRPConstDefs(...);
783
+ interface AttributeNameValue(...);
784
+ ```
785
+
786
+ #### B.2.2.2 Lower Case with Underscores
787
+
788
+ The following categories of identifiers follow the *Lower Case with Underscores* rules. All letters are lower case and words (if more than one) are separated with underscores.
789
+
790
+ - Operation name and notification name
791
+ - Attribute name
792
+ - Parameter name
793
+ - Structure member name
794
+
795
+ Examples:
796
+
797
+ ```
798
+ get_notification_categories(...);
799
+ string comment_text;
800
+ void get_alarm_count (... , out unsigned long critical_count, ..);
801
+ struct Comment { ...; string user_id; string system_id; ..};
802
+ ```
803
+
804
+ #### B.2.2.3 Upper Case with Underscores
805
+
806
+ The following categories of identifiers follow *Upper Case with Underscores* rules. All letters are in upper case and words have an underscore separating them.
807
+
808
+ - Enum value
809
+ - Constant
810
+
811
+ Examples:
812
+
813
+ ```
814
+ enum SubscriptionState {ACTIVE, SUSPENDED, INVALID};
815
+ const string JOB_ID = "JOB_ID";
816
+ ```
817
+
818
+ #### B.2.2.4 Naming IDL Sequence Types
819
+
820
+ Typically a new type declared as an IDL sequence of another type will have the text "List" appended to the name of the base type. Another convention is to declare such types as unordered sequences or ordered sets for consistency with ASN.1 notation. In this case they should have the "Seq" or "Set" (instead of "List") appended respectively.
821
+
822
+ Example of an "ordered set":
823
+
824
+ ```
825
+ typedef sequence <SubscriptionId> SubscriptionIdSet;
826
+ ```
827
+
828
+ ### B.2.3 Interface IRP
829
+
830
+ Every Interface IRP should have 3 IDL modules (each specified in a separate IDL file):
831
+
832
+ ```
833
+ module YyyIRPConstDefs {...}; // no change from Rel-5 practice.
834
+
835
+ module YyyIRPSystem {...}; // no change from Rel-5 practice.
836
+
837
+ module YyyIRPNotifications {...}; // new compared to Rel-5 practice
838
+ ```
839
+
840
+ The first module defines all necessary IDL constructs, such as constant strings and type definitions, for the methods and notifications. The second module defines the methods. The third module defines the notifications.
841
+
842
+ #### B.2.3.1 Constant String and Type Definitions
843
+
844
+ This first module defines all necessary IDL constructs used by the methods (defined in the second module) and notifications (defined in the third module). The name of this module is YyyIRPConstDefs where Xxx is the name of the subject Interface IRP. An example is "PMIRPConstDefs".
845
+
846
+ Within this module, define data types used in the methods.
847
+
848
+ Also, define the data types of the attribute values used in the notifications.
849
+
850
+ CORBA SS authors should always check the generic types defined in "ManagedGenericIRPConstDefs" before creating a new type.
851
+
852
+ For the attribute names of the structured notifications, define an interface `AttributeNameValue` that captures the string definitions. Make sure these definitions do not clash with those defined for the notification header, i.e. notification id, event time, system DN, managed object class and managed object instance (see `NotificationIRPNotification::Notify`).
853
+
854
+ An example from `PMIRPConstDefs`:
855
+
856
+ ```
857
+ /**
858
+ * This block identifies attributes which are included as part of the
859
+ * PMIRP. These attribute values should not
860
+ * clash with those defined for the attributes of notification
861
+ * header (see IDL of Notification IRP).
862
+ */
863
+
864
+ interface AttributeNameValue
865
+ {
866
+ const string JOB_ID = "JOB_ID";
867
+ const string JOB_STATUS = "JOB_STATUS";
868
+ const string REASON = "REASON";
869
+ const string MONITOR_ID = "MONITOR_ID";
870
+ const string MONITOR_STATUS = "MONITOR_STATUS";
871
+ };
872
+ ```
873
+
874
+ #### B.2.3.2 Operations
875
+
876
+ The second module defines the methods. The name of the module is `YyyIRPSystem` where `Yyy` is the name of the subject Interface IRP. An example is `AlarmIRPSystem`.
877
+
878
+ At the beginning of this module, define all required exceptions. Naming conventions for exception are covered in B.2.2.1 above. CORBA SS authors should always check if the generic exceptions defined in the `ManagedGenericIRPSystem` can be reused before declaring new exception types.
879
+
880
+ Then define one interface called `YyyIRP` encapsulating all methods of the subject `Yyy` Interface IRP. If the subject Interface IRP IS specifies that its `YyyIRP` inherits from `XxxIRP`, then reflect the inheritance relation in the interface definition. The following is an example of `AlarmIRP` that inherits from `ManagedGenericIRP`.
881
+
882
+ ```
883
+ module AlarmIRPSystem
884
+ {
885
+ ...
886
+ ...
887
+ interface AlarmIRP : ManagedGenericIRPSystem:: ManagedGenericIRP {...};
888
+ ...
889
+ };
890
+ ```
891
+
892
+ Naming conventions for operations are covered in B.2.2.2 above.
893
+
894
+ #### B.2.3.3 Notifications
895
+
896
+ Use a separate module to define the notifications. The name the module is `YyyIRPNotifications` where `Yyy` is the name of the subject Interface IRP. Examples are `KernelCMIRPNotifications` and `PMIRPNotifications`.
897
+
898
+ For `NotificationIRPNotifications`, do:
899
+
900
+ - Define one IDL interface `Notify`. Capture the four constant strings that are the names of the four NV (name value) pairs of `filterable_body_field` of the CORBA structured event. These four CORBA NV pairs are mapped from the five notification header attributes (defined by the Notification IRP IS), i.e. the `objectClass`, `objectInstance`, `notificationId`, `eventTime` and `systemDN`.
901
+
902
+ For `YyyIRPNotifications` where `Yyy` is not `Notification`, do:
903
+
904
+ - At the beginning of this module, define the const strings for the notification types that correspond to the set of notifications specified by (and not inherited by and not imported by) the subject Interface IRP.
905
+ - Then define a number of IDL interfaces corresponding to notifications specified in the subject Interface IRP. These interfaces should inherit from `NotificationIRPNotifications::Notify`. Within each interface, the first IDL statement defines the notification type (that is used as the second field of the fixed header of the structured notification). The second and subsequent IDL statements define the attribute names of this notification type, excepting those already defined by `NotificationIRPNotifications::Notify`. The data type of the attribute value, which is defined in `YyyIRPConstDefs`, should be mentioned in the comment block of this IDL statement.
906
+ - Then define a number of IDL interfaces corresponding to notifications imported, if any. These interfaces should inherit from the imported interface. An example is `interface NotifyObjectCreation : KernelCMIRPNotifications:: NotifyObjectCreation`. Within this interface, define all necessary IDL constructs, if any, which are not defined in the imported interface. This interface may contain no IDL statement if the IDL constructs defined in the imported interface are sufficient. For each interface imported, insert a comment "The first field of this notification carries the IRPVersion of this CORBA SS."
907
+ - There is no need to re-define interfaces for notifications that are already specified in other Interface IRP, and from which the subject IRP inherits.
908
+
909
+ The following is an extract from `PMIRPNotifications`.
910
+
911
+ ```
912
+ module PMIRPNotifications
913
+ ```
914
+
915
+ ```
916
+ {
917
+
918
+ const string ET_MEASUREMENT_JOB_STATUS_CHANGED = "notifyMeasurementJobStatusChanged";
919
+ const string ET_THRESHOLD_MONITOR_STATUS_CHANGED = "notifyThresholdMonitorStatusChanged";
920
+
921
+ interface NotifyMeasurementJobStatusChanged: NotificationIRPNotifications::Notify
922
+ {
923
+ const string EVENT_TYPE = ET_MEASUREMENT_JOB_STATUS_CHANGED;
924
+
925
+ /**
926
+ * This constant defines the name of the jobId property,
927
+ * which is transported in the filterable body fields.
928
+ * The data type for the value of this property
929
+ * is PMIRPConstDefs::JobIdType.
930
+ */
931
+ const string JOB_ID = PMIRPConstDefs::AttributeNameValue::JOB_ID;
932
+
933
+ ...
934
+ ...
935
+ };
936
+
937
+ interface NotifyXXX : NotificationIRPNotifications::Notify
938
+ {
939
+ ...
940
+ };
941
+
942
+ ...
943
+ };
944
+ ```
945
+
946
+ ### B.2.4 NRM IRP
947
+
948
+ Use one module to define the IDL constructs for the managed object classes. The name of this module is XxxNRIRPConstDefs where Xxx is the name of the subject NRM IRP.
949
+
950
+ An example is UtranNRIRPConstDefs.
951
+
952
+ Within the module, define a set of IDL interfaces each of which corresponds to a managed object class specified. The interface definition respects the inheritance relation specified.
953
+
954
+ After the interface definition, the type definition for each attribute defined for the managed object class is defined (including inherited attributes). The type is defined in one of two ways:
955
+
956
+ 1. With a typedef of the type that matches the attribute definition in the NRM Information Object Class (IOC) mapping table, or
957
+ 2. With a CORBA IDL comment if the same attribute name is already defined in managed object classes already defined in this NRM.
958
+
959
+ An example of managed object class RncFunction, which inherits from GenericNRIRPConstDefs::ManagedFunction, is shown below.
960
+
961
+ ```
962
+ module UtranNRIRPConstDefs
963
+ {
964
+ ...
965
+
966
+ /**
967
+ * Definitions for MO class RncFunction
968
+ */
969
+ interface RncFunction : GenericNRIRPConstDefs::ManagedFunction
970
+ {
971
+ const string CLASS = "RncFunction";
972
+
973
+ // Attribute Names
974
+ //
975
+ const string rncFunctionId = "rncFunctionId";
976
+
977
+ const string mcc= "mcc";
978
+ const string mnc= "mnc";
979
+ const string rncId= "rncId";
980
+ };
981
+
982
+ typedef string rncFunctionId;
983
+ typedef long mcc;
984
+ typedef long mnc;
985
+ typedef long rncId;
986
+ // userLabel
987
+
988
+ ...
989
+ };
990
+ ```
991
+
992
+ # --- Annex C (normative): Technology specific rules & guidelines for SOAP SSs
993
+
994
+ ## C.1 Rules
995
+
996
+ ### C.1.1 Introduction
997
+
998
+ The intent of this annex is threefold.
999
+
1000
+ - 4) The first intent is for 3GPP internal use to document how a 3GPP SOAP SS is produced and how it is structured.
1001
+ - 5) The second intent with the annex is to give the reader or implementer of a SOAP SS a better understanding on how to interpret the SOAP SS specification.
1002
+ - 6) The third and maybe most important intent is to put requirement on an implementer of a SOAP SS.
1003
+
1004
+ It is expected that this annex is to be extended in later versions of the present document.
1005
+
1006
+ ### C.1.2 Rules for specification of SOAP Solution Sets
1007
+
1008
+ #### C.1.2.1 Introduction
1009
+
1010
+ This subclause identifies rules for specification of SOAP SSs. This subclause is mainly for 3GPP-internal use. It is only for information for the implementer of a SOAP SS.
1011
+
1012
+ #### C.1.2.2 File names
1013
+
1014
+ The WSDL files should follow the naming convention:
1015
+
1016
+ WSDLTarget.wsdl
1017
+
1018
+ with:
1019
+
1020
+ WSDLTarget being the text after the character '#' in the target namespace of the definitions
1021
+
1022
+ Examples:
1023
+
1024
+ If the 3GPP WSDL document contains
1025
+
1026
+ <definitions ...
1027
+
1028
+ targetNamespace="http://www.3gpp.org/ftp/specs/archive/32\_series/32.666#KernelCMIRPSystem">, then the WSDL filename shall be `KernelCMIRPSystem.wsdl`.
1029
+
1030
+ If the WSDL document contains
1031
+
1032
+ <definitions ... targetNamespace="http://www.3gpp.org/ftp/specs/archive/32\_series/32.111-6#AlarmIRPSystem">, then the WSDL filename shall be `AlarmIRPSystem.wsdl`.
1033
+
1034
+ #### C.1.2.3 Void
1035
+
1036
+ #### C.1.2.4 XML version encoding
1037
+
1038
+ The first line of each wsdl and xsd file shall indicate the XML version and encoding. The supported XML version is 1.0 (refer to [15]) and encoding is UTF-8 (refer to [16]).
1039
+
1040
+ Therefore, the wsdl and xsd files should begin with:
1041
+
1042
+ <?xml version="1.0" encoding="UTF-8"?>
1043
+
1044
+ #### C.1.2.5 Namespaces
1045
+
1046
+ The WSDL namespace URI shall follow the naming convention:
1047
+
1048
+ `http://www.3gpp.org/ftp/specs/archive/32_series/IRPNumber#ResourceName`
1049
+
1050
+ with:
1051
+
1052
+ - IRPNumber being the number before the 3GPP document version number, corresponding to the 3GPP document which describes the resource,
1053
+ - ResourceName being a mnemonic for the resource.
1054
+
1055
+ Examples:
1056
+
1057
+ If the 3GPP document "3GPP TS 32.111-7 V9.0.0 (2009-12)" describes the resource "AlarmIRPSystem", then the WSDL namespace URI shall be
1058
+ [http://www.3gpp.org/ftp/specs/archive/32\\_series/32.111-7#AlarmIRPSystem](http://www.3gpp.org/ftp/specs/archive/32_series/32.111-7#AlarmIRPSystem)
1059
+
1060
+ If the 3GPP document "3GPP TS 32.127 V9.0.0 (2009-12)" describes the resource "AAMIRPData", then the WSDL namespace URI shall be
1061
+ [http://www.3gpp.org/ftp/specs/archive/32\\_series/32.127#AAMIRPData](http://www.3gpp.org/ftp/specs/archive/32_series/32.127#AAMIRPData)
1062
+
1063
+ ### C.1.3 Implementation aspects of Interface IRP SOAP Solution Sets
1064
+
1065
+ #### C.1.3.1 Introduction
1066
+
1067
+ This subclause identifies rules for the implementation of SOAP SSs. This subclause is normative for the implementer of a SOAP SS.
1068
+
1069
+ #### C.1.3.n XXXX rule
1070
+
1071
+ ## C.2 Guidelines (Style Guide for SOAP SS WSDL)
1072
+
1073
+ This subclause describes the style guide for writing WSDL documents for Interface IRP.
1074
+
1075
+ The guide sets out consistent naming, structural conventions and usage of SS interface for the WSDL in IRP SOAP SS specifications.
1076
+
1077
+ ### C.2.1 File structure
1078
+
1079
+ The structure of the wsdl file shall follow the W3C WSDL Document Structure defined in [10] specifications.
1080
+
1081
+ #### C.2.1.1 Definitions
1082
+
1083
+ *Guidelines for the Definitions section.*
1084
+
1085
+ #### C.2.1.2 Namespaces
1086
+
1087
+ *Guidelines for the Namespaces section.*
1088
+
1089
+ #### C.2.1.3 Documentation
1090
+
1091
+ *Guidelines for the optional Documentation section.*
1092
+
1093
+ #### C.2.1.4 Types
1094
+
1095
+ *Guidelines for Types*
1096
+
1097
+ #### C.2.1.5 Message
1098
+
1099
+ *Guidelines for Messages*
1100
+
1101
+ #### C.2.1.6 Port type
1102
+
1103
+ *Guidelines for Port types*
1104
+
1105
+ #### C.2.1.7 Binding
1106
+
1107
+ *Guidelines for Bindings*
1108
+
1109
+ #### C.2.1.8 Port
1110
+
1111
+ *Guidelines for Ports*
1112
+
1113
+ #### C.2.1.9 Service
1114
+
1115
+ *Guidelines for Services*
1116
+
1117
+ ### C.2.2 Identifiers
1118
+
1119
+ #### C.2.2.n Rule n
1120
+
1121
+ *Identify the categories of identifiers which follow the Rule n rules.*
1122
+
1123
+ ## C.3 XML Schema Guidelines
1124
+
1125
+ This subclause describes the style guide for writing XML Schema for Operation/Notification messages and parameters to be imported into the WSDL file for the IRP SOAP SS specifications.
1126
+
1127
+ ### C.3.1 XSD guidelines for messages definition
1128
+
1129
+ #### C.3.1.1 Request message
1130
+
1131
+ *Guidelines for the Request message.*
1132
+
1133
+ #### C.3.1.2 Response messages
1134
+
1135
+ *Guidelines for the Response messages.*
1136
+
1137
+ #### C.3.1.3 Fault messages
1138
+
1139
+ *Guidelines for the Fault messages.*
1140
+
1141
+ ### C.3.2 XSD guidelines for parameters definition
1142
+
1143
+ #### C.3.1.1 General guidelines
1144
+
1145
+ *General guidelines for the parameters definitions.*
1146
+
1147
+ #### C.3.1.1 Simple type definitions
1148
+
1149
+ *Guidelines for the simple type definitions.*
1150
+
1151
+ #### C.3.1.2 Complex type definition
1152
+
1153
+ *Guidelines for the complex type.*
1154
+
1155
+ ### C.3.3 Identifiers
1156
+
1157
+ The identifiers should follow the rules defined in paragraph C.2.2.
1158
+
1159
+ # Annex D (normative): Technology specific rules & guidelines for XML specifications
1160
+
1161
+ ## D.1 Rules
1162
+
1163
+ ### D.1.1 XSD Use Cases
1164
+
1165
+ #### D.1.1.1 Background
1166
+
1167
+ 3GPP defines a number of IOCs, say in Release-N. 3GPP also defines an XSD schema that can capture these IOCs, in Release-N.
1168
+
1169
+ Release-N+1 authors can/may also extend these Release-N IOCs to capture the newly agreed capabilities and publish them as Release-N+1 IOCs. Authors also define a Release-N+1 XSD schema.
1170
+
1171
+ The Use Cases here illustrate the capabilities of the Release-N+1 XSD schema.
1172
+
1173
+ The "?" in the Use Case tables are for further study.
1174
+
1175
+ #### D.1.1.2 Use Cases Set 1
1176
+
1177
+ Suppose the old-XSD has SubNetwork (SN) containing ManagedElement (ME).
1178
+
1179
+ Suppose the new-XSD has enhanced-SN containing enhanced-ME.
1180
+
1181
+ Suppose we want the XML-instance-documents (doc-1, doc-2, etc) to contain instances as identified below:
1182
+
1183
+ - Doc-1 has SN instance containing ME instances
1184
+ - Doc-2 has SN instance containing enhanced-ME instances
1185
+ - Doc-3 has SN instance containing ME instances and enhanced-ME instances
1186
+ - Doc-4 has enhanced-SN containing enhanced-ME instances
1187
+ - Doc-5 has enhanced-SN containing ME instances
1188
+ - Doc-6 has enhanced-SN containing enhanced-ME instances and ME instances
1189
+
1190
+ Can a XML-instance-doc-creator (IRPAgent or IRPManager) produce the doc (column) using the XSD (row) identified?
1191
+
1192
+ | | Doc-1 | Doc-2 | Doc-3 | Doc-4 | Doc-5 | Doc-6 |
1193
+ |---------|-------|-------|-------|-------|-------|-------|
1194
+ | Old-XSD | ? | ? | ? | ? | ? | ? |
1195
+ | New-XSD | ? | ? | ? | ? | ? | ? |
1196
+
1197
+ Can a XML-instance-doc-reader (IRPAgent or IRPManager) validate the doc (i.e. confirm that the document is well-formed) (column) using the XSD (row) identified?
1198
+
1199
+ | | Doc-1 | Doc-2 | Doc-3 | Doc-4 | Doc-5 | Doc-6 |
1200
+ |---------|-------|-------|-------|-------|-------|-------|
1201
+ | Old-XSD | ? | ? | ? | ? | ? | ? |
1202
+ | New-XSD | ? | ? | ? | ? | ? | ? |
1203
+
1204
+ #### D.1.1.3 Use Cases Set 2
1205
+
1206
+ Suppose one old-XSD has SubNetwork (SN) containing ManagedElement (ME) that in turn, contained an RNCFunction (RNC) defined by the other Old-XSD.
1207
+
1208
+ Suppose the new-XSD has enhanced-SN containing enhanced-ME. Suppose also another new-XSD has enhanced-RNC.
1209
+
1210
+ - Doc-7 has ME instance containing RNC instances
1211
+ - Doc-8 has ME instances containing enhanced-RNC instances
1212
+ - Doc-9 has ME instances containing RNC instances and enhanced-RNC instances
1213
+ - Doc-10 has enhanced-ME instances containing enhanced-RNC instances
1214
+ - Doc-11 has enhanced-ME instances containing RNC instances
1215
+ - Doc-12 has enhanced-ME instances containing RNC instances and enhanced-RNC instances
1216
+
1217
+ Can a XML-instance-doc creator (IRP Agent or IRP Manager) produce the doc (column) using the XSD (row) identified?
1218
+
1219
+ | | Doc-7 | Doc-8 | Doc-9 | Doc-10 | Doc-11 | Doc-12 |
1220
+ |---------|-------|-------|-------|--------|--------|--------|
1221
+ | Old-XSD | ? | ? | ? | ? | ? | ? |
1222
+ | New-XSD | ? | ? | ? | ? | ? | ? |
1223
+
1224
+ Can a reader (IRP Agent or IRP Manager) validate the doc (i.e. confirm that the document is well-formed) (column) using the XSD (row) identified?
1225
+
1226
+ | | Doc-1 | Doc-2 | Doc-3 | Doc-4 | Doc-5 | Doc-6 |
1227
+ |---------|-------|-------|-------|-------|-------|-------|
1228
+ | Old-XSD | ? | ? | ? | ? | ? | ? |
1229
+ | New-XSD | ? | ? | ? | ? | ? | ? |
1230
+
1231
+ ### D.1.2 Rules for NRM IRP XML specification extensions
1232
+
1233
+ TBD
1234
+
1235
+ ### D.1.3 XML version encoding
1236
+
1237
+ The first line of each XML schema description file shall indicate the XML version and encoding. The supported XML version is 1.0 (refer to [15]) and encoding is UTF-8 (refer to [16]).
1238
+
1239
+ Therefore, the xsd files should begin with:
1240
+
1241
+ ```
1242
+ <?xml version="1.0" encoding="UTF-8"?>
1243
+ ```
1244
+
1245
+ ## --- D.2 Guidelines
1246
+
1247
+ TBD
1248
+
1249
+ # Annex E (informative): Change history
1250
+
1251
+ | Change history | | | | | | | | |
1252
+ |----------------|-------|-----------|-----|-----|---------------------------------------------------------------|-----|--------|--------|
1253
+ | Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Cat | Old | New |
1254
+ | Mar 2008 | SA_39 | SP-080070 | -- | -- | Submitted to SA#39 for Information | -- | -- | 1.0.0 |
1255
+ | Mar 2009 | SA-43 | SP-090057 | -- | -- | Submitted to SA for approval | -- | 2.0.0 | 8.0.0 |
1256
+ | Dec 2009 | SA_46 | SP-090719 | 001 | -- | Discontinuation of the maintenance of WSDL/XML schema folders | F | 8.0.0 | 9.0.0 |
1257
+ | Jun 2010 | SA_48 | SP-100264 | 002 | -- | New rule for WSDL namespace URIs | F | 9.0.0 | 10.0.0 |
1258
+ | Sep 2010 | SA_49 | SP-100489 | 003 | -- | Change rule for WSDL filenames | F | 10.0.0 | 10.1.0 |
1259
+ | Mar 2016 | SA_71 | SP-160032 | 007 | - | Correctinjg references | A | 10.1.0 | 10.2.0 |
marked/Rel-10/32_series/32154/raw.md ADDED
@@ -0,0 +1,379 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+ # Keywords GSM, UMTS, management **3GPP TS 32.154 V10.0.0 (2010-03)**
4
+
5
+ *Technical Specification*
6
+
7
+ ## **3GPP** **3rd Generation Partnership Project;** Postal address **Technical Specification Group Services and System Aspects;** **Telecommunication management;** 3GPP support office address **Backward and Forward Compatibility (BFC);** 150 Route des Lucioles - Sophia Antipolis Valbonne - FRANCE Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 40 00 **Concept1**
8
+
9
+ ![LTE logo](64662465bba247703fdec49c8f3309f9_img.jpg)
10
+
11
+ LTE logo
12
+
13
+ Internet
14
+ <http://www.3gpp.org>
15
+
16
+ ![3GPP logo](390120de4fe440c42fea8154fcaad334_img.jpg)
17
+
18
+ 3GPP logo
19
+
20
+ # ***Copyright Notification***
21
+
22
+ No part may be reproduced except as authorized by written permission.
23
+ The copyright and the foregoing restriction extend to reproduction in all media.
24
+
25
+ ©2010, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TTA, TTC).
26
+ All rights reserved.
27
+
28
+ UMTS™ is a Trade Mark of ETSI registered for the benefit of its members
29
+
30
+ 3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
31
+
32
+ LTE™ is a Trade Mark of ETSI currently being registered for the benefit of its Members and of the 3GPP Organizational Partners
33
+
34
+ GSM® and the GSM logo are registered and owned by the GSM Association
35
+
36
+ The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP.
37
+
38
+ The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented.
39
+
40
+ This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices.
41
+
42
+ # --- Contents
43
+
44
+ | | |
45
+ |-------------------------------------------------------------|-----------|
46
+ | Foreword ..... | 4 |
47
+ | Introduction ..... | 4 |
48
+ | 1 Scope..... | 5 |
49
+ | 2 References..... | 5 |
50
+ | 3 Definitions and abbreviations ..... | 5 |
51
+ | 3.1 Definitions..... | 5 |
52
+ | 3.2 Abbreviations ..... | 6 |
53
+ | 4 BC between 3GPP TS 32-series specifications..... | 6 |
54
+ | 4.1 Prerequisite..... | 6 |
55
+ | 4.2 Rules..... | 7 |
56
+ | 5 BC context..... | 8 |
57
+ | 5.1 General ..... | 8 |
58
+ | 5.2 IRP level..... | 9 |
59
+ | 5.3 IRP Agent level ..... | 10 |
60
+ | 6 BC Recommendations..... | 12 |
61
+ | 6.1 Requirement ..... | 12 |
62
+ | 6.2 IS-level ..... | 12 |
63
+ | 6.3 SS-level ..... | 12 |
64
+ | 6.3.1 CORBA ..... | 12 |
65
+ | 6.3.2 Void ..... | 12 |
66
+ | 6.3.3 File format description XML..... | 12 |
67
+ | 6.3.4 File format description ASN.1 ..... | 12 |
68
+ | 6.3.5 SOAP ..... | 12 |
69
+ | <b>Annex A (informative): BC and Conformance Tests.....</b> | <b>13</b> |
70
+ | Annex B (informative): Change history..... | 14 |
71
+
72
+ # --- Foreword
73
+
74
+ This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP).
75
+
76
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
77
+
78
+ Version x.y.z
79
+
80
+ where:
81
+
82
+ - x the first digit:
83
+ - 1 presented to TSG for information;
84
+ - 2 presented to TSG for approval;
85
+ - 3 or greater indicates TSG approved document under change control.
86
+ - y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
87
+ - z the third digit is incremented when editorial only changes have been incorporated in the document.
88
+
89
+ # --- Introduction
90
+
91
+ The Itf-N partitions two groups of interacting entities called IRPManager(s) and IRPAgent(s).
92
+
93
+ The interactions between an IRPManager and IRPAgent are specified by the set of IRP specifications the IRPAgent supports, and which the IRPManager uses.
94
+
95
+ Each YyyIRP (where "Yyy" stands for Alarm, BasicCM, etc.) permits a manager to, via `getIRPVersion`, inspect it's supported IRPVersion(s). Each such IRPVersion uniquely identifies one supported Interface IRP SS.
96
+
97
+ Each YyyIRP may also permit an IRPManager to, via `getNRMIRPVersions`, inspect it's supported NRM IRPVersion(s). Each such IRPVersion uniquely identifies one supported NRM IRP SS.
98
+
99
+ The 3GPP IRP specifications are expected to evolve. For example, 3GPP Release 6 specifications include more or modified features compared to the corresponding set in Release 5.
100
+
101
+ An IRPManager and IRPAgent, with implementations conformant to the same IRP specification (at the same IRPVersion(s)) will be able to communicate.
102
+
103
+ However, an upgrade of the IRPVersion, if not performed by both IRPAgent and IRPManager, can result in inter-working failure if Backward Compatibility (BC) issues are not addressed.
104
+
105
+ The present document is applicable/relevant to a system context of a group of interacting IRPManagers and IRPAgents where some members are using one IRPVersion while others are using an upgraded IRPVersion.
106
+
107
+ # --- 1 Scope
108
+
109
+ The present document gives recommendations to develop future IRP specifications in a Backward Compatible (BC) way so that the group of IRPManager(s) and IRPAgent(s) are not forced to be upgraded in lock step.
110
+
111
+ The business case for supporting such group, as described above, is complex. It may not relate to the functions of the supported IRPs alone. Rather, it can relate to the cost of coordination of IRPVersion upgrades, the cost of maintaining an old IRPVersion and the cost of using single-vendor or multi-vendor IRPAgents. These considerations are operator deployment scenarios specific.
112
+
113
+ Clause 4 specifies the Recommendations and clause 5 describes the system context where the Recommendations are applicable.
114
+
115
+ **Editor's Note:** The “forward compatibility” part is FFS.
116
+
117
+ # --- 2 References
118
+
119
+ The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
120
+
121
+ - References are either specific (identified by date of publication and/or edition number or version number) or non-specific.
122
+ - For a specific reference, subsequent revisions do not apply.
123
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
124
+
125
+ - [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements".
126
+ - [2] 3GPP TS 32.102: "Telecommunication management; Architecture".
127
+ - [3] 3GPP TS 32.111-2: "Telecommunication management; Fault Management; Part 2: Alarm Integration Reference Point (IRP): Information Service (IS)".
128
+ - [4] 3GPP TS 32.311: "Telecommunication management; Generic Integration Reference Point (IRP) management; Requirements".
129
+
130
+ # --- 3 Definitions and abbreviations
131
+
132
+ ## 3.1 Definitions
133
+
134
+ For the purposes of the present document, the following terms and definitions apply:
135
+
136
+ **Element Manager (EM):** See 3GPP TS 32.101 [1].
137
+
138
+ **IRPAgent:** See 3GPP TS 32.102 [2].
139
+
140
+ **IRPManager:** See 3GPP TS 32.102 [2].
141
+
142
+ **IRPVersion:** See "IRP document version number string" or "IRPVersion" in 3GPP TS 32.311 [4] clause 3.1.
143
+
144
+ **Network Manager (NM):** See 3GPP TS 32.101 [1].
145
+
146
+ ## 3.2 Abbreviations
147
+
148
+ For the purposes of the present document, the following abbreviations apply:
149
+
150
+ | | |
151
+ |-------|-----------------------------------------------|
152
+ | ASN.1 | Abstract Syntax Notation One |
153
+ | BC | Backward Compatible or Backward Compatibility |
154
+
155
+ | | |
156
+ |-------|-------------------------------------------------------|
157
+ | CMIP | Common Management Information Protocol |
158
+ | CORBA | Common Object Request Broker Architecture |
159
+ | EM | Element Manager |
160
+ | IS | Information Service |
161
+ | IRP | Integration Reference Point |
162
+ | NE | Network Element |
163
+ | NM | Network Manager |
164
+ | NRM | Network Resource Model |
165
+ | VSE | Vendor Specific Extension (to 3GPP IRP specification) |
166
+ | SS | Solution Set |
167
+ | XML | eXtensible Markup Language |
168
+
169
+ # --- 4 BC between 3GPP TS 32-series specifications
170
+
171
+ ## 4.1 Prerequisite
172
+
173
+ The words old and new, when qualifying an IRPVersion, refer to a single Interface IRPVersion of the same kind, e.g. Alarm IRP. They also refer to NRM IRPVersion of the same kind, e.g. Core NRM. The 'new' refers to a later release compared to the 'old'.
174
+
175
+ The words old and new, when qualifying an IRPManager, refer to an entity that is using the old or the new (Interface or NRM) IRPVersion.
176
+
177
+ The words old and new, when qualifying an IRPAgent, refer to an entity that contains an IRP that is supporting the old or the new (Interface or NRM) IRPVersion.
178
+
179
+ In majority cases, an IRPAgent instance contains multiple IRPs, each of which is using a particular Interface IRPVersion. In these cases, each Recommendation statement should be repeated to cover all IRPs involved.
180
+
181
+ The Recommendations do not imply that equipment vendors shall always supply their new IRPAgents in compliance to the solutions satisfying the Recommendations. The Recommendations simply identify the expected behaviours of a new system when it, claiming BC, interacts with an old system. Whether or not an IRPAgent should satisfy the Recommendations is a decision of the equipment vendor/supplier.
182
+
183
+ The Recommendations do not imply that the next release of 3GPP Interface IRP or NRM IRP specification must be BC (to the older one). Whether or not a new release of an Interface IRP or NRM IRP should be BC to its older version is a decision of the 3GPP specification author, on a case-by-case basis.
184
+
185
+ ## 4.2 Rules
186
+
187
+ [REC-1] An old IRPManager inter-operates with an old IRPAgent-A and a new IRPAgent-B.
188
+ The interaction shall be successful in that the IRPManager can obtain the network management services (capabilities and features) defined by the old IRPVersion from both IRPAgents.
189
+ The IRPManager needs not have knowledge of new network management services defined by the new IRPVersion.
190
+
191
+ [REC-2] A new IRPManager inter-operates with a new IRPAgent-A and an old IRPAgent-B.
192
+ The interaction shall be successful in that the IRPManager can obtain the network management services defined by (a) the new IRPVersion from IRPAgent-A and (b) the old IRPVersion from IRPAgent-B.
193
+
194
+ NOTE: If the next minor and/or major release of 3GPP Interface IRP or NRM IRP specification is BC (to the older one), one could reduce or eliminate the difficult coordination task to introduce IRPVersion upgrades in a large management domain containing multiple IRPManagers and IRPAgents.
195
+ It can be more cost-effective if IRPVersion upgrades to individual entity (i.e. IRPManager and IRPAgent) are done at different times.
196
+
197
+ # 5 BC context
198
+
199
+ ## 5.1 General
200
+
201
+ This clause defines the context under which the requirements specified in the present document are applicable.
202
+
203
+ The word 'old' qualifies the related entity (i.e. the AlarmIRP of an IRPAgent instance or Alarm IRPManager) that is using an older 3GPP IRPVersion (called old version). The word 'new' qualifies the related entity that is using a newer (upgraded) 3GPP IRPVersion.
204
+
205
+ EXAMPLE: A hypothetical 3GPP TS 32.123 V6.0.0 is considered the old version with reference to 3GPP TS 32.123 V6.1.0. The two versions in question can belong to the same or different major releases (e.g. Rel-5 or Rel-6).
206
+
207
+ The box labelled EM in figure 5.1 conveys the same idea as the box of the same label in the System Context-A of other IRP specifications such as Alarm IRP IS 3GPP TS 32.111-2 [3].
208
+
209
+ One or all EM-labelled boxes of figure 5.1 can be interchanged with the NE-labelled box (see System Context-B of other IRP specifications such as Alarm IRP IS 3GPP TS 32.111-2 [3]). The NE entities are not shown in order to make the figure easier to read.
210
+
211
+ ![Diagram of Overall BC System Context showing Old IRPManager (NM), New IRPManager (NM), Old IRPAgent (EM), and New IRPAgent (EM) connected by lines to a central vertical dashed line labeled Itf-N.](1c953f32bd34345dfd68fddf8a3736d6_img.jpg)
212
+
213
+ The diagram illustrates the 'Overall BC System Context'. It features four rectangular boxes arranged in a 2x2 grid, separated by a central vertical dashed line labeled 'Itf-N' at the top. The boxes are: 'Old IRPManager' (top-left), 'New IRPManager' (bottom-left), 'Old IRPAgent' (bottom-right), and 'New IRPAgent' (top-right). Below each box is a label: 'NM' for the IRPManagers and 'EM' for the IRPAgents. Lines connect each box to the central dashed line, crossing each other in the middle. Specifically, the top-left box connects to the bottom-right, and the bottom-left box connects to the top-right, both passing through the center of the dashed line.
214
+
215
+ Diagram of Overall BC System Context showing Old IRPManager (NM), New IRPManager (NM), Old IRPAgent (EM), and New IRPAgent (EM) connected by lines to a central vertical dashed line labeled Itf-N.
216
+
217
+ **Figure 5.1: Overall BC System Context**
218
+
219
+ In general, an IRPAgent instance may contain several Interface YyyIRP instances and associated supporting Yyy NRM IRPs (where one IRP can be for example Alarm IRP, Test Management IRP, or "Notification IRP", etc and where the other IRP can be for example Generic IRP). The Interface and NRM YyyIRP specifications of particular IRPVersion(s) together specify the behaviour of an Interface IRP and the supporting NRM IRP (s).
220
+
221
+ NOTE: The IRPVersion concept is related to the IRP.
222
+ The IRPVersion concept is not related to the IRPAgent as this may contain multiple IRPs.
223
+
224
+ Given this background, the BC issues are addressed at two separate but related levels as described in clauses 5.2 and 5.3.
225
+
226
+ ## 5.2 IRP level
227
+
228
+ The two diagrams here illustrate conceptually the two possible contexts when we address BC at this IRP level.
229
+
230
+ ![Figure 5.2: Specification BC System Context. Two diagrams showing interactions between IRPManagers and YyyIRP instances via an interface labeled Itf-N. The top diagram shows an 'Old IRPManager' (NM) and a 'New IRPManager' (NM) both connected to a 'YyyIRP IRPVersion-new' (EM) which is also connected to an 'IRP Agent'. The bottom diagram shows an 'Old IRPManager' (NM) connected to a 'YyyIRP IRPVersion-old' (EM) which is also connected to an 'IRP Agent'.](990567efebf979be51f56d1150012c9d_img.jpg)
231
+
232
+ The diagram consists of two parts, top and bottom, separated by a horizontal dashed line labeled 'Itf-N'.
233
+
234
+ **Top Diagram:** On the left, there are two boxes labeled 'Old IRPManager' and 'New IRPManager', both with a label 'NM' below them. Both boxes have lines connecting them to the 'Itf-N' interface. On the right, there is a large box labeled 'EM' containing two smaller boxes: 'YyyIRP IRPVersion-new' and 'IRP Agent'. The 'YyyIRP IRPVersion-new' box is connected to the 'Itf-N' interface and also connected to the 'IRP Agent' box.
235
+
236
+ **Bottom Diagram:** On the left, there is a box labeled 'Old IRPManager' with a label 'NM' below it, connected to the 'Itf-N' interface. On the right, there is a large box labeled 'EM' containing two smaller boxes: 'YyyIRP IRPVersion-old' and 'IRP Agent'. The 'YyyIRP IRPVersion-old' box is connected to the 'Itf-N' interface and also connected to the 'IRP Agent' box.
237
+
238
+ Figure 5.2: Specification BC System Context. Two diagrams showing interactions between IRPManagers and YyyIRP instances via an interface labeled Itf-N. The top diagram shows an 'Old IRPManager' (NM) and a 'New IRPManager' (NM) both connected to a 'YyyIRP IRPVersion-new' (EM) which is also connected to an 'IRP Agent'. The bottom diagram shows an 'Old IRPManager' (NM) connected to a 'YyyIRP IRPVersion-old' (EM) which is also connected to an 'IRP Agent'.
239
+
240
+ **Figure 5.2: Specification BC System Context**
241
+
242
+ An YyyIRP instance supports a particular Interface IRPVersion and a particular set of NRM IRPVersions.
243
+
244
+ An IRPManager uses a particular Interface IRPVersion and a particular set of NRM IRPVersions.
245
+
246
+ If an YyyIRP instance supports Interface IRPVersion-X and NRM IRPVersions-Y, then it can interact successfully with an IRPManager that uses the same IRPVersions. This is illustrated by the case of the "Old IRPManager" and the "Old IRP Agent" of the bottom diagram (and note that the diagram does not show the NRM IRP version support).
247
+
248
+ If this same YyyIRP instance upgrades its Interface IRPVersion-X to X2 that is BC to X, then it can interact successfully with an IRPManager that uses the Interface IRPVersion-X or IRPVersion-X2. The top diagram of figure 5.2 illustrates this case (and note that the diagram does not show the NRM IRP version support).
249
+
250
+ If this same YyyIRP instance upgrades its NRM IRPVersion-Y to Y2 that is BC to Y, then it can interact successfully with an IRPManager that uses the NRM IRPVersion-Y or NRM IRPVersion-Y2. The top diagram of figure 5.2 illustrated this case (and note that the diagram does not show the NRM IRP version support).
251
+
252
+ Given the above, the BC issues addressed at the present document level are:
253
+
254
+ - How to determine if an IRP IS or SS specification (Interface IRP or NRM IRP) is BC to an earlier version ? This can be addressed in another way. What are the BC-rules that the author of a 3GPP IRP specification should use to extend an old-version to produce a new version that can claim BC (to that old-version) ?
255
+
256
+ At this level, the specification author shall define BC-rules for each of the following:
257
+
258
+ - Interface IRP- Requirements.
259
+ - Interface IRP IS.
260
+ - Interface IRP SS(s).
261
+ - NRM IRP requirements.
262
+ - NRM IRP IS.
263
+ - NRM IRP SS(s).
264
+ - Data Definition IRP IS.
265
+ - Data Definition IRP SS(s).
266
+
267
+ One reason why the specification author addresses BC at this IRP level is that, for certain technologies, such as CORBA, it is possible that one entity using (compiles with) one IRP SS specification (i.e. the CORBA SS) while the other communicating entity using a new but BC version can interact successfully (such as the case of the IRPManager and IRPAgent-A of [REC-1]).
268
+
269
+ ## 5.3 IRPAgent level
270
+
271
+ Figure 5.3 illustrates the two possible contexts when addressing BC at this IRPAgent level.
272
+
273
+ ![Figure 5.3: System/Implementation BC System Context. The diagram shows two contexts for BC at the IRPAgent level. The top context shows 'Old IRPManager' and 'New IRPManager' (both NM) connected via 'Itf-N' to a system containing 'YyyIRP IRPVersion-old' and 'YyyIRP IRPVersion-new' (both EM), each connected to an 'IRPAgent'. The bottom context shows 'Old IRPManager' (NM) connected via 'Itf-N' to a system containing 'YyyIRP IRPVersion-old' (EM) connected to an 'IRPAgent'.](367926125450c2bc3f4bdca9d59a62ba_img.jpg)
274
+
275
+ The diagram illustrates two system contexts for BC at the IRPAgent level, separated by a vertical dashed line labeled 'Itf-N'.
276
+
277
+ **Top Context:** On the left, two boxes labeled 'Old IRPManager' and 'New IRPManager' are shown, each with a label 'NM' below it. Both are connected to the 'Itf-N' interface. On the right, a large box labeled 'EM' contains two boxes: 'YyyIRP IRPVersion-old' and 'YyyIRP IRPVersion-new'. Each of these boxes is connected to an 'IRPAgent' box. The 'Old IRPManager' is connected to the 'YyyIRP IRPVersion-old' box, and the 'New IRPManager' is connected to the 'YyyIRP IRPVersion-new' box.
278
+
279
+ **Bottom Context:** On the left, a box labeled 'Old IRPManager' is shown with a label 'NM' below it, connected to the 'Itf-N' interface. On the right, a large box labeled 'EM' contains a box labeled 'YyyIRP IRPVersion-old', which is connected to an 'IRPAgent' box. The 'Old IRPManager' is connected to the 'YyyIRP IRPVersion-old' box.
280
+
281
+ Figure 5.3: System/Implementation BC System Context. The diagram shows two contexts for BC at the IRPAgent level. The top context shows 'Old IRPManager' and 'New IRPManager' (both NM) connected via 'Itf-N' to a system containing 'YyyIRP IRPVersion-old' and 'YyyIRP IRPVersion-new' (both EM), each connected to an 'IRPAgent'. The bottom context shows 'Old IRPManager' (NM) connected via 'Itf-N' to a system containing 'YyyIRP IRPVersion-old' (EM) connected to an 'IRPAgent'.
282
+
283
+ **Figure 5.3: System/Implementation BC System Context**
284
+
285
+ NOTE 1: An IRPAgent instance contains multiple YyyIRP instances such as AlarmIRP, NotificationIRP, TestManagementIRP, etc. Each YyyIRP instance implements/supports the corresponding YyyIRP specification of a particular IRPVersion.
286
+
287
+ Suppose IRPAgent-A contains YyyIRP of Interface IRPVersion-4, YyyIRP of Interface IRPVersion-5 and YyyIRP of Interface IRPVersion-6 and all IRPs support NRM IRPVersion-7 (see Note 2), this IRPAgent-A is BC if it can inter-operate successfully with the following:
288
+
289
+ - IRPManager 1 using Interface IRPVersion-4 or 3 using NRM IRPVersion-7 or 6.
290
+ - IRPManager 2 using Interface IRPVersion-5 or 4 using NRM IRPVersion-7 or 6.
291
+ - IRPManager 3 using Interface IRPVersion-6 or 5 using NRM IRPVersion-7 or 6.
292
+
293
+ NOTE 2: All IRPs contained by the same IRPAgent instance should support the same set of NRM IRPVersions.
294
+
295
+ It is anticipated that the IRPAgent level BC solution includes:
296
+
297
+ - An IRPAgent service allowing IRPManager to discover all the IRPAgent supported Interface IRPVersion(s).
298
+ - An IRPAgent service allowing IRPManager to discover the IRPAgent supported NRM IRPVersion(s).
299
+ - An IRPAgent service allowing IRPManager to discover the reference/address of the IRP instance (of the IRPAgent) supporting a particular Interface IRPVersion.
300
+
301
+ The two diagrams in figure 5.3 illustrate the two possible ways to support BC at this so-called IRPAgent level.
302
+
303
+ The IRPVersion-new needs not to be BC to IRPVersion-old. In the case that IRPVersion-new is BC to IRPVersion-old, it is EM supplier's choice if "IRP level" or "IRPAgent level" solution will be used to support BC. In the case that the IRPVersion-new is not BC to IRPVersion-old, then the EM supplier will have no choice but to use "IRPAgent level" solution if it wants its EM to support BC.
304
+
305
+ NOTE 3: IRPAgent service supporting "discovery" (as stated by the above three bullets) is not illustrated in the two diagrams
306
+
307
+ # --- 6 BC Recommendations
308
+
309
+ ## 6.1 Requirement
310
+
311
+ The Requirement specification is in subclause 4.2 Rules.
312
+
313
+ ## 6.2 IS-level
314
+
315
+ There is no text specifically written related to IS-level specification for BC systems. The two system context diagrams of subclauses 5.2 and 5.3 would be necessary and sufficient to describe the management services provided by EM to support the so-called Old IRPManager and New IRPManager.
316
+
317
+ ## 6.3 SS-level
318
+
319
+ ### 6.3.1 CORBA
320
+
321
+ For CORBA Solution Set, the IRPAgent level (see subclause 5.3) context would be used.
322
+
323
+ ### 6.3.2 Void
324
+
325
+ ### 6.3.3 File format description XML
326
+
327
+ *Editor's Note: This part is FFS.*
328
+
329
+ ### 6.3.4 File format description ASN.1
330
+
331
+ *Editor's Note: This part is FFS.*
332
+
333
+ ### 6.3.5 SOAP
334
+
335
+ *Editor's Note: This part is FFS.*
336
+
337
+ # Annex A (informative): BC and Conformance Tests
338
+
339
+ This annex illustrates that:
340
+
341
+ - an IRP, implementing a new-version IRP specification that is BC to an old-version IRP specification, may or may not be compliant to the old-version IRP specification.
342
+
343
+ ![Diagram illustrating the BC and Conformance Tests Scenario. It shows two vertical paths. The left path starts with 'Old-version IRP specification' at the top, which 'extends, based on BC-Rules' to the 'New-version IRP specification' at the top right. Below the old specification is 'Old-IRP', connected by a downward 'implement' arrow. Below 'Old-IRP' is 'Conformance tests', connected by a downward 'test (should be OK)' arrow. A 'depend' arrow points from 'Conformance tests' up to 'Old-version IRP specification'. The right path starts with 'New-version IRP specification' at the top, with 'New-IRP' below it (connected by a downward 'implement' arrow), and 'Conformance tests' below that (connected by a downward 'test (should be OK)' arrow). A 'depend' arrow points from 'Conformance tests' up to 'New-version IRP specification'. A diagonal arrow labeled 'test (should fail)' points from the 'Old-IRP' box to the 'New-IRP' box.](27b06ec9f42b5d727a2630f61a5f1861_img.jpg)
344
+
345
+ ```
346
+ graph TD; OVI[Old-version IRP specification] -- "extend, based on BC-Rules" --> NVI[New-version IRP specification]; OVI -- "implement" --> OIRP[Old-IRP]; OIRP -- "test (should be OK)" --> CT1[Conformance tests]; CT1 -- "depend" --> OVI; NVI -- "implement" --> NIRP[New-IRP]; NIRP -- "test (should be OK)" --> CT2[Conformance tests]; CT2 -- "depend" --> NVI; OIRP -- "test (should fail)" --> NIRP;
347
+ ```
348
+
349
+ Diagram illustrating the BC and Conformance Tests Scenario. It shows two vertical paths. The left path starts with 'Old-version IRP specification' at the top, which 'extends, based on BC-Rules' to the 'New-version IRP specification' at the top right. Below the old specification is 'Old-IRP', connected by a downward 'implement' arrow. Below 'Old-IRP' is 'Conformance tests', connected by a downward 'test (should be OK)' arrow. A 'depend' arrow points from 'Conformance tests' up to 'Old-version IRP specification'. The right path starts with 'New-version IRP specification' at the top, with 'New-IRP' below it (connected by a downward 'implement' arrow), and 'Conformance tests' below that (connected by a downward 'test (should be OK)' arrow). A 'depend' arrow points from 'Conformance tests' up to 'New-version IRP specification'. A diagonal arrow labeled 'test (should fail)' points from the 'Old-IRP' box to the 'New-IRP' box.
350
+
351
+ **Figure A.1: BC and Conformance Tests Scenario**
352
+
353
+ Suppose 3GPP has an older-version IRP specification (the "Old-version IRP specification" box) and there is a valid/correct implementation (the "Old-IRP" box).
354
+
355
+ Suppose also that 3GPP produce a "New-version IRP specification" by extending the "Old-version IRP specification" using the BC-rules.
356
+
357
+ The "New-IRP" should interwork with IRPManager that uses the "New-version IRP specification".
358
+
359
+ This "New-IRP" should also interwork with IRPManager that uses the "Old-version IRP specification".
360
+
361
+ The "Old-IRP" should pass the conformance test that is based on (see "depend" relation) the "Old-version IRP specification".
362
+
363
+ Likewise, the "New-IRP" should pass the conformance test that is based on the "New-version IRP specification".
364
+
365
+ However, this "New-IRP" may not be able to pass the conformance test that is based on "Old-version IRP specification" (see "test (should fail)" relation).
366
+
367
+ Likewise, the "Old-IRP" should not be able to pass the conformance test that is based on "New-Version IRP specification".
368
+
369
+ # --- Annex B (informative): Change history
370
+
371
+ | Change history | | | | | | | | |
372
+ |----------------|-------|-----------|-----|-----|----------------------------------------|---------|-------|--------|
373
+ | Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Ca<br>t | Old | New |
374
+ | Mar 2007 | SA_35 | SP-070065 | -- | -- | Submitted to TSG SA#35 for Information | -- | 1.0.0 | |
375
+ | Jun 2007 | SA_36 | SP-070283 | -- | -- | Submitted to TSG SA#36 for Approval | -- | 2.0.0 | 7.0.0 |
376
+ | Dec 2008 | SA_42 | -- | -- | -- | Upgrade to Release 8 | - | 7.0.0 | 8.0.0 |
377
+ | Dec 2009 | - | - | - | - | Update to Rel-9 version (MCC) | - | 8.0.0 | 9.0.0 |
378
+ | Mar 2010 | SA_47 | SP-100036 | 001 | -- | Introduction of SOAP SS | C | 9.0.0 | 10.0.0 |
379
+
marked/Rel-10/32_series/32155/raw.md ADDED
@@ -0,0 +1,187 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+ # Keywords GSM, UMTS, management 3GPP TS 32.155 V10.0.0 (2011-03)
4
+
5
+ *Technical Specification*
6
+
7
+ **3GPP**
8
+
9
+ ## Postal address: **3rd Generation Partnership Project;** **Technical Specification Group Services and System Aspects;** **Telecommunication management;** **Requirements**
10
+
11
+ 3GPP support office address
12
+ 650 Route des Lucioles - Sophia Antipolis
13
+ Valbonne - FRANCE
14
+ Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
15
+
16
+ Internet
17
+ <http://www.3gpp.org>
18
+
19
+ ![LTE logo with '4ADVANCED' text above the 'e'](0538daaa5583c23e17db3a12f2281a55_img.jpg)
20
+
21
+ LTE logo with '4ADVANCED' text above the 'e'
22
+
23
+ ![3GPP logo with a signal icon below the 'P'](4f4b52340aaccb1bcf733468dca9ee03_img.jpg)
24
+
25
+ 3GPP logo with a signal icon below the 'P'
26
+
27
+ ## **Copyright Notification**
28
+
29
+ No part may be reproduced except as authorized by written permission.
30
+ The copyright and the foregoing restriction extend to reproduction in all media.
31
+
32
+ © 2011, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TTA, TTC).
33
+ All rights reserved.
34
+
35
+ UMTS™ is a Trade Mark of ETSI registered for the benefit of its members
36
+
37
+ 3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
38
+
39
+ LTE™ is a Trade Mark of ETSI currently being registered for the benefit of its Members and of the 3GPP Organizational Partners
40
+
41
+ GSM® and the GSM logo are registered and owned by the GSM Association
42
+
43
+ The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP.
44
+
45
+ The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented.
46
+
47
+ This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification.
48
+
49
+ Specifications and reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices.
50
+
51
+ # --- Contents
52
+
53
+ | | |
54
+ |------------------------------------------------------------------------------------|---|
55
+ | Foreword ..... | 4 |
56
+ | Introduction ..... | 4 |
57
+ | 1 Scope..... | 5 |
58
+ | 2 References..... | 5 |
59
+ | 3 Definitions, abbreviations ..... | 5 |
60
+ | 3.1 Definitions..... | 5 |
61
+ | 3.2 Abbreviations ..... | 5 |
62
+ | 4 Requirements template..... | 6 |
63
+ | 4.1 Template for high-level Requirements TSs ..... | 6 |
64
+ | 4.2 Template for Integration Reference Point (IRP) specific Requirements TSs ..... | 6 |
65
+ | Annex A (informative): Change history..... | 8 |
66
+
67
+ # --- Foreword
68
+
69
+ This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP).
70
+
71
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
72
+
73
+ Version x.y.z
74
+
75
+ where:
76
+
77
+ - x the first digit:
78
+ - 1 presented to TSG for information;
79
+ - 2 presented to TSG for approval;
80
+ - 3 or greater indicates TSG approved document under change control.
81
+ - y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
82
+ - z the third digit is incremented when editorial only changes have been incorporated in the document.
83
+
84
+ # --- Introduction
85
+
86
+ The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below:
87
+
88
+ - TS 32.150: Integration Reference Point (IRP) Concept and definitions
89
+ - TS 32.151: Integration Reference Point (IRP) Information Service (IS) template
90
+ - TS 32.152: Integration Reference Point (IRP) Information Service (IS) Unified Modelling Language (UML) repertoire
91
+ - TS 32.153: Integration Reference Point (IRP) technology specific templates
92
+ - TS 32.154: Backward and Forward Compatibility (BFC); Concept and definitions
93
+ - TS 32.155: Requirements template**
94
+
95
+ # --- 1 Scope
96
+
97
+ The present document contains the template to be used for the production of all Requirements TSs for the 3GPP Telecommunication management.
98
+
99
+ This template is mainly based on the requirements template (mainly Annex A) in the ITU-T M.3020 recommendation [6].
100
+
101
+ # --- 2 References
102
+
103
+ The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
104
+
105
+ - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
106
+ - For a specific reference, subsequent revisions do not apply.
107
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
108
+
109
+ - [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications".
110
+ - [2] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements".
111
+ - [3] 3GPP TS 32.102: "Telecommunication management; Architecture".
112
+ - [4] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions".
113
+ - [5] 3GPP TS 32.151: "Telecommunication management; Integration Reference Point (IRP) Information Service (IS) template".
114
+ - [6] ITU-T Recommendation M.3020 (07/2007): Management interface specification methodology.
115
+ - [7] 3GPP TS 32.761: "E-UTRAN Network Resource Model (NRM) IRP; Requirements".
116
+ - [8] ITU-T Recommendation [M.3020 \(2009\) Amendment 1](#): Management interface specification methodology - Simplified requirements template.
117
+
118
+ # --- 3 Definitions, abbreviations
119
+
120
+ ## 3.1 Definitions
121
+
122
+ For the purposes of the present document, the terms and definitions given in TR 21.905 [1], TS 32.101 [2], TS 32.102 [3], TS 32.150 [4], TS 32.151[5] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TR 21.905 [1].
123
+
124
+ ## 3.2 Abbreviations
125
+
126
+ For the purposes of the present document, the abbreviations given in TR 21.905 [1], TS 32.101 [2], TS 32.102 [3], TS 32.150 [4] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1].
127
+
128
+ | | |
129
+ |-----|-----------------------------|
130
+ | IRP | Integration Reference Point |
131
+ | IS | Information Service |
132
+
133
+ # --- 4 Requirements template
134
+
135
+ This template is mainly based on the requirements template (mainly Annex A) in the ITU-T M.3020 recommendation [6], and shall be used for the production of all Requirements TSs for the 3GPP Telecommunication management. The template contains two options: Option 1 specified in subclause 4.1, which shall be used for all high-level Requirements TSs for the 3GPP Telecommunication management, and option 2 specified in subclause 4.2, which shall be used for all Integration Reference Point (IRP) specific Requirements TSs such as 3GPP TS 32.761 [7].
136
+
137
+ The clauses in this template that shall be used in the Requirements TS are numbered starting with "X", which shall correspond to clause 4 that is the beginning of the main part of the TS, followed by "Y" which shall correspond to clause 5 in the TS, and "Z" (for the full template) which shall correspond to clause 6 in the TS.
138
+
139
+ Instructions in *italics* below shall not be included in the Requirements TS.
140
+
141
+ The introductory clauses (from clause 1 to clause 3) for the Requirements TS should be taken from the 3GPP TS template (i.e. not this requirements template) – see [http://www.3gpp.org/ftp/Information/TS\\_TR\\_Templates/](http://www.3gpp.org/ftp/Information/TS_TR_Templates/).
142
+
143
+ Usage of fonts shall be according to the 3GPP TS template.
144
+
145
+ ## 4.1 Template for high-level Requirements TSs
146
+
147
+ ### --- X Concepts and background
148
+
149
+ *"X" represents clause number 4 in the actual Requirements TS.*
150
+
151
+ *For production of the contents of this clause, follow the instructions in M.3020 [6] subclause "A.2.1".*
152
+
153
+ ### --- Y Business level requirements
154
+
155
+ *"Y" represents clause number 5 in the actual Requirements TS. For production of the contents of this subclause, follow the instructions in M.3020 [6] subclause "A.2.2".*
156
+
157
+ ### --- Z Specification level requirements
158
+
159
+ *"Z" represents clause number 6 in the actual Requirements TS.*
160
+
161
+ *For production of the contents of this subclause, follow the instructions in M.3020 [6] subclause "A.2.3".*
162
+
163
+ ## 4.2 Template for Integration Reference Point (IRP) specific Requirements TSs
164
+
165
+ ### --- X Concepts and background
166
+
167
+ *"X" represents clause number 4 in the actual Requirements TS.*
168
+
169
+ *For production of the contents of this clause, follow the instructions in M.3020 Amendment 1 [8] subclause "A.3.1".*
170
+
171
+ ### --- Y Requirements
172
+
173
+ *"Y" represents clause number 5 in the actual Requirements TS. For production of the contents of this subclause, follow the instructions in M.3020 Amendment 1 [8] subclause "A.3.2".*
174
+
175
+ # --- Annex A (informative): Change history
176
+
177
+ | Change history | | | | | | | | |
178
+ |----------------|-------|-----------|------|-----|--------------------------------------------------------------|---------|-------|--------|
179
+ | Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Ca<br>t | Old | New |
180
+ | May 2007 | SA_36 | SP-070295 | -- | -- | Submitted to TSG SA#36 for Information | -- | 1.0.0 | |
181
+ | Sep 2007 | SA_37 | SP-070615 | -- | -- | Submitted to TSG SA#37 for Approval | -- | 2.0.0 | 8.0.0 |
182
+ | Jun 2008 | SA_40 | SP-080329 | 0001 | - | Correct the clause references to ITU-T Recommendation M.3020 | F | 8.0.0 | 8.1.0 |
183
+ | Dec 2008 | SA_42 | SP-080846 | 0002 | - | Simplified requirements template for IRPs | F | 8.1.0 | 8.2.0 |
184
+ | Mar 2009 | SA-43 | SP-090207 | 0003 | -- | Simplified requirements template for IRPs | F | 8.2.0 | 8.3.0 |
185
+ | Dec 2009 | - | - | - | - | Update to Rel-9 version (MCC) | - | 8.3.0 | 9.0.0 |
186
+ | Mar 2011 | - | - | - | - | Update to Rel-10 version (MCC) | - | 9.0.0 | 10.0.0 |
187
+
marked/Rel-10/32_series/32171/raw.md ADDED
@@ -0,0 +1,135 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+ # Keywords subscription management **3GPP TS 32.171 V10.0.0 (2011-03)**
4
+
5
+ *Technical Specification*
6
+
7
+ ## **3GPP** **3rd Generation Partnership Project;** Postal address **Technical Specification Group Services and System Aspects;** **Telecommunication management;** 3GPP support office address **Subscription Management (SuM) Network Resource Model** **(RM) Integration Reference Point (IRP)**
8
+
9
+ ![LTE logo with '4 ADVANCED' text above it.](64662465bba247703fdec49c8f3309f9_img.jpg)
10
+
11
+ LTE logo with '4 ADVANCED' text above it.
12
+
13
+ 650 Route des Lucioles (Sophia Antipolis)
14
+ Valbonne - FRANCE
15
+ Tel.: +33 (0) 93 654 20 45 Fax: +33 (0) 93 654 20 33 E-mail: info@3gpp.org
16
+
17
+ Internet
18
+ <http://www.3gpp.org>
19
+
20
+ ![3GPP logo with a signal icon.](0538daaa5583c23e17db3a12f2281a55_img.jpg)
21
+
22
+ 3GPP logo with a signal icon.
23
+
24
+ # ***Copyright Notification***
25
+
26
+ No part may be reproduced except as authorized by written permission.
27
+ The copyright and the foregoing restriction extend to reproduction in all media.
28
+
29
+ © 2011, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TTA, TTC).
30
+ All rights reserved.
31
+
32
+ UMTS™ is a Trade Mark of ETSI registered for the benefit of its members
33
+
34
+ 3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
35
+
36
+ LTE™ is a Trade Mark of ETSI currently being registered for the benefit of its Members and of the 3GPP Organizational Partners
37
+
38
+ GSM® and the GSM logo are registered and owned by the GSM Association
39
+
40
+ The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP.
41
+
42
+ The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented.
43
+
44
+ This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices.
45
+
46
+ # --- Contents
47
+
48
+ | | |
49
+ |--------------------------------------------|---|
50
+ | Foreword ..... | 4 |
51
+ | Introduction ..... | 4 |
52
+ | 1 Scope..... | 5 |
53
+ | 2 References..... | 5 |
54
+ | 3 Abbreviations ..... | 5 |
55
+ | 4 Requirements ..... | 5 |
56
+ | Annex A (informative): Change history..... | 6 |
57
+
58
+ # --- Foreword
59
+
60
+ This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP).
61
+
62
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
63
+
64
+ Version x.y.z
65
+
66
+ where:
67
+
68
+ - x the first digit:
69
+ - 1 presented to TSG for information;
70
+ - 2 presented to TSG for approval;
71
+ - 3 or greater indicates TSG approved document under change control.
72
+ - y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
73
+ - z the third digit is incremented when editorial only changes have been incorporated in the document.
74
+
75
+ # --- Introduction
76
+
77
+ Subscription Management is a feature that permits Service Providers, Value Added Service Providers and Mobile Operators to provision services for a specific subscriber. Subscription Management is an area of Service Operation Management that sets a complex challenge for Service Providers and Operators in their support of new or existing subscribers during their every day network operation.
78
+
79
+ The present document is part a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management, as identified below:
80
+
81
+ - TS 32.140: "Subscription Management (SuM) requirements".
82
+ - TS 32.141: "Subscription Management (SuM) architecture".
83
+ - TS 32.171: "Subscription Management (SuM) Network Resource Model (NRM) Integration Reference Point (IRP): Requirements".**
84
+ - TS 32.172: "Subscription Management (SuM) Network Resource Model (NRM) Integration Reference Point (IRP): Information Service (IS)".
85
+ - TS 32.176: "Subscription Management (SuM) Network Resource Model (NRM) Integration Reference Point (IRP): Solution Set (SS) definitions".
86
+
87
+ # --- 1 Scope
88
+
89
+ The present document defines, in addition to the requirements defined in [1], [2], [3] and [4], requirements for the present SuM NRM IRP.
90
+
91
+ # --- 2 References
92
+
93
+ The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
94
+
95
+ - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
96
+ - For a specific reference, subsequent revisions do not apply.
97
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
98
+
99
+ - [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements".
100
+ - [2] 3GPP TS 32.102: "Telecommunication management; Architecture".
101
+ - [3] 3GPP TS 32.140: "Telecommunication management; Subscription Management (SuM) requirements".
102
+ - [5] 3GPP TS 32.141: "Telecommunication management; Subscription Management (SuM) architecture".
103
+
104
+ # --- 3 Abbreviations
105
+
106
+ For the purposes of the present document, the following abbreviations apply:
107
+
108
+ | | |
109
+ |-----|-----------------------------|
110
+ | IRP | Integration Reference Point |
111
+ | NRM | Network Resources Model |
112
+ | SuM | Subscription Management |
113
+
114
+ # --- 4 Requirements
115
+
116
+ The following general and high-level requirements apply for the present IRP:
117
+
118
+ - a) IRP-related requirements in 3GPP TS 32.101 [1].
119
+ - b) IRP-related requirements in 3GPP TS 32.102 [2].
120
+ - c) IRP-related requirements in 3GPP TS 32.140 [3].
121
+ - d) IRP-related requirements in 3GPP TS 32.141 [4].
122
+
123
+ # --- Annex A (informative): Change history
124
+
125
+ | Change history | | | | | | | |
126
+ |----------------|-------|-----------|-----|-----|-----------------------------------------------------------------------------------------------------------------------------------------------|-------|--------|
127
+ | Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New |
128
+ | Dec 2003 | SA 22 | SP-030616 | -- | -- | Submitted to TSG SA#22 for Information | 1.0.0 | |
129
+ | Jun 2004 | SA 24 | SP-040238 | -- | -- | Submitted to TSG SA#24 for Approval | 2.0.0 | 6.0.0 |
130
+ | Dec 2004 | SA_26 | SP-040764 | 001 | -- | Editorial modifications to "Subscription Management (SuM)<br>Network Resource Model (NRM) Integration Reference Point (IRP):<br>Requirements" | 6.0.0 | 6.1.0 |
131
+ | Jun 2007 | SA 36 | -- | -- | -- | Automatic upgrade to Rel-7 (no CR) at freeze of Rel-7. | 6.1.0 | 7.0.0 |
132
+ | Dec 2008 | SA 42 | -- | -- | -- | Upgrade to Release 8 | 7.0.0 | 8.0.0 |
133
+ | Dec 2009 | - | - | - | - | Update to Rel-9 version (MCC) | 8.0.0 | 9.0.0 |
134
+ | Mar 2011 | - | - | - | - | Update to Rel-10 version (MCC) | 9.0.0 | 10.0.0 |
135
+
marked/Rel-10/32_series/32172/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
marked/Rel-10/32_series/32176/raw.md ADDED
@@ -0,0 +1,1856 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+ Keywords
4
+ UMTS, Management
5
+
6
+ # 3GPP TS 32.176 V10.3.0 (2011-03)
7
+
8
+ *Technical Specification*
9
+
10
+ **3rd Generation Partnership Project;**
11
+ **Technical Specification Group Services and System Aspects;**
12
+ **Telecommunication management;**
13
+ **Subscription Management (SuM)**
14
+ **Network Resource Model (NRM)**
15
+ **Integration Refere**
16
+ **Solution Set**
17
+
18
+ ![LTE logo with '4ADVANCED' text above the 'e' and a signal icon.](5fb340ad68b0c71df0b56698b137e35b_img.jpg)
19
+
20
+ LTE logo with '4ADVANCED' text above the 'e' and a signal icon.
21
+
22
+ Postal address
23
+ 3GPP support office address
24
+ 630 Route des Lucioles - Les Algorithmes
25
+ Valbonne - FRANCE
26
+ Tel.: +33 4 92 94 42 00 Fax: +33 4 92 94 47 10
27
+ Internet
28
+ <http://www.3gpp.org>
29
+
30
+ ![3GPP logo with a signal icon below the 'P'.](0538daaa5583c23e17db3a12f2281a55_img.jpg)
31
+
32
+ 3GPP logo with a signal icon below the 'P'.
33
+
34
+ # **Copyright Notification**
35
+
36
+ No part may be reproduced except as authorized by written permission.
37
+ The copyright and the foregoing restriction extend to reproduction in all media.
38
+
39
+ © 2011, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TTA, TTC).
40
+ All rights reserved.
41
+
42
+ UMTS™ is a Trade Mark of ETSI registered for the benefit of its members
43
+
44
+ 3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
45
+
46
+ LTE™ is a Trade Mark of ETSI currently being registered for the benefit of its Members and of the 3GPP Organizational Partners
47
+
48
+ GSM® and the GSM logo are registered and owned by the GSM Association
49
+
50
+ The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP.
51
+
52
+ The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented.
53
+
54
+ This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification.
55
+
56
+ Specifications and reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices.
57
+
58
+ # --- Contents
59
+
60
+ | | |
61
+ |----------------------------------------------------|----------|
62
+ | Foreword ..... | 4 |
63
+ | Introduction ..... | 4 |
64
+ | 1 Scope..... | 5 |
65
+ | 2 References..... | 5 |
66
+ | 3 Definitions and abbreviations ..... | 5 |
67
+ | 3.1 Definitions..... | 5 |
68
+ | 3.2 Abbreviations ..... | 6 |
69
+ | 4 Solution Set Definitions ..... | 6 |
70
+ | <b>Annex A (normative): XML Definitions.....</b> | <b>7</b> |
71
+ | A.1 Architectural features..... | 7 |
72
+ | A.1.1 Syntax for Distinguished Names..... | 7 |
73
+ | A.2 Mapping ..... | 7 |
74
+ | A.2.1 General mapping ..... | 7 |
75
+ | A.2.2 Information Object Class (IOC) mapping ..... | 7 |
76
+ | A.3 Solution Set definitions ..... | 8 |
77
+ | A.3.1 XML definition structure ..... | 8 |
78
+ | A.3.2 Graphical Representation..... | 8 |
79
+ | A.3.3 XML schema "sumNrm.xsd" ..... | 9 |
80
+ | Annex B (informative): Change history..... | 28 |
81
+
82
+ # --- Foreword
83
+
84
+ This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP).
85
+
86
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
87
+
88
+ Version x.y.z
89
+
90
+ where:
91
+
92
+ x the first digit:
93
+
94
+ - 1 presented to TSG for information;
95
+ - 2 presented to TSG for approval;
96
+ - 3 or greater indicates TSG approved document under change control.
97
+
98
+ y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
99
+
100
+ z the third digit is incremented when editorial only changes have been incorporated in the document.
101
+
102
+ # --- Introduction
103
+
104
+ The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below:
105
+
106
+ - TS 32.140: "Subscription Management (SuM) requirements".
107
+ - TS 32.141: "Subscription Management (SuM) architecture".
108
+ - TS 32.171: "Subscription Management (SuM) Network Resource Model (NRM) Integration Reference Point (IRP): Requirements ".
109
+ - TS 32.172: "Subscription Management (SuM) Network Resource Model (NRM) Integration Reference Point (IRP): Information Service (IS)".
110
+ - TS 32.176: "Subscription Management (SuM) Network Resource Model (NRM) Integration Reference Point (IRP): Solution Set (SS) definitions".**
111
+
112
+ Subscription Management (SuM) is a feature that permits Service Providers, Value Added Service Providers and Mobile Operators to provision services for a specific subscriber. The feature is necessary to allow Service Providers and Operators to provision, control, monitor, and bill the configuration of services that they offer to their subscribers. SuM focuses on the OAM processes to manage subscription information. The overall SuM requirements and architecture are detailed in 3GPP TS 32.140 [2] and 3GPP TS 32.141 [3].
113
+
114
+ The Itf-N interface for Subscription Management is built up by a number of Integration Reference Points (IRPs) and a related Name Convention, which realise the functional capabilities over this interface. The basic structure of the IRPs is defined in 3GPP TS 32.150 [1]. For SuM, a number of IRPs (and the Name Convention) are defined herein, used by this as well as other technical specifications for telecom management produced by 3GPP.
115
+
116
+ # --- 1 Scope
117
+
118
+ The present document is part of an Integration Reference Point (IRP) named Subscription Management (SuM) Network Resource Model (NRM) IRP, through which an `IRPAgent` can communicate configuration management information to one or several `IRPManagers` concerning SuM resources. The SuM NRM IRP comprises a set of specifications defining Requirements, a protocol neutral Information Service and one or more Solution Set(s).
119
+
120
+ The present document specifies the Solution Sets for the SuM NRM IRP.
121
+
122
+ This specification is related to 3GPP TS 32.172 [5] V10.2.X.
123
+
124
+ # --- 2 References
125
+
126
+ The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
127
+
128
+ - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
129
+ - For a specific reference, subsequent revisions do not apply.
130
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
131
+ - [1] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions".
132
+ - [2] 3GPP TS 32.140: "Telecommunication management; Subscription Management (SuM) requirements".
133
+ - [3] 3GPP TS 32.141: "Telecommunication management; Subscription Management (SuM) architecture".
134
+ - [4] 3GPP TS 32.171: "Telecommunication management; Subscription Management (SuM) resources Integration Reference Point (IRP); Requirements".
135
+ - [5] 3GPP TS 32.172: "Telecommunication management; Subscription Management Network Resource Model (NRM) Integration Reference Point (IRP): Information Service (IS)".
136
+ - [6] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements".
137
+ - [7] 3GPP TS 32.102: "Telecommunication management; Architecture".
138
+ - [8] 3GPP TS 32.616: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP): Solution Set (SS) definitions".
139
+ - [9] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects"
140
+
141
+ # --- 3 Definitions and abbreviations
142
+
143
+ ## 3.1 Definitions
144
+
145
+ For the purposes of the present document, the terms and definitions in 3GPP TS 32.101 [6], TS 32.102 [7], TS 32.140 [2], TS 32.141 [3], TS 32.171 [4] and TS 32.172 [5] apply.
146
+
147
+ ## 3.2 Abbreviations
148
+
149
+ For the purposes of the present document, the abbreviations in 3GPP TS 32.101 [6], TS 32.102 [7], TS 32.140 [2], TS 32.141 [3], TS 32.171 [4] and TS 32.172 [5] apply.
150
+
151
+ # --- 4 Solution Set Definitions
152
+
153
+ This specification defines the following 3GPP SuM NRM IRP Solution Set Definitions:
154
+
155
+ - 3GPP SuM NRM IRP XML Definitions (Annex A)
156
+
157
+ CORBA Solution Set is not supported.
158
+
159
+ # --- Annex A (normative): XML Definitions
160
+
161
+ This annex contains the XML Definitions for the SuM NRM IRP as it applies to Itf-N, in accordance with SuM NRM IRP Information Service (TS 32.172 [5])
162
+
163
+ ---
164
+
165
+ ## A.1 Architectural features
166
+
167
+ The overall architectural feature of Subscription Management (SuM) resources is specified in 3GPP TS 32.172 [5]. This clause specifies features that are specific to the Schema definitions.
168
+
169
+ ### A.1.1 Syntax for Distinguished Names
170
+
171
+ The syntax of a Distinguished Name is defined in 3GPP TS 32.300 [9].
172
+
173
+ ---
174
+
175
+ ## A.2 Mapping
176
+
177
+ ### A.2.1 General mapping
178
+
179
+ An IOC maps to an XML element of the same name as the IOC's name in the IS. An IOC attribute maps to a sub-element of the corresponding IOC's XML element, and the name of this sub-element is the same as the attribute's name in the IS.
180
+
181
+ ### A.2.2 Information Object Class (IOC) mapping
182
+
183
+ Not present in the current version of this specification.
184
+
185
+ ## --- A.3 Solution Set definitions
186
+
187
+ ### A.3.1 XML definition structure
188
+
189
+ The overall description of the file format of configuration data XML files is provided by 3GPP TS 32.616 [8].
190
+
191
+ Annex A.3.3 of the present document defines the NRM-specific XML schema `sumNrm.xsd` for the Subscription Management IRP NRM defined in 3GPP TS 32.172 [5].
192
+
193
+ XML schema `sumNrm.xsd` explicitly declares NRM-specific XML element types for the related NRM.
194
+
195
+ The definition of those NRM-specific XML element types complies with the generic mapping rules defined in 3GPP TS 32.616 [8].
196
+
197
+ ### A.3.2 Graphical Representation
198
+
199
+ Not present in the current version of this specification.
200
+
201
+ ### A.3.3 XML schema "sumNrm.xsd"
202
+
203
+ ```
204
+ <?xml version="1.0" encoding="UTF-8"?>
205
+
206
+ <!--
207
+ 3GPP TS 32.176 SuM Network Resources IRP
208
+ SuM NRM-specific XML schema
209
+ sumNrm.xsd
210
+ -->
211
+
212
+ <schema
213
+ targetNamespace=
214
+ "http://www.3gpp.org/ftp/specs/archive/32_series/32.176#sumNrm"
215
+ elementFormDefault="qualified"
216
+ xmlns="http://www.w3.org/2001/XMLSchema"
217
+ xmlns:sn=
218
+ "http://www.3gpp.org/ftp/specs/archive/32_series/32.176#sumNrm"
219
+ xmlns:xn=
220
+ "http://www.3gpp.org/ftp/specs/archive/32_series/32.626#genericNrm"
221
+ >
222
+
223
+ <import
224
+ namespace=
225
+ "http://www.3gpp.org/ftp/specs/archive/32_series/32.626#genericNrm"
226
+ />
227
+
228
+ <!-- SuM Network Resources IRP NRM class associated XML elements -->
229
+
230
+ <element
231
+ name="SubscriptionFunction"
232
+ substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"
233
+ >
234
+ <complexType>
235
+ <complexContent>
236
+ <extension base="xn:NrmClass">
237
+ <sequence>
238
+ <element name="attributes" minOccurs="0">
239
+ <complexType>
240
+ <all>
241
+ <element name="userLabel"/>
242
+ <element name="theUser" type="xn:dnList"/>
243
+ <element name="theSubscriberProfile" type="xn:dnList"/>
244
+ </all>
245
+ </complexType>
246
+ </element>
247
+ </sequence>
248
+ </extension>
249
+ </complexContent>
250
+ </complexType>
251
+ </element>
252
+ <element name="SuMSubscriberProfile" substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass">
253
+ <complexType>
254
+ <complexContent>
255
+ <extension base="xn:NrmClass">
256
+ <sequence>
257
+ <element name="attributes" minOccurs="0">
258
+ <complexType>
259
+ <all>
260
+ <element name="suMSubscriberProfileInfo"/>
261
+ <element name="theUser" type="xn:dnList"/>
262
+ <element name="theSubscribedService" type="xn:dnList"/>
263
+ <element name="theMobileUserData" type="xn:dnList"/>
264
+ </all>
265
+ </complexType>
266
+ </element>
267
+ </sequence>
268
+ </extension>
269
+ </complexContent>
270
+ </complexType>
271
+ </element>
272
+ <element name="MobileUserData" substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass">
273
+ <complexType>
274
+ <complexContent>
275
+ <extension base="xn:NrmClass">
276
+ <sequence>
277
+ <element name="attributes" minOccurs="0">
278
+ <complexType>
279
+ <all>
280
+ <element name="theServiceProfile" type="xn:dnList"/>
281
+ </all>
282
+ </complexType>
283
+ </element>
284
+ </sequence>
285
+ </extension>
286
+ </complexContent>
287
+ </complexType>
288
+ </element>
289
+ </schema>
290
+ ```
291
+
292
+ ```
293
+
294
+ <element name="iMSI" type="string"/>
295
+ <element name="mSISDN" type="string"/>
296
+ <element name="multinumberingMSISDNs" type="sn:multinumberingMSISDNList"/>
297
+ <element name="IMEISV" type="string" minOccurs="0"/>
298
+ </all>
299
+ </complexType>
300
+ </element>
301
+ </sequence>
302
+ </extension>
303
+ </complexContent>
304
+ </complexType>
305
+ </element>
306
+
307
+ <element name="SuMUser" substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass">
308
+ <complexType>
309
+ <complexContent>
310
+ <extension base="xn:NrmClass">
311
+ <sequence>
312
+ <element name="attributes" minOccurs="0">
313
+ <complexType>
314
+ <all>
315
+ <element name="theMobileUserData" type="xn:dnList"/>
316
+ <element name="theSubscriber" type="xn:dnList" minOccurs="0"/>
317
+ <element name="theCredentials" type="xn:dnList"/>
318
+ <element name="theServiceProfile" type="xn:dnList"/>
319
+ <element name="theIdentity" type="xn:dnList" minOccurs="0"/>
320
+ </all>
321
+ </complexType>
322
+ </element>
323
+ </sequence>
324
+ </extension>
325
+ </complexContent>
326
+ </complexType>
327
+ </element>
328
+
329
+ <element name="SuMCredentials" substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass">
330
+ <complexType>
331
+ <complexContent>
332
+ <extension base="xn:NrmClass">
333
+ <sequence>
334
+ <element name="attributes" minOccurs="0">
335
+ <complexType>
336
+ <all>
337
+ <element name="thePublicId" type="xn:dnList"/>
338
+ <element name="theServiceProfile" type="xn:dnList"/>
339
+ <element name="iMSPrivateUserIdentity" type="string"/>
340
+ </all>
341
+ </complexType>
342
+ </element>
343
+ </sequence>
344
+ </extension>
345
+ </complexContent>
346
+ </complexType>
347
+ </element>
348
+
349
+ <element name="SuMService" type="xn:NrmClass" abstract="true"
350
+ substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"/>
351
+
352
+ <element
353
+ name="CSService"
354
+ substitutionGroup="sn:SuMService"
355
+ >
356
+ <complexType>
357
+ <complexContent>
358
+ <extension base="xn:NrmClass">
359
+ <sequence>
360
+ <element name="attributes" minOccurs="0">
361
+ <complexType>
362
+ <all>
363
+ <element name="theContract" minOccurs="0"/>
364
+ <element name="networkAccessMode"/>
365
+ <element name="basicMSISDNIndicator" minOccurs="0"/>
366
+ <element name="mSISDNAlertIndicator" minOccurs="0"/>
367
+ <element name="subscriptionRestriction" minOccurs="0"/>
368
+ <element name="rSZIlists" minOccurs="0"/>
369
+ <element name="LSAIdentity" minOccurs="0"/>
370
+ <element name="LSAPriority" minOccurs="0"/>
371
+ <element name="LSAPreferentialAccessIndicator" minOccurs="0"/>
372
+ <element name="LSAActiveModeSupportIndicator" minOccurs="0"/>
373
+
374
+ ```
375
+
376
+ ```
377
+
378
+ <element name="lSAOnlyAccessIndicator" minOccurs="0"/>
379
+ <element name="lSAActiveModeIndicator" minOccurs="0"/>
380
+ <element name="vPLMNIdentifier" minOccurs="0"/>
381
+ <element name="accessRestrictionData" minOccurs="0"/>
382
+ <element name="privacyExceptionList" minOccurs="0"/>
383
+ <element name="gMLCNumbers" minOccurs="0"/>
384
+ <element name="mOLRList" minOccurs="0"/>
385
+ <element name="serviceTypes" minOccurs="0"/>
386
+ <element name="mobileStationCategory" minOccurs="0"/>
387
+ <element name="lMUIdentifier" minOccurs="0"/>
388
+ <element name="subscriberStatus" minOccurs="0"/>
389
+ <element name="gsmSCFaddresslistForODB"/>
390
+ <element name="provisionOfBearerService"/>
391
+ <element name="provisionOfTeleservice"/>
392
+ <element name="bCAllocation" minOccurs="0"/>
393
+ <element name="barringOfOutgoingCalls" minOccurs="0"/>
394
+ <element name="barringOfIncomingCalls" minOccurs="0"/>
395
+ <element name="barringOfRoaming" minOccurs="0"/>
396
+ <element name="barringOfPremiumRateCalls" minOccurs="0"/>
397
+ <element
398
+ name="barringOfSupplementaryServiceManagement"
399
+ minOccurs="0"
400
+ />
401
+ <element
402
+ name="barringOfRegistrationOfCallForwarding"
403
+ minOccurs="0"
404
+ />
405
+ <element
406
+ name="barringOfInvocationOfCallTransfer"
407
+ minOccurs="0"
408
+ />
409
+ <element
410
+ name="operatorDeterminedBarringPLMNSpecificData"
411
+ minOccurs="0"
412
+ />
413
+ <element name="vGCSGroupMembershipList" minOccurs="0"/>
414
+ <element name="vBSGroupMembershipList" minOccurs="0"/>
415
+ <element
416
+ name="broadcastCallInitiationAllowedList"
417
+ minOccurs="0"
418
+ />
419
+ <element
420
+ name="originatingCAMELSubscriptionInformationOCSI"
421
+ minOccurs="0"
422
+ />
423
+ <element
424
+ name="terminatingCAMELSubscriptionInformationTCSI"
425
+ minOccurs="0"
426
+ />
427
+ <element
428
+ name="vMSCTerminatingCAMELSubscriptionInformationVTCSCI"
429
+ minOccurs="0"
430
+ />
431
+ <element
432
+ name="locationInformationSubscriberStateInformation"
433
+ minOccurs="0"
434
+ />
435
+ <element
436
+ name="uSSDCAMELSubscriptionInformationUCSCI"
437
+ minOccurs="0"
438
+ />
439
+ <element name="sSInvocationNotificationSSCSI" minOccurs="0"/>
440
+ <element
441
+ name="translationInformationFlagTIFCSI"
442
+ minOccurs="0"
443
+ />
444
+ <element
445
+ name="dialledServiceCAMELSubscriptionInformationDCSCI"
446
+ minOccurs="0"
447
+ />
448
+ <element
449
+ name="uSSDGeneralCAMELServiceInformationUGCSI"
450
+ minOccurs="0"
451
+ />
452
+ <element
453
+ name="shortMessageServiceCAMELSubscriptionInformationMOSMSCSCI"
454
+ minOccurs="0"
455
+ />
456
+ <element
457
+ name="shortMessageServiceCAMELSubscriptionInformationMTSMSCSCI"
458
+
459
+ ```
460
+
461
+ ```
462
+
463
+ minOccurs="0"
464
+ />
465
+ <element
466
+ name="mTSMSCSIVLRNegotiatedCAMELCapabilityHandling"
467
+ minOccurs="0"
468
+ />
469
+ <element name="gsmSCFaddressforCSI" minOccurs="0"/>
470
+ <element name="iSTAlertTimer" minOccurs="0"/>
471
+ <element name="cSAllocationRetentionpriority" minOccurs="0"/>
472
+ <element name="iCSIndicator" minOccurs="0"/>
473
+ <element name="theCSSupplServiceForCS" type="xn:dnList"/>
474
+ </all>
475
+ </complexType>
476
+ </element>
477
+ </sequence>
478
+ </extension>
479
+ </complexContent>
480
+ </complexType>
481
+ </element>
482
+ <element name="SuMCSupplService"
483
+ substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass">
484
+ <complexType>
485
+ <complexContent>
486
+ <extension base="xn:NrmClass">
487
+ <sequence>
488
+ <element name="attributes" minOccurs="0">
489
+ <complexType>
490
+ <all>
491
+ <element name="sS-Code"/>
492
+ <element name="provisioningState"/>
493
+ <element name="activationState"/>
494
+ <element name="registrationState" minOccurs="0"/>
495
+ <element name="overrideCategory" minOccurs="0"/>
496
+ <element name="cLIRestrictionOption" minOccurs="0"/>
497
+ <element name="forwarded-toNumber" minOccurs="0"/>
498
+ <element name="forwarded-toSubaddress" minOccurs="0"/>
499
+ <element name="noReplyConditionTimer" minOccurs="0"/>
500
+ <element name="maximumEntitledPriority" minOccurs="0"/>
501
+ <element name="defaultPriority" minOccurs="0"/>
502
+ <element name="nbrUser" minOccurs="0"/>
503
+ <element name="nbrSB" minOccurs="0"/>
504
+ </all>
505
+ </complexType>
506
+ </element>
507
+ </sequence>
508
+ </extension>
509
+ </complexContent>
510
+ </complexType>
511
+ </element>
512
+
513
+ <element
514
+ name="GPRSService"
515
+ substitutionGroup="sn:SuMService"
516
+ >
517
+ <complexType>
518
+ <complexContent>
519
+ <extension base="xn:NrmClass">
520
+ <sequence>
521
+ <element name="attributes" minOccurs="0">
522
+ <complexType>
523
+ <all>
524
+ <element name="theContract" minOccurs="0"/>
525
+ <element name="networkAccessMode" minOccurs="0"/>
526
+ <element name="basicMSISDNIndicator" minOccurs="0"/>
527
+ <element name="mSISDNAlertIndicator" minOccurs="0"/>
528
+ <element name="rSZIlists" minOccurs="0"/>
529
+ <element name="lSAIdentity" minOccurs="0"/>
530
+ <element name="lSAPriority" minOccurs="0"/>
531
+ <element name="lSAPreferentialAccessIndicator" minOccurs="0"/>
532
+ <element name="lSAActiveModeSupportIndicator" minOccurs="0"/>
533
+ <element name="lSAOnlyAccessIndicator" minOccurs="0"/>
534
+ <element name="lSAActiveModeIndicator" minOccurs="0"/>
535
+ <element name="vPLMNIdentifier" minOccurs="0"/>
536
+ <element name="accessRestrictionData" minOccurs="0"/>
537
+ <element name="privacyExceptionList" minOccurs="0"/>
538
+ <element name="gMLCNumbers" minOccurs="0"/>
539
+ <element name="mOLRList" minOccurs="0"/>
540
+ <element name="serviceTypes" minOccurs="0"/>
541
+ <element name="gGSNNumber" minOccurs="0"/>
542
+ </all>
543
+ </complexType>
544
+ </element>
545
+ </sequence>
546
+ </extension>
547
+ </complexContent>
548
+ </complexType>
549
+ </element>
550
+
551
+ ```
552
+
553
+ ```
554
+
555
+ <element name="provisionOfTeleservice" minOccurs="0"/>
556
+ <element name="subscriberStatus" minOccurs="0"/>
557
+ <element name="transferOfSMoption" minOccurs="0"/>
558
+ <element
559
+ name="barringOfPacketOrientedServices"
560
+ minOccurs="0"
561
+ />
562
+ <element name="pDPType" minOccurs="0"/>
563
+ <element name="pDPAddress" minOccurs="0"/>
564
+ <element name="accessPointName" minOccurs="0"/>
565
+ <element name="vPLMNAddressAllowed" minOccurs="0"/>
566
+ <element name="qualityOfServiceSubscribed" minOccurs="0"/>
567
+ <element
568
+ name="pDPContextChargingCharacteristics"
569
+ minOccurs="0"
570
+ />
571
+ <element
572
+ name="gPRSCAMELSubscriptionInformationGPRSCSI"
573
+ minOccurs="0"
574
+ />
575
+ <element
576
+ name="mOShortMessageServiceCAMELSubscriptionInformationMOSMSCSI"
577
+ minOccurs="0"
578
+ />
579
+ <element
580
+ name="mTShortMessageServiceCAMELSubscriptionInformationMTMSCSI"
581
+ minOccurs="0"
582
+ />
583
+ <element
584
+ name="mOSMSCSISGSNNegotiatedCAMELCapabilityHandling"
585
+ minOccurs="0"
586
+ />
587
+ <element
588
+ name="mTSMSCSISGSNNegotiatedCAMELCapabilityHandling"
589
+ minOccurs="0"
590
+ />
591
+ <element
592
+ name="mobilityManagementforGPRSeventnotificationMGCSI"
593
+ minOccurs="0"
594
+ />
595
+ <element
596
+ name="mGCSINegotiatedCAMELCapabilityHandling"
597
+ minOccurs="0"
598
+ />
599
+ <element name="gsmSCFaddressforCSI" minOccurs="0"/>
600
+ <element
601
+ name="subscribedChargingCharacteristics"
602
+ minOccurs="0"
603
+ />
604
+ <element name="closedSubscriberGroupInformation" minOccurs="0"/>
605
+ <element name="gSMSCFaddresslistForODB" minOccurs="0"/>
606
+ <element name="barringOfOutgoingCalls" minOccurs="0"/>
607
+ <element name="barringOfRoaming" minOccurs="0"/>
608
+ <element name="operatorDeterminedBarringPLMNSpecificData" minOccurs="0"/>
609
+ <element name="sTNSR" minOccurs="0"/>
610
+ <element name="iCSIndicator" minOccurs="0"/>
611
+ <element
612
+ name="listOfauthorizedvisitednetworkidentifiers"
613
+ minOccurs="0"
614
+ />
615
+ <element name="wLANUERemoteIPaddress" minOccurs="0"/>
616
+ <element name="staticWLANUERemoteIPaddressList" minOccurs="0"/>
617
+ <element name="w-APNBarringTypeList" minOccurs="0"/>
618
+ <element name="w-APNChargingDataList" minOccurs="0"/>
619
+ <element name="accessDependenceFlag" minOccurs="0"/>
620
+ <element name="chargingCharacteristics" minOccurs="0"/>
621
+ <element name="primaryOCSChargingFunctionName" minOccurs="0"/>
622
+ <element
623
+ name="secondaryOCSChargingFunctionName"
624
+ minOccurs="0"
625
+ />
626
+ <element
627
+ name="primaryChargingCollectionFunctionName"
628
+ minOccurs="0"
629
+ />
630
+ <element
631
+ name="secondaryChargingCollectionFunctionName"
632
+ minOccurs="0"
633
+ />
634
+ <element name="w-APNIdentifierList" minOccurs="0"/>
635
+
636
+ ```
637
+
638
+ ```
639
+
640
+ <element name="maxNumberAccessesList" minOccurs="0"/>
641
+ <element name="subscribed3GPPWLANQoSProfile" minOccurs="0"/>
642
+ <element name="maxSubscribedBandwidth" minOccurs="0"/>
643
+ <element name="theGPRSSupplServiceForGPRS" type="xn:dnList"/>
644
+ </all>
645
+ </complexType>
646
+ </element>
647
+ </sequence>
648
+ </extension>
649
+ </complexContent>
650
+ </complexType>
651
+ </element>
652
+
653
+ <element name="SuMGPRSSupplService"
654
+ substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass">
655
+ <complexType>
656
+ <complexContent>
657
+ <extension base="xn:NrmClass">
658
+ <sequence>
659
+ <element name="attributes" minOccurs="0">
660
+ <complexType>
661
+ <all>
662
+ <element name="sS-Code" minOccurs="0"/>
663
+ <element name="provisioningState" minOccurs="0"/>
664
+ <element name="activationState" minOccurs="0"/>
665
+ </all>
666
+ </complexType>
667
+ </element>
668
+ </sequence>
669
+ </extension>
670
+ </complexContent>
671
+ </complexType>
672
+ </element>
673
+
674
+ <element name="EPSService" substitutionGroup="sn:SuMService">
675
+ <complexType>
676
+ <complexContent>
677
+ <extension base="xn:NrmClass">
678
+ <sequence>
679
+ <element name="attributes" minOccurs="0">
680
+ <complexType>
681
+ <all>
682
+ <element name="theContract" minOccurs="0"/>
683
+ <element name="accessPointName" minOccurs="0"/>
684
+ <element name="accessRestrictionData" minOccurs="0"/>
685
+ <element name="aPNAMBR" minOccurs="0"/>
686
+ <element name="barringOfPacketOrientedServices" minOccurs="0"/>
687
+ <element name="contextIdentifier" minOccurs="0"/>
688
+ <element name="operatorDeterminedBarringPLMNSpecificData" minOccurs="0"/>
689
+ <element name="pDNAddress" minOccurs="0"/>
690
+ <element name="rSZILists" minOccurs="0"/>
691
+ <element name="sTNSR" minOccurs="0"/>
692
+ <element name="subscribedChargingCharacteristics" minOccurs="0"/>
693
+ <element name="subscriberStatus" minOccurs="0"/>
694
+ <element name="networkAccessMode" minOccurs="0"/>
695
+ <element name="barringOfOutgoingCalls" minOccurs="0"/>
696
+ <element name="barringOfRoaming" minOccurs="0"/>
697
+ <element name="privacyExceptionList" minOccurs="0"/>
698
+ <element name="gMLCNumbers" minOccurs="0"/>
699
+ <element name="mOLRList" minOccurs="0"/>
700
+ <element name="serviceTypes" minOccurs="0"/>
701
+ <element name="iCSIndicator" minOccurs="0"/>
702
+ <element name="aPNOIReplacement" minOccurs="0"/>
703
+ <element name="subscribedUEAMBR" minOccurs="0"/>
704
+ <element name="aPNConfigurationProfile" minOccurs="0"/>
705
+ <element name="rFSP" minOccurs="0"/>
706
+ <element name="vPLMNAddressAllowed-EPS" minOccurs="0"/>
707
+ <element name="pDNGWIdentity" minOccurs="0"/>
708
+ <element name="ePSPDNConnectedChargingCharacteristics" minOccurs="0"/>
709
+ <element name="pDNGWAllocationType" minOccurs="0"/>
710
+ <element name="aPNLevelAPNOIReplacement" minOccurs="0"/>
711
+ <element name="closedSubscriberUserGroupInformation" minOccurs="0"/>
712
+ <element name="listOfAuthorizedvisitednetowrkidentifiers" minOccurs="0"/>
713
+ <element name="staticWLANUERemoteIPAddressList" minOccurs="0"/>
714
+ <element name="w-APONBarringTypeList" minOccurs="0"/>
715
+ <element name="w-APNChargingDataList" minOccurs="0"/>
716
+ <element name="wLANUERemoteIPAddress" minOccurs="0"/>
717
+ <element name="accessDependenceFlag" minOccurs="0"/>
718
+ <element name="chargingCharacteristics" minOccurs="0"/>
719
+ <element name="primaryOCSChargingFunctionName" minOccurs="0"/>
720
+ <element name="secondaryOCSChargingFunctionName" minOccurs="0"/>
721
+
722
+ ```
723
+
724
+ ```
725
+
726
+ <element name="primaryChargingCollectionFunctionName" minOccurs="0"/>
727
+ <element name="secondaryChargingCollectionFunctionName" minOccurs="0"/>
728
+ <element name="w-APNIdentifierList" minOccurs="0"/>
729
+ <element name="maxNumberAccessesList" minOccurs="0"/>
730
+ <element name="maxSubscribedBandwidth" minOccurs="0"/>
731
+ <element name="subscribed3GPPWLANQoSProfile" minOccurs="0"/>
732
+ <element name="permanentUserIdentity" minOccurs="0"/>
733
+ <element name="mIPSubscriberProfile" minOccurs="0"/>
734
+ </all>
735
+ </complexType>
736
+ </element>
737
+ </sequence>
738
+ </extension>
739
+ </complexContent>
740
+ </complexType>
741
+ </element>
742
+
743
+ <element
744
+ name="IMSService"
745
+ substitutionGroup="sn:SuMService"
746
+ >
747
+ <complexType>
748
+ <complexContent>
749
+ <extension base="xn:NrmClass">
750
+ <sequence>
751
+ <element name="attributes" minOccurs="0">
752
+ <complexType>
753
+ <all>
754
+ <element name="theContract" minOccurs="0"/>
755
+ <element
756
+ name="listofauthorizedvisitednetworkidentifiers"/>
757
+ <element name="registrationStatus"/>
758
+ <element name="sCSCFName" minOccurs="0"/>
759
+ <element name="diameterClientAddressofSCSCF" minOccurs="0"/>
760
+ <element name="theServerCapabilities" type="xn:dn" minOccurs="0"/>
761
+ <element
762
+ name="subscribedMediaProfileIdentifier"
763
+ minOccurs="0"
764
+ />
765
+ <element name="initialFilterCriteriaList" minOccurs="0">
766
+ <complexType>
767
+ <sequence>
768
+ <element name="initialFilterCriteria" minOccurs="1" maxOccurs="unbounded"/>
769
+ </sequence>
770
+ </complexType>
771
+ </element>
772
+ <element name="applicationServerInformation" minOccurs="0"/>
773
+ <element name="serviceIndicationList" minOccurs="0">
774
+ <complexType>
775
+ <sequence>
776
+ <element name="serviceIndication" minOccurs="1" maxOccurs="unbounded"/>
777
+ </sequence>
778
+ </complexType>
779
+ </element>
780
+
781
+ <element
782
+ name="primaryEventChargingFunctionName"
783
+ minOccurs="0"
784
+ />
785
+ <element
786
+ name="secondaryEventChargingFunctionName"
787
+ minOccurs="0"
788
+ />
789
+ <element name="primaryChargingCollectionFunctionName"/>
790
+ <element
791
+ name="secondaryChargingCollectionFunctionName"
792
+ minOccurs="0"
793
+ />
794
+ <element name="gsmSCFaddressforIMCSI" minOccurs="0"/>
795
+ <element name="oIMCSI" minOccurs="0"/>
796
+ <element name="vTIMCSI" minOccurs="0"/>
797
+ <element name="dIMCS" minOccurs="0"/>
798
+ <element name="gAAServiceType" minOccurs="0"/>
799
+ <element name="gAAServiceIdentifier" minOccurs="0"/>
800
+ <element name="gBAUserSecuritySettings" minOccurs="0"/>
801
+ <element name="userSecuritySetting" minOccurs="0"/>
802
+ <element name="userPublicIdentity" minOccurs="0"/>
803
+ <element name="gAAAuthorizationflag" minOccurs="0"/>
804
+ <element name="keyLifetime" minOccurs="0"/>
805
+ <element name="uICCSecurityType" minOccurs="0"/>
806
+ <element name="nAFGroupIdentity" minOccurs="0"/>
807
+
808
+ ```
809
+
810
+ ```
811
+
812
+ </all>
813
+ </complexType>
814
+ </element>
815
+ </sequence>
816
+ </extension>
817
+ </complexContent>
818
+ </complexType>
819
+ </element>
820
+
821
+ <element name="SuMSubscribedService"
822
+ substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" type="xn:NrmClass"
823
+ abstract="true"/>
824
+
825
+ <element
826
+ name="CSSubscribedService"
827
+ substitutionGroup="sn:SuMSubscribedService"
828
+ >
829
+ <complexType>
830
+ <complexContent>
831
+ <extension base="xn:NrmClass">
832
+ <sequence>
833
+ <element name="attributes" minOccurs="0">
834
+ <complexType>
835
+ <all>
836
+ <element name="theService" minOccurs="0"/>
837
+ <element name="theOffer" minOccurs="0"/>
838
+ <element name="networkAccessMode"/>
839
+ <element name="basicMSISDNIndicator" minOccurs="0"/>
840
+ <element name="mSISDNAlertIndicator" minOccurs="0"/>
841
+ <element name="subscriptionRestriction" minOccurs="0"/>
842
+ <element name="rSZIlists" minOccurs="0"/>
843
+ <element name="LSAIdentity" minOccurs="0"/>
844
+ <element name="LSAPriority" minOccurs="0"/>
845
+ <element name="LSAPreferentialAccessIndicator" minOccurs="0"/>
846
+ <element name="LSAActiveModeSupportIndicator" minOccurs="0"/>
847
+ <element name="LSAOnlyAccessIndicator" minOccurs="0"/>
848
+ <element name="LSAActiveModeIndicator" minOccurs="0"/>
849
+ <element name="vPLMNIdentifier" minOccurs="0"/>
850
+ <element name="accessRestrictionData" minOccurs="0"/>
851
+ <element name="privacyExceptionList" minOccurs="0"/>
852
+ <element name="gMLCNumbers" minOccurs="0"/>
853
+ <element name="mOLRList" minOccurs="0"/>
854
+ <element name="serviceTypes" minOccurs="0"/>
855
+ <element name="mobileStationCategory" minOccurs="0"/>
856
+ <element name="lMUIdentifier" minOccurs="0"/>
857
+ <element name="subscriberStatus" minOccurs="0"/>
858
+ <element name="gsmSCFaddresslistForODB"/>
859
+ <element name="provisionOfBearerService"/>
860
+ <element name="provisionOfTeleservice"/>
861
+ <element name="bCAllocation" minOccurs="0"/>
862
+ <element name="barringOfOutgoingCalls" minOccurs="0"/>
863
+ <element name="barringOfIncomingCalls" minOccurs="0"/>
864
+ <element name="barringOfRoaming" minOccurs="0"/>
865
+ <element name="barringOfPremiumRateCalls" minOccurs="0"/>
866
+ <element
867
+ name="barringOfSupplementaryServiceManagement"
868
+ minOccurs="0"
869
+ />
870
+ <element
871
+ name="barringOfRegistrationOfCallForwarding"
872
+ minOccurs="0"
873
+ />
874
+ <element
875
+ name="barringOfInvocationOfCallTransfer"
876
+ minOccurs="0"
877
+ />
878
+ <element
879
+ name="operatorDeterminedBarringPLMNsensitiveData"
880
+ minOccurs="0"
881
+ />
882
+ <element name="vGCSGroupMembershipList" minOccurs="0"/>
883
+ <element name="vBSGroupMembershipList" minOccurs="0"/>
884
+ <element
885
+ name="broadcastCallInitiationAllowedList"
886
+ minOccurs="0"
887
+ />
888
+ <element
889
+ name="originatingCAMELSubscriptionInformationOCSI"
890
+ minOccurs="0"
891
+ />
892
+
893
+ ```
894
+
895
+ ```
896
+
897
+ <element
898
+ name="terminatingCAMELSubscriptionInformationTCSI"
899
+ minOccurs="0"
900
+ />
901
+ <element
902
+ name="vMSCTerminatingCAMELSubscriptionInformationVTCSCI"
903
+ minOccurs="0"
904
+ />
905
+ <element
906
+ name="locationInformationSubscriberStateInformation"
907
+ minOccurs="0"
908
+ />
909
+ <element
910
+ name="uSSDCAMELSubscriptionInformationUCSCI"
911
+ minOccurs="0"
912
+ />
913
+ <element name="sSInvocationNotificationSSCSI" minOccurs="0"/>
914
+ <element
915
+ name="translationInformationFlagTIFCSI"
916
+ minOccurs="0"
917
+ />
918
+ <element
919
+ name="dialledServiceCAMELSubscriptionInformationDCSCI"
920
+ minOccurs="0"
921
+ />
922
+ <element
923
+ name="uSSDGeneralCAMELServiceInformationUGCSI"
924
+ minOccurs="0"
925
+ />
926
+ <element
927
+ name="shortMessageServiceCAMELSubscriptionInformationMOSMSCSCI"
928
+ minOccurs="0"
929
+ />
930
+ <element
931
+ name="shortMessageServiceCAMELSubscriptionInformationMTSMSCSCI"
932
+ minOccurs="0"
933
+ />
934
+ <element
935
+ name="mTSMSCSCIvLRNegotiatedCAMELCapabilityHandling"
936
+ minOccurs="0"
937
+ />
938
+ <element name="gsmSCFaddressforCSI" minOccurs="0"/>
939
+ <element name="iSTAlertTimer" minOccurs="0"/>
940
+ <element name="cSAllocationRetentionpriority" minOccurs="0"/>
941
+ <element name="iCSIIndicator" minOccurs="0"/>
942
+ <element name="theCSSupplServiceForCSSS" type="xn:dnList"/>
943
+ </all>
944
+ </complexType>
945
+ </element>
946
+ </sequence>
947
+ </extension>
948
+ </complexContent>
949
+ </complexType>
950
+ </element>
951
+
952
+ <element
953
+ name="GPRSSSubscribedService"
954
+ substitutionGroup="sn:SuMSUBscribedService"
955
+ >
956
+ <complexType>
957
+ <complexContent>
958
+ <extension base="xn:NrmClass">
959
+ <sequence>
960
+ <element name="attributes" minOccurs="0">
961
+ <complexType>
962
+ <all>
963
+ <element name="theService" minOccurs="0"/>
964
+ <element name="theOffer" minOccurs="0"/>
965
+ <element name="networkAccessMode" minOccurs="0"/>
966
+ <element name="basicMSISDNIndicator" minOccurs="0"/>
967
+ <element name="mSISDNAlertIndicator" minOccurs="0"/>
968
+ <element name="rSZIlists" minOccurs="0"/>
969
+ <element name="LSAIdentity" minOccurs="0"/>
970
+ <element name="LSAPriority" minOccurs="0"/>
971
+ <element name="LSAPreferentialAccessIndicator" minOccurs="0"/>
972
+ <element name="LSAActiveModeSupportIndicator" minOccurs="0"/>
973
+ <element name="LSAOnlyAccessIndicator" minOccurs="0"/>
974
+ <element name="LSAActiveModeIndicator" minOccurs="0"/>
975
+ <element name="vPLMNIdentifier" minOccurs="0"/>
976
+ <element name="accessRestrictionData" minOccurs="0"/>
977
+
978
+ ```
979
+
980
+ ```
981
+
982
+ <element name="privacyExceptionList" minOccurs="0"/>
983
+ <element name="gMLCNumbers" minOccurs="0"/>
984
+ <element name="mOLRList" minOccurs="0"/>
985
+ <element name="serviceTypes" minOccurs="0"/>
986
+ <element name="gGSNNumber" minOccurs="0"/>
987
+ <element name="provisionofTeleservice" minOccurs="0"/>
988
+ <element name="subscriberStatus" minOccurs="0"/>
989
+ <element name="transferofSOption" minOccurs="0"/>
990
+ <element
991
+ name="barringofPacketOrientedServices"
992
+ minOccurs="0"
993
+ />
994
+ <element name="pDPType" minOccurs="0"/>
995
+ <element name="pDPAddress" minOccurs="0"/>
996
+ <element name="accessPointName" minOccurs="0"/>
997
+ <element name="vPLMNAddressAllowed" minOccurs="0"/>
998
+ <element name="qualityofServiceSubscribed" minOccurs="0"/>
999
+ <element
1000
+ name="pDPContextChargingCharacteristics"
1001
+ minOccurs="0"
1002
+ />
1003
+ <element
1004
+ name="gPRSCAMELSubscriptionInformationGPRSCSI"
1005
+ minOccurs="0"
1006
+ />
1007
+ <element
1008
+ name="mOShortMessageServiceCAMELSubscriptionInformationMOSMSCSI"
1009
+ minOccurs="0"
1010
+ />
1011
+ <element
1012
+ name="mTShortMessageServiceCAMELSubscriptionInformationMTSMSCSI"
1013
+ minOccurs="0"
1014
+ />
1015
+ <element
1016
+ name="mOSMSCSISGSNNegotiatedCAMELCapabilityHandling"
1017
+ minOccurs="0"
1018
+ />
1019
+ <element
1020
+ name="mTSMSCSISGSNNegotiatedCAMELCapabilityHandling"
1021
+ minOccurs="0"
1022
+ />
1023
+ <element
1024
+ name="mobilityManagementforGPRSeventnotificationMGCSI"
1025
+ minOccurs="0"
1026
+ />
1027
+ <element
1028
+ name="mGCSINegotiatedCAMELCapabilityHandling"
1029
+ minOccurs="0"
1030
+ />
1031
+ <element name="gsmSCFaddressforCSI" minOccurs="0"/>
1032
+ <element name="closedSubscriberGroupInformation" minOccurs="0"/>
1033
+ <element name="gSMSCFaddresslistForODB" minOccurs="0"/>
1034
+ <element name="barringOfOutgoingCalls" minOccurs="0"/>
1035
+ <element name="barringOfRoaming" minOccurs="0"/>
1036
+ <element name="operatorDeterminedBarringPLMNspectificData" minOccurs="0"/>
1037
+ <element name="sTNSR" minOccurs="0"/>
1038
+ <element name="iCSIIndicator" minOccurs="0"/>
1039
+ <element
1040
+ name="subscribedChargingCharacteristics"
1041
+ minOccurs="0"
1042
+ />
1043
+ <element
1044
+ name="listofauthorizedvisitednetworkidentifiers"
1045
+ minOccurs="0"
1046
+ />
1047
+ <element name="wLANUERemoteIPaddress" minOccurs="0"/>
1048
+ <element name="staticWLANUERemoteIPaddressList" minOccurs="0"/>
1049
+ <element name="w-APNBarringTypeList" minOccurs="0"/>
1050
+ <element name="w-APNChargingDataList" minOccurs="0"/>
1051
+ <element name="accessDependenceFlag" minOccurs="0"/>
1052
+ <element name="chargingData" minOccurs="0"/>
1053
+ <element name="chargingCharacteristics" minOccurs="0"/>
1054
+ <element name="primaryOCSChargingFunctionName" minOccurs="0"/>
1055
+ <element name="secondaryOCSChargingFunctionName" minOccurs="0"/>
1056
+ <element name="w-APNIdentifierList" minOccurs="0"/>
1057
+ <element name="maxNumberAccessesList" minOccurs="0"/>
1058
+ <element name="maxSubscribedBandwidth" minOccurs="0"/>
1059
+ <element name="subscribed3GPPWLANQoSProfile" minOccurs="0"/>
1060
+ <element
1061
+ name="primaryChargingCollectionFunctionName"
1062
+
1063
+ ```
1064
+
1065
+ ```
1066
+
1067
+ minOccurs="0"
1068
+ />
1069
+ <element
1070
+ name="secondaryChargingCollectionFunctionName"
1071
+ minOccurs="0"
1072
+ />
1073
+ <element name="theGPRSSuppServiceForGPRSSS" type="xn:dnList"/>
1074
+ </all>
1075
+ </complexType>
1076
+ </element>
1077
+ </sequence>
1078
+ </extension>
1079
+ </complexContent>
1080
+ </complexType>
1081
+ </element>
1082
+
1083
+ <element name="EPSSubscribedService" substitutionGroup="sn:SuMSubscribedService">
1084
+ <complexType>
1085
+ <complexContent>
1086
+ <extension base="xn:NrmClass">
1087
+ <sequence>
1088
+ <element name="attributes" minOccurs="0">
1089
+ <complexType>
1090
+ <all>
1091
+ <element name="theService" minOccurs="0"/>
1092
+ <element name="theOffer" minOccurs="0"/>
1093
+ <element name="accessPointName" minOccurs="0"/>
1094
+ <element name="accessRestrictionData" minOccurs="0"/>
1095
+ <element name="aPNAMBR" minOccurs="0"/>
1096
+ <element name="barringOfPacketOrientedServices" minOccurs="0"/>
1097
+ <element name="contextIdentifier" minOccurs="0"/>
1098
+ <element name="operatorDeterminedBarringPLMNSpecificData" minOccurs="0"/>
1099
+ <element name="pDNAddress" minOccurs="0"/>
1100
+ <element name="rSZILists" minOccurs="0"/>
1101
+ <element name="sTNSR" minOccurs="0"/>
1102
+ <element name="subscribedChargingCharacteristics" minOccurs="0"/>
1103
+ <element name="subscriberStatus" minOccurs="0"/>
1104
+ <element name="networkAccessMode" minOccurs="0"/>
1105
+ <element name="barringOfOutgoingCalls" minOccurs="0"/>
1106
+ <element name="barringOfRoaming" minOccurs="0"/>
1107
+ <element name="privacyExceptionList" minOccurs="0"/>
1108
+ <element name="gMLCNumbers" minOccurs="0"/>
1109
+ <element name="mOLRList" minOccurs="0"/>
1110
+ <element name="serviceTypes" minOccurs="0"/>
1111
+ <element name="iCSIndicator" minOccurs="0"/>
1112
+ <element name="aPNOIReplacement" minOccurs="0"/>
1113
+ <element name="subscribedUEAMBR" minOccurs="0"/>
1114
+ <element name="aPNConfigurationProfile" minOccurs="0"/>
1115
+ <element name="rFSP" minOccurs="0"/>
1116
+ <element name="vPLMNAddressAllowed-EPS" minOccurs="0"/>
1117
+ <element name="pDNGWIdentity" minOccurs="0"/>
1118
+ <element name="ePSPDNConnectedChargingCharacteristics" minOccurs="0"/>
1119
+ <element name="pDNGWAllocationType" minOccurs="0"/>
1120
+ <element name="aPNLevelAPNOIReplacement" minOccurs="0"/>
1121
+ <element name="closedSubscriberUserGroupInformation" minOccurs="0"/>
1122
+ <element name="listOfAuthorizedvisitednetowrkidentifiers" minOccurs="0"/>
1123
+ <element name="staticWLANUERemoteIPAddressList" minOccurs="0"/>
1124
+ <element name="w-APONBarringTypeList" minOccurs="0"/>
1125
+ <element name="w-APNChargingDataList" minOccurs="0"/>
1126
+ <element name="wLANUERemoteIPAddress" minOccurs="0"/>
1127
+ <element name="accessDependenceFlag" minOccurs="0"/>
1128
+ <element name="chargingCharacteristics" minOccurs="0"/>
1129
+ <element name="primaryOCSChargingFunctionName" minOccurs="0"/>
1130
+ <element name="secondaryOCSChargingFunctionName" minOccurs="0"/>
1131
+ <element name="primaryChargingCollectionFunctionName" minOccurs="0"/>
1132
+ <element name="secondaryChargingCollectionFunctionName" minOccurs="0"/>
1133
+ <element name="w-APNIdentifierList" minOccurs="0"/>
1134
+ <element name="maxNumberAccessesList" minOccurs="0"/>
1135
+ <element name="maxSubscribedBandwidth" minOccurs="0"/>
1136
+ <element name="subscribed3GPPWLANQoSProfile" minOccurs="0"/>
1137
+ <element name="permanentUserIdentity" minOccurs="0"/>
1138
+ <element name="mIPSubscriberProfile" minOccurs="0"/>
1139
+ </all>
1140
+ </complexType>
1141
+ </element>
1142
+ </sequence>
1143
+ </extension>
1144
+ </complexContent>
1145
+ </complexType>
1146
+
1147
+ ```
1148
+
1149
+ ```
1150
+
1151
+ </element>
1152
+
1153
+ <element
1154
+ name="IMSSubscribedService"
1155
+ substitutionGroup="sn:SuMSubscribedService"
1156
+ >
1157
+ <complexType>
1158
+ <complexContent>
1159
+ <extension base="xn:NrmClass">
1160
+ <sequence>
1161
+ <element name="attributes" minOccurs="0">
1162
+ <complexType>
1163
+ <all>
1164
+ <element name="theService" minOccurs="0"/>
1165
+ <element name="theOffer" minOccurs="0"/>
1166
+ <element name="listofauthorizedvisitednetworkidentifiers"/>
1167
+ <element name="registrationStatus"/>
1168
+ <element name="sCSCFName" minOccurs="0"/>
1169
+ <element name="diameterClientAddressofSCSCF" minOccurs="0"/>
1170
+ <element name="theServerCapabilities" type="xn:dn" minOccurs="0"/>
1171
+ <element
1172
+ name="subscribedMediaProfileIdentifier"
1173
+ minOccurs="0"
1174
+ />
1175
+ <element name="initialFilterCriteriaList" minOccurs="0">
1176
+ <complexType>
1177
+ <sequence>
1178
+ <element name="initialFilterCriteria" minOccurs="1" maxOccurs="unbounded"/>
1179
+ </sequence>
1180
+ </complexType>
1181
+ </element>
1182
+ <element name="applicationServerInformation" minOccurs="0"/>
1183
+ <element name="serviceIndication" minOccurs="0">
1184
+ <complexType>
1185
+ <sequence>
1186
+ <element name="serviceIndication" minOccurs="1" maxOccurs="unbounded"/>
1187
+ </sequence>
1188
+ </complexType>
1189
+ </element>
1190
+ <element
1191
+ name="primaryEventChargingFunctionName"
1192
+ minOccurs="0"
1193
+ />
1194
+ <element
1195
+ name="secondaryEventChargingFunctionName"
1196
+ minOccurs="0"
1197
+ />
1198
+ <element name="primaryChargingCollectionFunctionName"/>
1199
+ <element
1200
+ name="secondaryChargingCollectionFunctionName"
1201
+ minOccurs="0"
1202
+ />
1203
+ <element name="gsmSCFaddressforIMCSI" minOccurs="0"/>
1204
+ <element name="oIMCSI" minOccurs="0"/>
1205
+ <element name="vTIMCSI" minOccurs="0"/>
1206
+ <element name="dIMCS" minOccurs="0"/>
1207
+ <element name="gAAServiceType" minOccurs="0"/>
1208
+ <element name="gAAServiceIdentifier" minOccurs="0"/>
1209
+ <element name="gBAUserSecuritySettings" minOccurs="0"/>
1210
+ <element name="userSecuritySetting" minOccurs="0"/>
1211
+ <element name="userPublicIdentity" minOccurs="0"/>
1212
+ <element name="gAAAuthorizationflag" minOccurs="0"/>
1213
+ <element name="keyLifetime" minOccurs="0"/>
1214
+ <element name="uICCSecurityType" minOccurs="0"/>
1215
+ <element name="nAFGroupIdentity" minOccurs="0"/>
1216
+ </all>
1217
+ </complexType>
1218
+ </element>
1219
+ </sequence>
1220
+ </extension>
1221
+ </complexContent>
1222
+ </complexType>
1223
+ </element>
1224
+
1225
+ <element name="SuMServiceProfile" substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass"
1226
+ type="xn:NrmClass" abstract="true"/>
1227
+
1228
+ <element
1229
+ name="CSServiceProfile"
1230
+
1231
+ ```
1232
+
1233
+ ```
1234
+
1235
+ substitutionGroup="sn:SuMServiceProfile"
1236
+ >
1237
+ <complexType>
1238
+ <complexContent>
1239
+ <extension base="sn:Common3GPPAccessServiceProfile">
1240
+ <sequence>
1241
+ <element name="attributes" minOccurs="0">
1242
+ <complexType>
1243
+ <all>
1244
+ <element name="theSpecification" minOccurs="0"/>
1245
+ <element name="basicMSISDNIndicator" minOccurs="0"/>
1246
+ <element name="mSISDNAlertIndicator" minOccurs="0"/>
1247
+ <element name="vLRNumber"/>
1248
+ <element name="mSCNumber"/>
1249
+ <element name="subscriptionRestriction" minOccurs="0"/>
1250
+ <element name="mSCAreaRestrictedFlag"/>
1251
+ <element name="oDBinducedBarringData" minOccurs="0"/>
1252
+ <element name="roamingRestrictionDueToUnsupportedFeature"/>
1253
+ <element name="lSAIdentity" minOccurs="0"/>
1254
+ <element name="lSAPriority" minOccurs="0"/>
1255
+ <element name="lSAPreferentialAccessIndicator" minOccurs="0"/>
1256
+ <element name="lSAActiveModeSupportIndicator" minOccurs="0"/>
1257
+ <element name="lSAOnlyAccessIndicator" minOccurs="0"/>
1258
+ <element name="lSAActiveModeIndicator" minOccurs="0"/>
1259
+ <element name="vPLMNIdentifier" minOccurs="0"/>
1260
+ <element name="ageIndicator" minOccurs="0"/>
1261
+ <element name="lMSI"/>
1262
+ <element name="mobileStationCategory"/>
1263
+ <element name="lMUIdentifier" minOccurs="0"/>
1264
+ <element name="mNRMSC"/>
1265
+ <element name="notificationToCSEFlagForODB" minOccurs="0"/>
1266
+ <element name="gsmSCFaddresslistForODB" minOccurs="0"/>
1267
+ <element name="messagesWaitingData" minOccurs="0"/>
1268
+ <element name="mobileStationNotReachableFlag" minOccurs="0"/>
1269
+ <element name="memoryCapacityExceededFlag"/>
1270
+ <element name="traceReference" minOccurs="0"/>
1271
+ <element name="traceType" minOccurs="0"/>
1272
+ <element name="operationsSystemsIdentity" minOccurs="0"/>
1273
+ <element name="hLRTraceType" minOccurs="0"/>
1274
+ <element name="mAPErrorOnTrace" minOccurs="0"/>
1275
+ <element name="traceActivatedInVLR" minOccurs="0"/>
1276
+ <element name="provisionOfBearerService"/>
1277
+ <element name="provisionOfTeleservice"/>
1278
+ <element name="bCAllocation" minOccurs="0"/>
1279
+ <element name="checkSSIndicator"/>
1280
+ <element name="mSPurgedForNonGPRSFlag"/>
1281
+ <element name="barringOfIncomingCalls" minOccurs="0"/>
1282
+ <element name="barringOfPremiumRateCalls" minOccurs="0"/>
1283
+ <element
1284
+ name="barringOfSupplementaryServiceManagement"
1285
+ minOccurs="0"
1286
+ />
1287
+ <element
1288
+ name="barringOfRegistrationOfCallForwarding"
1289
+ minOccurs="0"
1290
+ />
1291
+ <element
1292
+ name="barringOfInvocationOfCallTransfer"
1293
+ minOccurs="0"
1294
+ />
1295
+ <element name="vGCSGroupMembershipList" minOccurs="0"/>
1296
+ <element name="vBSGroupMembershipList" minOccurs="0"/>
1297
+ <element
1298
+ name="broadcastCallInitiationAllowedList"
1299
+ minOccurs="0"
1300
+ />
1301
+ <element
1302
+ name="originatingCAMELSubscriptionInformationOCSI"
1303
+ minOccurs="0"
1304
+ />
1305
+ <element
1306
+ name="terminatingCAMELSubscriptionInformationTCSI"
1307
+ minOccurs="0"
1308
+ />
1309
+ <element
1310
+ name="vMSCTerminatingCAMELSubscriptionInformationVTCI"
1311
+ minOccurs="0"
1312
+ />
1313
+ <element
1314
+ name="locationInformationSubscriberStateInformation"
1315
+ />
1316
+
1317
+ ```
1318
+
1319
+ ```
1320
+
1321
+ minOccurs="0"
1322
+ />
1323
+ <element
1324
+ name="uSSDCAMELSubscriptionInformationUCSI"
1325
+ minOccurs="0"
1326
+ />
1327
+ <element name="sSInvocationNotificationSSCSI" minOccurs="0"/>
1328
+ <element
1329
+ name="translationInformationFlagTIFCSI"
1330
+ minOccurs="0"
1331
+ />
1332
+ <element
1333
+ name="dialledServiceCAMELSubscriptionInformationDCSI"
1334
+ minOccurs="0"
1335
+ />
1336
+ <element
1337
+ name="uSSDGeneralCAMELServiceInformationUGCSI"
1338
+ minOccurs="0"
1339
+ />
1340
+ <element
1341
+ name="oCSINegotiatedCAMELCapabilityHandling"
1342
+ minOccurs="0"
1343
+ />
1344
+ <element
1345
+ name="sSCSINegotiatedCAMELCapabilityHandling"
1346
+ minOccurs="0"
1347
+ />
1348
+ <element
1349
+ name="vTCSINegotiatedCAMELCapabilityHandling"
1350
+ minOccurs="0"
1351
+ />
1352
+ <element
1353
+ name="shortMessageServiceCAMELSubscriptionInformationMOSMSCSI"
1354
+ minOccurs="0"
1355
+ />
1356
+ <element
1357
+ name="shortMessageServiceCAMELSubscriptionInformationMTSMSCSI"
1358
+ minOccurs="0"
1359
+ />
1360
+ <element
1361
+ name="mOSMSCSIVLRNegotiatedCAMELCapabilityHandling"
1362
+ minOccurs="0"
1363
+ />
1364
+ <element
1365
+ name="mTSMSCSIVLRNegotiatedCAMELCapabilityHandling"
1366
+ minOccurs="0"
1367
+ />
1368
+ <element
1369
+ name="mCSINegotiatedCAMELCapabilityHandling"
1370
+ minOccurs="0"
1371
+ />
1372
+ <element name="vLRSupportedCAMELPhases" minOccurs="0"/>
1373
+ <element name="gsmSCFaddressforCSI" minOccurs="0"/>
1374
+ <element name="vLROfferedCAMEL4CSIs" minOccurs="0"/>
1375
+ <element name="iSTAlertTimer" minOccurs="0"/>
1376
+ <element name="cSAllocationRetentionpriority" minOccurs="0"/>
1377
+ <element name="theCSSupplServiceForCSSP" type="xn:dnList"/>
1378
+ </all>
1379
+ </complexType>
1380
+ </element>
1381
+ </sequence>
1382
+ </extension>
1383
+ </complexContent>
1384
+ </complexType>
1385
+ </element>
1386
+
1387
+ <element
1388
+ name="GPRSServiceProfile"
1389
+ substitutionGroup="sn:SuMServiceProfile"
1390
+ >
1391
+ <complexType>
1392
+ <complexContent>
1393
+ <extension base="sn:PSCommonServiceProfile">
1394
+ <sequence>
1395
+ <element name="attributes" minOccurs="0">
1396
+ <complexType>
1397
+ <all>
1398
+ <element name="theSpecification" minOccurs="0"/>
1399
+ <element name="basicMSISDNIndicator" minOccurs="0"/>
1400
+ <element name="mSISDNAlertIndicator" minOccurs="0"/>
1401
+
1402
+ ```
1403
+
1404
+ ```
1405
+
1406
+ <element name="vLRNumber" minOccurs="0"/>
1407
+ <element name="LSAIdentity" minOccurs="0"/>
1408
+ <element name="LSAPriority" minOccurs="0"/>
1409
+ <element name="LSAPreferentialAccessIndicator" minOccurs="0"/>
1410
+ <element name="LSAActiveModeSupportIndicator" minOccurs="0"/>
1411
+ <element name="LSAOnlyAccessIndicator" minOccurs="0"/>
1412
+ <element name="LSAActiveModeIndicator" minOccurs="0"/>
1413
+ <element name="vPLMNIdentifier" minOccurs="0"/>
1414
+ <element name="ageIndicator" minOccurs="0"/>
1415
+ <element name="sGSNNumber" minOccurs="0"/>
1416
+ <element name="gGSNNumber" minOccurs="0"/>
1417
+ <element name="mNRC" minOccurs="0"/>
1418
+ <element name="provisionofTeleservice" minOccurs="0"/>
1419
+ <element name="transferofSMoption" minOccurs="0"/>
1420
+ <element name="mSpurgedforGPRSflag" minOccurs="0"/>
1421
+ <element name="pDPType" minOccurs="0"/>
1422
+ <element name="pDPAddress" minOccurs="0"/>
1423
+ <element name="vPLMNAddressAllowed" minOccurs="0"/>
1424
+ <element name="gGSNlist" minOccurs="0"/>
1425
+ <element name="qualityofServiceSubscribed" minOccurs="0"/>
1426
+ <element name="pDPContextIdentifier" minOccurs="0"/>
1427
+ <element
1428
+ name="pDPContextChargingCharacteristics"
1429
+ minOccurs="0"
1430
+ />
1431
+ <element
1432
+ name="gPRSCAMELSubscriptionInformationGPRSCSI"
1433
+ minOccurs="0"
1434
+ />
1435
+ <element
1436
+ name="mOShortMessageServiceCAMELSubscriptionInformationMOSMSCSI"
1437
+ minOccurs="0"
1438
+ />
1439
+ <element
1440
+ name="mTShortMessageServiceCAMELSubscriptionInformationMTSMSCSI"
1441
+ minOccurs="0"
1442
+ />
1443
+ <element
1444
+ name="mOSMSCSISGSNNegotiatedCAMELCapabilityHandling"
1445
+ minOccurs="0"
1446
+ />
1447
+ <element
1448
+ name="mTSMSCSISGSNNegotiatedCAMELCapabilityHandling"
1449
+ minOccurs="0"
1450
+ />
1451
+ <element
1452
+ name="mobilityManagementforGPRSeventnotificationMGCSI"
1453
+ minOccurs="0"
1454
+ />
1455
+ <element
1456
+ name="mGCSINegotiatedCAMELCapabilityHandling"
1457
+ minOccurs="0"
1458
+ />
1459
+ <element
1460
+ name="gPRSCSINegotiatedCAMELCapabilityHandling"
1461
+ minOccurs="0"
1462
+ />
1463
+ <element name="sGSNSupportedCAMELPhases" minOccurs="0"/>
1464
+ <element name="sGSNOfferedCAMEL4CSIs" minOccurs="0"/>
1465
+ <element name="gsmSCFaddressforCSI" minOccurs="0"/>
1466
+ <element name="gSMSCFaddresslistForODB" minOccurs="0"/>
1467
+ <element name="iPSMGWNumber" minOccurs="0"/>
1468
+ <element name="mNRR-SGSN" minOccurs="0"/>
1469
+ <element name="notificationToCSEFlagForODB" minOccurs="0"/>
1470
+ <element name="theGPRSSupplServiceForGPRSSP" type="xn:dnList"/>
1471
+ </all>
1472
+ </complexType>
1473
+ </element>
1474
+ </sequence>
1475
+ </extension>
1476
+ </complexContent>
1477
+ </complexType>
1478
+ </element>
1479
+ <element name="EPSServiceProfile" substitutionGroup="sn:SuMServiceProfile">
1480
+ <complexType>
1481
+ <complexContent>
1482
+ <extension base="sn:PSCommonServiceProfile">
1483
+ <sequence>
1484
+ <element name="attributes" minOccurs="0">
1485
+ <complexType>
1486
+
1487
+ ```
1488
+
1489
+ ```
1490
+
1491
+ <all>
1492
+ <element name="theSpecification" minOccurs="0"/>
1493
+ <element name="aPNAMBR" minOccurs="0"/>
1494
+ <element name="contextIdentifier" minOccurs="0"/>
1495
+ <element name="pDNAddress" minOccurs="0"/>
1496
+ <element name="aPNOIReplacement" minOccurs="0"/>
1497
+ <element name="subscribedUEAMBR" minOccurs="0"/>
1498
+ <element name="aPNConfigurationProfile" minOccurs="0"/>
1499
+ <element name="rFSP" minOccurs="0"/>
1500
+ <element name="pDNGWIdentity" minOccurs="0"/>
1501
+ <element name="ePSPDNConnectionChargingCharacteristics" minOccurs="0"/>
1502
+ <element name="pDNGWAllocationType" minOccurs="0"/>
1503
+ <element name="aPNLevelAPNOIReplacement" minOccurs="0"/>
1504
+ <element name="roamingRestrictionsDueToUnsupportedFeatureMME" minOccurs="0"/>
1505
+ <element name="roamingRestrictionsDueToUnsupportedFeatureSGSN" minOccurs="0"/>
1506
+ <element name="mSPurgedForEPSFlag" minOccurs="0"/>
1507
+ <element name="uRRPMME" minOccurs="0"/>
1508
+ <element name="mMEName" minOccurs="0"/>
1509
+ <element name="sGSNName" minOccurs="0"/>
1510
+ <element name="iWFNumber" minOccurs="0"/>
1511
+ <element name="sGSNAreaRestrictedFlag" minOccurs="0"/>
1512
+ <element name="permanentUserIdentity" minOccurs="0"/>
1513
+ <element name="vPLMNAddressAllowed-EPS" minOccurs="0"/>
1514
+ <element name="theOptHandover3GPP2Par" type="xn:dn"/>
1515
+ <element name="theNon3GPPAccessPar" type="xn:dn"/>
1516
+ </all>
1517
+ </complexType>
1518
+ </element>
1519
+ </sequence>
1520
+ </extension>
1521
+ </complexContent>
1522
+ </complexType>
1523
+ </element>
1524
+
1525
+ <element name="PSCommonServiceProfile" abstract="true" substitutionGroup="sn:SuMServiceProfile">
1526
+ <complexType>
1527
+ <complexContent>
1528
+ <extension base="sn:Common3GPPAccessServiceProfile">
1529
+ <sequence>
1530
+ <element name="attributes" minOccurs="0">
1531
+ <complexType>
1532
+ <all>
1533
+ <element name="roamingRestrictedintheSGSNduetounsupportedfeature" minOccurs="0"/>
1534
+ <element name="barringofPacketOrientedServices" minOccurs="0"/>
1535
+ <element name="traceActivatedinSGSN" minOccurs="0"/>
1536
+ <element name="iPAddressOfTraceCollectionEntity" minOccurs="0"/>
1537
+ <element name="accessPointName" minOccurs="0"/>
1538
+ <element name="subscribedChargingCharacteristics" minOccurs="0"/>
1539
+ <element name="sTNSR" minOccurs="0"/>
1540
+ <element name="closedSubscriberGroupInformation" minOccurs="0"/>
1541
+ <element name="theIWANPar" type="xn:dn" minOccurs="0"/>
1542
+ </all>
1543
+ </complexType>
1544
+ </element>
1545
+ </sequence>
1546
+ </extension>
1547
+ </complexContent>
1548
+ </complexType>
1549
+ </element>
1550
+
1551
+ <element name="Common3GPPAccessServiceProfile" abstract="true"
1552
+ substitutionGroup="sn:SuMServiceProfile">
1553
+ <complexType>
1554
+ <complexContent>
1555
+ <extension base="sn:SuMServiceProfile">
1556
+ <sequence>
1557
+ <element name="attributes" minOccurs="0">
1558
+ <complexType>
1559
+ <all>
1560
+ <element name="rSZILists" minOccurs="0"/>
1561
+ <element name="accessRestrictionData" minOccurs="0" />
1562
+ <element name="subscriberStatus" minOccurs="0"/>
1563
+ <element name="barringOfOutgoingCalls" minOccurs="0"/>
1564
+ <element name="barringOfRoaming" minOccurs="0"/>
1565
+ <element name="operatorDeterminedBarringPLMNSpecificData" minOccurs="0"/>
1566
+ <element name="traceReference2" minOccurs="0"/>
1567
+ <element name="traceDepth" minOccurs="0"/>
1568
+ <element name="listOfNETypesToTrace" minOccurs="0"/>
1569
+ <element name="triggeringEvents" minOccurs="0"/>
1570
+ <element name="listOfInterfacesToTrace" minOccurs="0"/>
1571
+ </all>
1572
+ </complexType>
1573
+ </element>
1574
+ </sequence>
1575
+ </extension>
1576
+ </complexContent>
1577
+ </complexType>
1578
+ </element>
1579
+
1580
+ ```
1581
+
1582
+ ```
1583
+
1584
+ <element name="privacyExceptionList" minOccurs="0"/>
1585
+ <element name="gMLCNumbers" minOccurs="0"/>
1586
+ <element name="iCSIndicator" minOccurs="0"/>
1587
+ <element name="mOLRList" minOccurs="0"/>
1588
+ <element name="serviceTypes" minOccurs="0"/>
1589
+ <element name="networkAccessMode" minOccurs="0"/>
1590
+ </all>
1591
+ </complexType>
1592
+ </element>
1593
+ </sequence>
1594
+ </extension>
1595
+ </complexContent>
1596
+ </complexType>
1597
+ </element>
1598
+
1599
+ <element name="IWANParameters" substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass">
1600
+ <complexType>
1601
+ <complexContent>
1602
+ <extension base="xn:NrmClass">
1603
+ <sequence>
1604
+ <element name="attributes" minOccurs="0">
1605
+ <complexType>
1606
+ <all>
1607
+ <element name="w-APN" minOccurs="0"/>
1608
+ <element name="listofauthorizedvisitednetworkidentifiers" minOccurs="0"/>
1609
+ <element name="threeGPPAAAServerName" minOccurs="0" />
1610
+ <element name="threeGPPAAProxyName" minOccurs="0"/>
1611
+ <element name="wLANUERemoteIPAddress" minOccurs="0"/>
1612
+ <element name="statisWLANUERemoteIPAddressList" minOccurs="0"/>
1613
+ <element name="w-APNBarringTypeList" minOccurs="0"/>
1614
+ <element name="w-APNChargingDataList" minOccurs="0"/>
1615
+ <element name="accessDependenceFlag" minOccurs="0"/>
1616
+ <element name="i-WLANAccessType" minOccurs="0"/>
1617
+ <element name="wLANIdentifierList" minOccurs="0"/>
1618
+ <element name="maxNumberAccessesList" minOccurs="0"/>
1619
+ <element name="maxSubscribedBandwidth" minOccurs="0"/>
1620
+ <element name="subscribed3GPPWLANQoSProfile" minOccurs="0"/>
1621
+ <element name="chargingCharacteristics" minOccurs="0"/>
1622
+ <element name="primaryOCSChargingFunctionName" minOccurs="0"/>
1623
+ <element name="secondaryOCSChargingFunctionName" minOccurs="0"/>
1624
+ <element name="primaryChargingCollectionFunctionName" minOccurs="0"/>
1625
+ <element name="secondaryChargingCollectionFunctionName" minOccurs="0"/>
1626
+ <element name="userStatus" minOccurs="0"/>
1627
+ </all>
1628
+ </complexType>
1629
+ </element>
1630
+ </sequence>
1631
+ </extension>
1632
+ </complexContent>
1633
+ </complexType>
1634
+ </element>
1635
+
1636
+ <element name="OptHandover3GPP2Parameters"
1637
+ substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass">
1638
+ <complexType>
1639
+ <complexContent>
1640
+ <extension base="xn:NrmClass">
1641
+ <sequence>
1642
+ <element name="attributes" minOccurs="0">
1643
+ <complexType>
1644
+ <all>
1645
+ <element name="rATType" minOccurs="0"/>
1646
+ </all>
1647
+ </complexType>
1648
+ </element>
1649
+ </sequence>
1650
+ </extension>
1651
+ </complexContent>
1652
+ </complexType>
1653
+ </element>
1654
+
1655
+ <element name="Non3GPPAccessParameters"
1656
+ substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass">
1657
+ <complexType>
1658
+ <complexContent>
1659
+ <extension base="xn:NrmClass">
1660
+ <sequence>
1661
+ <element name="attributes" minOccurs="0">
1662
+ <complexType>
1663
+
1664
+ ```
1665
+
1666
+ ```
1667
+
1668
+ <all>
1669
+ <element name="rATType" minOccurs="0"/>
1670
+ <element name="visitedNetworkIdentifier" minOccurs="0"/>
1671
+ <element name="mIPSSubscriberProfile" minOccurs="0"/>
1672
+ <element name="permanentUserIdentity" minOccurs="0"/>
1673
+ </all>
1674
+ </complexType>
1675
+ </element>
1676
+ </sequence>
1677
+ </extension>
1678
+ </complexContent>
1679
+ </complexType>
1680
+ </element>
1681
+
1682
+ <element
1683
+ name="IMSServiceProfile"
1684
+ substitutionGroup="sn:SuMServiceProfile"
1685
+ >
1686
+ <complexType>
1687
+ <complexContent>
1688
+ <extension base="xn:NrmClass">
1689
+ <sequence>
1690
+ <element name="attributes" minOccurs="0">
1691
+ <complexType>
1692
+ <all>
1693
+ <element name="theSpecification" minOccurs="0"/>
1694
+ <element name="listofauthorizedvisitednetworkidentifiers"/>
1695
+ <element name="registrationStatus"/>
1696
+ <element name="sCSCFName" minOccurs="0"/>
1697
+ <element name="diameterClientAddressofSCSCF" minOccurs="0"/>
1698
+ <element name="theServerCapabilities" type="xn:dn" minOccurs="0"/>
1699
+ <element
1700
+ name="subscribedMediaProfileIdentifier"
1701
+ minOccurs="0"
1702
+ />
1703
+ <element name="initialFilterCriteriaList" minOccurs="0">
1704
+ <complexType>
1705
+ <sequence>
1706
+ <element name="initialFilterCriteria" minOccurs="1" maxOccurs="unbounded"/>
1707
+ </sequence>
1708
+ </complexType>
1709
+ </element>
1710
+ <element name="applicationServerInformation" minOccurs="0"/>
1711
+ <element name="serviceIndicationList" minOccurs="0">
1712
+ <complexType>
1713
+ <sequence>
1714
+ <element name="serviceIndication" minOccurs="1" maxOccurs="unbounded"/>
1715
+ </sequence>
1716
+ </complexType>
1717
+ </element>
1718
+ <element
1719
+ name="primaryEventChargingFunctionName"
1720
+ minOccurs="0"
1721
+ />
1722
+ <element
1723
+ name="secondaryEventChargingFunctionName"
1724
+ minOccurs="0"
1725
+ />
1726
+ <element name="primaryChargingCollectionFunctionName"/>
1727
+ <element
1728
+ name="secondaryChargingCollectionFunctionName"
1729
+ minOccurs="0"
1730
+ />
1731
+ <element name="gsmSCFaddressforIMCSI" minOccurs="0"/>
1732
+ <element name="iMSSFaddressforIMCSI" minOccurs="0"/>
1733
+ <element name="oIMCSI" minOccurs="0"/>
1734
+ <element name="vTIMCSI" minOccurs="0"/>
1735
+ <element name="dIMCS" minOccurs="0"/>
1736
+ <element name="gAAServiceType" minOccurs="0"/>
1737
+ <element name="gAAServiceIdentifier" minOccurs="0"/>
1738
+ <element name="gBAUserSecuritySettings" minOccurs="0"/>
1739
+ <element name="userSecuritySetting" minOccurs="0"/>
1740
+ <element name="userPublicIdentity" minOccurs="0"/>
1741
+ <element name="gAAAuthorizationflag" minOccurs="0"/>
1742
+ <element name="keyLifetime" minOccurs="0"/>
1743
+ <element name="uICCSecurityType" minOccurs="0"/>
1744
+ <element name="nAFGroupIdentity" minOccurs="0"/>
1745
+ <element name="thePublicId" type="xn:dnList"/>
1746
+ </all>
1747
+ </complexType>
1748
+ </element>
1749
+
1750
+ ```
1751
+
1752
+ ```
1753
+
1754
+ </element>
1755
+ </sequence>
1756
+ </extension>
1757
+ </complexContent>
1758
+ </complexType>
1759
+ </element>
1760
+
1761
+ <complexType name="IMSPublicIdentificationType">
1762
+ <complexContent>
1763
+ <extension base="sn:SuMIdentityType">
1764
+ <all>
1765
+ <element name="publicUserIdentity" type="string" minOccurs="0"/>
1766
+ <element name="barringIndication" type="sn:binEnum" minOccurs="0"/>
1767
+ </all>
1768
+ </extension>
1769
+ </complexContent>
1770
+ </complexType>
1771
+
1772
+ <element name="IMSPublicIdentification" type="sn:IMSPublicIdentificationType"
1773
+ substitutionGroup="sn:SuMIdentity"/>
1774
+
1775
+ <simpleType name="binEnum">
1776
+ <restriction base="string">
1777
+ <enumeration value="FALSE"/>
1778
+ <enumeration value="TRUE"/>
1779
+ </restriction>
1780
+ </simpleType>
1781
+
1782
+ <simpleType name="multinumberingMSISDNIndicator">
1783
+ <restriction base="string">
1784
+ <enumeration value="BASIC"/>
1785
+ <enumeration value="ALERT"/>
1786
+ </restriction>
1787
+ </simpleType>
1788
+
1789
+ <complexType name="multinumberingMSISDNList">
1790
+ <sequence minOccurs="0" maxOccurs="unbounded">
1791
+ <element name="mSISDN" type="string"/>
1792
+ <element name="indicator" type="sn:multinumberingMSISDNIndicator"/>
1793
+ </sequence>
1794
+ </complexType>
1795
+
1796
+ <complexType name="ServerCapabilitiesType">
1797
+ <complexContent>
1798
+ <extension base="sn:SuMServiceParameterType">
1799
+ <all>
1800
+ <element name="serverCapabilities"/>
1801
+ </all>
1802
+ </extension>
1803
+ </complexContent>
1804
+ </complexType>
1805
+
1806
+ <element name="ServerCapabilities" type="sn:ServerCapabilitiesType"
1807
+ substitutionGroup="sn:SuMServiceParameter"/>
1808
+
1809
+ <complexType name="SuMIdentityType">
1810
+ <complexContent>
1811
+ <restriction base="xn:NrmClass"/>
1812
+ </complexContent>
1813
+ </complexType>
1814
+
1815
+ <complexType name="SuMServiceParameterType">
1816
+ <complexContent>
1817
+ <restriction base="xn:NrmClass"/>
1818
+ </complexContent>
1819
+ </complexType>
1820
+
1821
+ <element name="SuMIdentity" type="sn:SuMIdentityType"
1822
+ substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" abstract="true"/>
1823
+
1824
+ <element name="SuMServiceParameter" type="sn:SuMServiceParameterType"
1825
+ substitutionGroup="xn:SubNetworkOptionallyContainedNrmClass" abstract="true"/>
1826
+
1827
+ </schema>
1828
+
1829
+ ```
1830
+
1831
+ # Annex B (informative): Change history
1832
+
1833
+ | Change history | | | | | | | | |
1834
+ |----------------|-------|-----------|-----|-----|------------------------------------------------------------------------------------------------------------------------------------------------------|-----|--------|--------|
1835
+ | Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Cat | Old | New |
1836
+ | 05-2010 | SA-48 | SP-100270 | -- | -- | Presentation to SA for information and approval | -- | -- | 1.0.0 |
1837
+ | 06-2010 | SA-48 | -- | -- | -- | Publication | -- | 1.0.0 | 10.0.0 |
1838
+ | 09-2010 | SA-49 | SP-100489 | 001 | -- | Correct the support qualifier in XML definition to be aligned with IS | F | 10.0.0 | 10.1.0 |
1839
+ | 09-2010 | SA-49 | SP-100494 | 002 | -- | Modifications to Packet Access Service Parameters and Modeling | C | 10.0.0 | 10.1.0 |
1840
+ | 09-2010 | SA-49 | SP-100494 | 003 | -- | Aligning with the SuM NRM IRP IS - removing some SuM IOCs from Itf-N | C | 10.0.0 | 10.1.0 |
1841
+ | 12-2010 | SA-50 | SP-100833 | 004 | -- | Correcting the IOC PSSubscribedService name in XML definition - Align with 32.172 IS | F | 10.1.0 | 10.2.0 |
1842
+ | 12-2010 | SA-50 | SP-100755 | 006 | -- | Correcting faults in schema definition | F | 10.1.0 | 10.2.0 |
1843
+ | 12-2010 | SA-50 | SP-100755 | 007 | -- | Add the missing MobileUserData attribute in SuMSubscriberProfile - Align with 32.172 SuM NRM IS | F | 10.1.0 | 10.2.0 |
1844
+ | 03-2011 | SA-51 | SP-110104 | 008 | 1 | Improve Subscription Management (SuM) Network Resource Model (NRM) Integration Reference Point (IRP) access service modelling - Align with 32.172 IS | C | 10.2.0 | 10.3.0 |
1845
+
1846
+ Error! No
1847
+
1848
+ 28
1849
+
1850
+ Error! No text of specified style in
1851
+
1852
+ Error! No
1853
+
1854
+ 28
1855
+
1856
+ Error! No text of specified style in
marked/Rel-10/32_series/32181/raw.md ADDED
@@ -0,0 +1,637 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+
4
+
5
+
6
+
7
+
8
+
9
+ # Contents
10
+
11
+ | | |
12
+ |----------------------------------------------------------------------------|----|
13
+ | Introduction ..... | 5 |
14
+ | 1 Scope..... | 6 |
15
+ | 2 References..... | 6 |
16
+ | 3 Definitions and abbreviations ..... | 7 |
17
+ | 3.1 Definitions..... | 7 |
18
+ | 3.2 Abbreviations ..... | 7 |
19
+ | 4 UDC Framework overview..... | 8 |
20
+ | 4.1 General overview ..... | 8 |
21
+ | 4.2 Requirements coming from other Specifications ..... | 8 |
22
+ | 4.3 Overview of UDC Data and Information Models..... | 8 |
23
+ | 5 UDC information model infrastructure..... | 10 |
24
+ | 5.1 Common Baseline Information Model (CBIM)..... | 10 |
25
+ | 5.2 Application Information Models (AIM) ..... | 10 |
26
+ | 5.3 Specialised Information Model (SpIM) ..... | 11 |
27
+ | 6 UDC information model handling ..... | 11 |
28
+ | 6.1 General ..... | 11 |
29
+ | 6.2 Initial SpIM Creation from CBIM ..... | 13 |
30
+ | 6.3 AIM Integration into SpIM ..... | 13 |
31
+ | 6.4 Consolidation of User Data in the SpIM..... | 13 |
32
+ | 6.5.1 Example of consolidation of data in the SpIM using aggregation ..... | 13 |
33
+ | 6.5.2 Example of specialization for authentication methods..... | 14 |
34
+ | 6.5.3.1 AkaUsim..... | 15 |
35
+ | 6.5.3.1.1 Definition ..... | 15 |
36
+ | 6.5.3.2 CsAka..... | 15 |
37
+ | 6.5.3.2.1 Definition ..... | 15 |
38
+ | 6.5.3.3 GPRSAka..... | 15 |
39
+ | 6.5.3.3.1 Definition ..... | 15 |
40
+ | 6.5.3.4 EpsAka..... | 16 |
41
+ | 6.5.3.4.1 Definition ..... | 16 |
42
+ | 6.5.3.5 ImsAkaIsim..... | 16 |
43
+ | 6.5.3.5.1 Definition ..... | 16 |
44
+ | 6.5.3.6 ImsAka..... | 16 |
45
+ | 6.5.3.6.1 Definition ..... | 16 |
46
+ | 6.5.3.7 ImsAkaUsimIsim..... | 16 |
47
+ | 6.5.3.7.1 Definition ..... | 16 |
48
+ | 6.5.3.8 GPRSImdBundled..... | 16 |
49
+ | 6.5.3.8.1 Definition ..... | 16 |
50
+ | 6.5.3.9 NassImdBundled..... | 16 |
51
+ | 6.5.3.9.1 Definition ..... | 16 |
52
+ | 6.5.3.10 SipDigest..... | 17 |
53
+ | 6.5.3.10.1 Definition ..... | 17 |
54
+ | 6.5 Construction of AIM..... | 17 |
55
+ | 7 Application management ..... | 17 |
56
+ | 7.1 Application Access Control Data..... | 17 |
57
+ | 7.2 Application Data Model and Mapping to Consolidated Data Model..... | 17 |
58
+ | 7.2.1 Application Data Views ..... | 17 |
59
+ | 7.3 Subscription and Notification Related Data..... | 19 |
60
+ | 8 Consolidated data model management ..... | 20 |
61
+ | 8.1 Lifecycle Management of the Consolidated Data Model in the UDR ..... | 20 |
62
+ | 8.2 Activation and Deactivation of Application Adaptation..... | 21 |
63
+ | 9 Relation to other Information Models..... | 22 |
64
+ | 9.1 Relation to SuM Network Resource Model..... | 22 |
65
+
66
+ Annex A (informative): Change history.................................................................................................. 23
67
+
68
+ # Foreword
69
+
70
+ This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP).
71
+
72
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
73
+
74
+ Version x.y.z
75
+
76
+ where:
77
+
78
+ - x the first digit:
79
+ - 1 presented to TSG for information;
80
+ - 2 presented to TSG for approval;
81
+ - 3 or greater indicates TSG approved document under change control.
82
+ - y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
83
+ - z the third digit is incremented when editorial only changes have been incorporated in the document.
84
+
85
+ # --- Introduction
86
+
87
+ "The User Data Convergence concept supports a layered architecture, separating the data from the application logic in the 3GPP system, so that user data is stored in a logically unique repository allowing access from core and service layer entities, named application front-ends. Network elements and functionalities should be designed to access profile data remotely and without storing them permanently locally, i.e. the front-ends shall work in a user dataless configuration."
88
+
89
+ TR 22.985 and TS 22.101 provide the requirements for User data convergence so that user data can be moved from where it originated, to a facility called User Data Repository (UDR) where it can be accessed, stored and managed in a common way.
90
+
91
+ Convergence of user data unifies the user data access interface and its protocol. In addition, the logical centralization of user data implies the support of user data provisioning, that is, user data manipulation like creation, deletion, reading, modification and other operations.
92
+
93
+ In order to accommodate multiple applications and services, existing and new ones, a framework for model handling and management of the UDC has been developed including:
94
+
95
+ - UDC information model infrastructure
96
+ - UDC information model handling
97
+ - Application management
98
+ - Consolidated data model management.
99
+
100
+ # --- 1 Scope
101
+
102
+ The present document specifies the framework for overall management of the User Data Convergence.
103
+
104
+ In order to accommodate multiple applications and services, existing and new ones, the framework for model handling and management of the UDC as identified by TS 22.101 includes the following items:
105
+
106
+ - UDC information models:
107
+ - UDC information model infrastructure containing the common baseline information model (CBIM), application information models (AIM), and the specialised information model (SIM). The CBIM is standardised in TS 32.cde [4].
108
+ - UDC information model handling:
109
+ - provide a template and guidelines explaining the design of application information models to be used together with the common baseline information model to create the specialized information model
110
+ - describe the process to combine the common baseline information model with application information models in order to produce an operator-specific specialised information model
111
+ - Application management data:
112
+ - access control data for an application to UDC: identification and authentication
113
+ - assignment to an application data model, including linkage to the consolidated data model
114
+ - subscription rights for specific events on specific data of specific users
115
+ - Consolidated data model management
116
+ - lifecycle management of the consolidated data model in the UDR and in the provisioning entity.
117
+ - activation/deactivation of application adaptation
118
+
119
+ # --- 2 References
120
+
121
+ The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
122
+
123
+ - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
124
+ - For a specific reference, subsequent revisions do not apply.
125
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
126
+ - [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications".
127
+ - [2] 3GPP TR 22.985: "Service requirement for the User Data Convergence (UDC)".
128
+ - [3] 3GPP TS 22.101: "Service aspects; Service principles".
129
+ - [4] 3GPP TS 32.182: "User Data Convergence; Common Baseline Information Model ".
130
+ - [5] 3GPP TR 32.808: "Study of Common Profile Storage (CPS) Framework of User Data for network services and management"
131
+ - [6] 3GPP TS 33.102: "3G Security; Security architecture"
132
+ - [7] 3GPP TS 33.203: "3G security; Access security for IP-based services"
133
+
134
+ - [8] 3GPP TS 23.335: “User Data Convergence; Technical Realization and Information Flows;Stage 2“
135
+ - [9] 3GPP TS 29.335: “User Data Convergence (UDC); User Data Repository Access Protocol over the Ud interface; Stage 3”
136
+ - [10] 3GPP TS 32.172: “Subscription Management (SuM) Network Resource Model (NRM) Integration Reference Point (IRP): Information Service (IS)”
137
+
138
+ # --- 3 Definitions and abbreviations
139
+
140
+ ## 3.1 Definitions
141
+
142
+ For the purposes of the present document, the terms and definitions given in TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TR 21.905 [1].
143
+
144
+ **Application Data Model :** specific data model used by an application accessing the UDR. It is defined according to the UDC access protocol. It is related to an application information model.
145
+
146
+ **Application Data View:** a function of the UDR that enables and limits applications access to data within the UDR.
147
+
148
+ **Application Information Model :** specific information model used by an application accessing the UDR. It is defined with the same method as the common baseline information model. It is related to an application data model.
149
+
150
+ **Common Baseline Information Model:** basic structure of UDC IOCs, see also definition in 3GPP TS 32.182 [4]
151
+
152
+ **Consolidated Data Model:** Data model containing all data of the User Data Repository. It is the result of the implementation of the entire Specialized Information Model in the UDR for all applications.
153
+
154
+ **Information Model:** Information Model denotes an abstract, formal representation of entity types, including their properties and relationships, the operations (e.g. read, write...) that can be performed on them, and related rules and constraints. In the information model, entities might have network topology relationship with each other.
155
+
156
+ **Specialized Information Model:** Information model containing all information to be stored in the UDR. It is the result of operator specific specialisation of CBIM with addition of imported AIM.
157
+
158
+ ## 3.2 Abbreviations
159
+
160
+ For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1].
161
+
162
+ | | |
163
+ |------|--------------------------------------|
164
+ | ADM | Application Data Model |
165
+ | AIM | Application Information Model |
166
+ | AKA | Authentication and Key Agreement |
167
+ | AMF | Authentication Management Field |
168
+ | CBIM | Common baseline Information Model |
169
+ | CDM | Consolidated Data Model |
170
+ | ISIM | IMS Subscriber Identity Module |
171
+ | SpIM | Specialised Information Model |
172
+ | UDC | User Data Convergence |
173
+ | UDR | User Data Repository |
174
+ | UICC | Universal Integrated Circuit Card |
175
+ | USIM | Universal Subscriber Identity Module |
176
+
177
+ # --- 4 UDC Framework overview
178
+
179
+ ## 4.1 General overview
180
+
181
+ TR 22.985 [2] and TS 22.101[3] request the baseline information model to be future proof and extensible, i.e. new applications and/or new service profiles can be added by the operator, if necessary. The flexibility shall also permit new
182
+
183
+ data for existing applications to be introduced, or modified. For the actual information model of an operator Specialized Information Model is described in TR 22.985 [2].
184
+
185
+ For the above purpose this specification defines and describes the infrastructure of UDC Information Models in Clause 5.
186
+
187
+ The correlation and handling of the UDC Information Models is described in Clause 6.
188
+
189
+ ## 4.2 Requirements coming from other Specifications
190
+
191
+ TR 22.985 [2] and TS 22.101[3] provide requirements for CBIM and SpIM . These documents also mention the Application Data Models for the Access Interface to the UDC.
192
+
193
+ Specification 23.335 [8] in Clause 5.2 defines the requirements for application access to the UDR including authentication and authorisation.
194
+
195
+ Specification 29.335 [9]: defines as Access Protocol over the Ud interface LDAP (Clause 4) and as Data Model on the interface LDAP Directory Schema (Clause 7).
196
+
197
+ ## 4.3 Overview of UDC Data and Information Models
198
+
199
+ Figures Fig.4.3-1 and Fig.4.3-2 below show the data and information models contained in the UDC framework including the UDR and the Application Front Ends. Boxes outlined in black. connecting Information and Data Models represent the process steps needed to produce the output model (pointed to by an outgoing arrow) from an input model (shown by the source of an incoming arrow).As shown in these figures, the Specialized Information Model can be both an input and output model, i.e. its current version is used as an input model to a process that generates an enhanced version when an Application Information Model new to the UDR is integrated and consolidated.
200
+
201
+ Fig.4.3-1 below shows the case of internal integration model handling, where implementation of the Application is under responsibility of the operator . In this situation operator specification of the AIM leads to the Application Data Model (ADM), that gets implemented in the application FE and in the Application Data Model View in the UDR.
202
+
203
+ ![Figure 4.3-1: UDC Data and Information Models Overview with Operator integration model handling. The diagram illustrates the flow of information models from Common Baseline IM (CBIM) and App IM (AIM) through various processing steps to produce a Consolidated Data Model (CDM) and Information Elements. It is divided into three horizontal zones: Application/FE, Ud interface, and UDR. CBIM is customized to operator services to become a Specialized IM (SpIM). SpIM and AIM are integrated into SpIM and consolidated to generate ADM, mapping, and a new SpIM. This new SpIM is used to generate a new CDM, which becomes the Consolidated Data Model (CDM). The CDM is then used to generate Information Elements and Information procedures. The App IM (AIM) also leads to an App Data Model in the Application/FE. The Ud interface contains an App Data View, App Data Model, and App Data Model Mapping. The Adaptation zone contains the App Data Model and App Data Model Mapping. The UDR contains the Information Element and Information procedure.](65550960f5c5afd9d27706aaeddb0638_img.jpg)
204
+
205
+ ```
206
+
207
+ graph TD
208
+ subgraph Application/FE
209
+ AppIM[App IM (AIM)] --> AppDM[App Data Model]
210
+ end
211
+ subgraph Ud_interface [Ud interface]
212
+ AppDV[App Data View]
213
+ AppDM2[App Data Model]
214
+ AppDM3[App Data Model Mapping]
215
+ end
216
+ subgraph Adaptation
217
+ AppDM4[App Data Model]
218
+ AppDM5[App Data Model Mapping]
219
+ end
220
+ subgraph UDR
221
+ IE[Information Element]
222
+ IP[Information procedure]
223
+ end
224
+
225
+ CBIM[Common Baseline IM (CBIM)] --> Custom[Customise to Operator's Services]
226
+ Custom --> SpIM[Specialized IM (SpIM)]
227
+ SpIM --> Integrate[Integrate AIM into SpIM and consolidate]
228
+ Integrate --> NewSpIM[Generate new SpIM]
229
+ NewSpIM --> CDM[Consolidated Data Model (CDM)]
230
+ CDM --> IE
231
+ CDM --> IP
232
+
233
+ Integrate --> AppDM
234
+ Integrate --> AppDV
235
+ Integrate --> AppDM2
236
+ Integrate --> AppDM3
237
+ Integrate --> AppDM4
238
+ Integrate --> AppDM5
239
+
240
+ ```
241
+
242
+ Figure 4.3-1: UDC Data and Information Models Overview with Operator integration model handling. The diagram illustrates the flow of information models from Common Baseline IM (CBIM) and App IM (AIM) through various processing steps to produce a Consolidated Data Model (CDM) and Information Elements. It is divided into three horizontal zones: Application/FE, Ud interface, and UDR. CBIM is customized to operator services to become a Specialized IM (SpIM). SpIM and AIM are integrated into SpIM and consolidated to generate ADM, mapping, and a new SpIM. This new SpIM is used to generate a new CDM, which becomes the Consolidated Data Model (CDM). The CDM is then used to generate Information Elements and Information procedures. The App IM (AIM) also leads to an App Data Model in the Application/FE. The Ud interface contains an App Data View, App Data Model, and App Data Model Mapping. The Adaptation zone contains the App Data Model and App Data Model Mapping. The UDR contains the Information Element and Information procedure.
243
+
244
+ Figure 4.3-1 UDC Data and Information Models Overview with Operator integration model handling
245
+
246
+ Figure 4.3-2 below shows the case of generation of the Application Data Model (ADM) for an Application/Front-End when the development of the application is not the responsibility of the operator. In this situation, both the CBIM and the AIM of the application are used to generate the ADM being implemented in the Application/Front-End.
247
+
248
+ ![Figure 4.3-2: UDC Data and Information Models Overview with separate ADM generation for the Application/Front-End. The diagram illustrates the flow from Common Baseline IM (CBIM) and App IM (AIM) through various processing steps to generate the App Data Model for the Application/Front-End, while also contributing to the Consolidated Data Model (CDM) in the UDR.](daa4a6fa7e2ba1954258f86b4928eb32_img.jpg)
249
+
250
+ ```
251
+
252
+ graph TD
253
+ CBIM[Common Baseline IM (CBIM)] --> GADM[Generate ADM for Appl/FE]
254
+ CBIM --> COS[Customise to Operator's Services]
255
+ COS --> SpIM[Specialized IM (SpIM)]
256
+ SpIM --> GCDM[Generate new CDM]
257
+ GCDM --> CDM[Consolidated Data Model (CDM)]
258
+ CDM --> IE[Information Element]
259
+ CDM --> IP[Information procedure]
260
+ AIM[App IM (AIM)] --> GADM
261
+ AIM --> IA[Integrate AIM into SpIM and consolidate]
262
+ IA --> GADM
263
+ IA --> GCDM
264
+ IA --> ADVM[Generate ADM and mapping and new SpIM]
265
+ ADVM --> ADVM_SUB[App Data View | App Data Model | App Data Model Mapping]
266
+ ADVM_SUB --> IE
267
+ ADVM_SUB --> IP
268
+ subgraph Application/FE
269
+ GADM --> ADM[App Data Model]
270
+ end
271
+ subgraph Ud interface
272
+ end
273
+ subgraph Adaptation
274
+ end
275
+ subgraph UDR
276
+ CDM
277
+ ADVM_SUB
278
+ end
279
+
280
+ ```
281
+
282
+ Figure 4.3-2: UDC Data and Information Models Overview with separate ADM generation for the Application/Front-End. The diagram illustrates the flow from Common Baseline IM (CBIM) and App IM (AIM) through various processing steps to generate the App Data Model for the Application/Front-End, while also contributing to the Consolidated Data Model (CDM) in the UDR.
283
+
284
+ Figure 4.3-2 UDC Data and Information Models Overview with separate ADM generation for the Application/Front-End
285
+
286
+ # 5 UDC information model infrastructure
287
+
288
+ ## 5.1 Common Baseline Information Model (CBIM)
289
+
290
+ CBIM provides the basic structure of UDC IOCs. It shall enable an operator to integrate the user data to be stored in the UDR.
291
+
292
+ ## 5.2 Application Information Models (AIM)
293
+
294
+ NOTE: The present clause introduces AIM. AIM may be imported from existing applications or may be generated from information elements already existing in the UDR.
295
+
296
+ An AIM should contain IOCs for
297
+
298
+ - the Service Profile(s) of the particular application,
299
+ - Identifier(s) used by the application
300
+
301
+ and additionally, if needed, any other IOC defined in CBIM. E.g. related End Device, if such is to be connected to one or more identifiers within the application.
302
+
303
+ ## 5.3 Specialised Information Model (SpIM)
304
+
305
+ NOTE: The present clause describes building the SpIM from CBIM and AIMs with consolidation of semantically identical data.
306
+
307
+ SpIM is the Information model containing all information to be stored in the UDR. A Specialized Information Model is operator specific. An implementation of the entire Specialized Information Model in the User Data Repository for all the applications leads to the Consolidated Data Model.
308
+
309
+ # 6 UDC information model handling
310
+
311
+ ## 6.1 General
312
+
313
+ The relations of the UDC information models are depicted in Figure 6.1-1 below.
314
+
315
+ ![Diagram illustrating the UDC Information Models. The diagram shows two input models, 'Common Baseline IM (CBIM)' and 'Appl IM (AIM)', leading to two processing steps: 'Customise to Operator's Services' and 'Integrate AIM into SpIM and consolidate'. Both steps lead to the final output model, 'Specialized IM (SpIM)'.](7c6d9bfe9c31ce872722d60b73d20df1_img.jpg)
316
+
317
+ ```
318
+ graph TD; CBIM[Common Baseline IM (CBIM)] --> Customise[Customise to Operator's Services]; AIM[Appl IM (AIM)] --> Integrate[Integrate AIM into SpIM and consolidate]; Customise --> SpIM[Specialized IM (SpIM)]; Integrate --> SpIM;
319
+ ```
320
+
321
+ Diagram illustrating the UDC Information Models. The diagram shows two input models, 'Common Baseline IM (CBIM)' and 'Appl IM (AIM)', leading to two processing steps: 'Customise to Operator's Services' and 'Integrate AIM into SpIM and consolidate'. Both steps lead to the final output model, 'Specialized IM (SpIM)'.
322
+
323
+ Fig. 6.1-1 UDC Information Models
324
+
325
+ Figure 6.1-2 below shows the process that leads to integrating and consolidating data for a given operator from the UDR perspective.
326
+
327
+ Initially the Common Baseline Information Model (CBIM) is specialised according to the service and user structure of the given operator resulting in the initial version of the operator's the Specialized Information Model (SpIM).
328
+
329
+ The actual version of the operator's Specialized Information Model (SpIM) is combined together with one or more Application Information Models (AIMs) to form a new version of the Specialized Information Model (SpIM) of the operator. The SpIM represents and considers all the data of all converged services offered by the operator.
330
+
331
+ It is the decision of the operator, when a new actual version of the SpIM is implemented into the UDR. An implementation of the actual version of the SpIM into the UDR leads to the Consolidated Data Model (CDM), which is representing the actual implementation of the UDR.
332
+
333
+ ![Flowchart showing the hierarchy of information models: Common Baseline IM (CBIM) leads to Specialized IM (SpIM), which leads to Consolidated Data Model (CDM). Multiple Appl IM (AIM) boxes also point to the Consolidated Data Model (CDM).](27b06ec9f42b5d727a2630f61a5f1861_img.jpg)
334
+
335
+ ```
336
+ graph TD; CBIM[Common Baseline IM (CBIM)] --> SpIM[Specialized IM (SpIM)]; SpIM --> CDM[Consolidated Data Model (CDM)]; AIM1[Appl IM (AIM)] --> CDM; AIM2[Appl IM (AIM)] --> CDM; AIM3[Appl IM (AIM)] --> CDM; AIM4[Appl IM (AIM)] --> CDM; AIM5[Appl IM (AIM)] --> CDM; AIM6[Appl IM (AIM)] --> CDM; AIM7[Appl IM (AIM)] --> CDM;
337
+ ```
338
+
339
+ Flowchart showing the hierarchy of information models: Common Baseline IM (CBIM) leads to Specialized IM (SpIM), which leads to Consolidated Data Model (CDM). Multiple Appl IM (AIM) boxes also point to the Consolidated Data Model (CDM).
340
+
341
+ Figure 6.1-2: UDC Information and Data Models in the UDR
342
+
343
+ Consider now integration for a given application. An Application Data Model (ADM) has to be developed both for the UDR and for the Application/Front-End to be used on the Ud interface.
344
+
345
+ In the integrated model handling environment under responsibility of the operator implementation of the SpIM and the AIM of the application leads to the Application Data Model (ADM), this is depicted in Figure 6.1-3. The ADM gets implemented in the application FE and in the Application Data Model View in the UDR.
346
+
347
+ ![Flowchart showing the integration of information models: Common Baseline IM (CBIM) leads to Specialized IM (SpIM), which leads to Application Data Model (ADM). Appl IM (AIM) also leads to Application Data Model (ADM).](853f59c89931a666c07903b31d098277_img.jpg)
348
+
349
+ ```
350
+ graph TD; CBIM[Common Baseline IM (CBIM)] --> SpIM[Specialized IM (SpIM)]; SpIM --> ADM[Application Data Model (ADM)]; AIM[Appl IM (AIM)] --> ADM;
351
+ ```
352
+
353
+ Flowchart showing the integration of information models: Common Baseline IM (CBIM) leads to Specialized IM (SpIM), which leads to Application Data Model (ADM). Appl IM (AIM) also leads to Application Data Model (ADM).
354
+
355
+ Figure 6.1-3: UDC Information and Data Model handling for an Application Type in an integrated Operator environment
356
+
357
+ In the case of separate development of the Application Data Model (ADM) for an application on the Application/Front-End side, implementation of the CBIM and the AIM of the application leads to the ADM being implemented there. This is depicted in Figure 6.1-4.
358
+
359
+ ![Diagram showing the relationship between Common Baseline IM (CBIM), Appl IM (AIM), and Application Data Model (ADM).](cab0834804fb031b43865554cc8d06ab_img.jpg)
360
+
361
+ ```
362
+ graph TD; CBIM[Common Baseline IM (CBIM)] --> ADM[Application Data Model (ADM)]; AIM[Appl IM (AIM)] --> ADM;
363
+ ```
364
+
365
+ The diagram illustrates two input boxes at the top, 'Common Baseline IM (CBIM)' on the left and 'Appl IM (AIM)' on the right. Both boxes have blue outlines and blue text. Arrows point from each of these boxes down to a single, larger box at the bottom labeled 'Application Data Model (ADM)'. This bottom box also has a blue outline and blue text.
366
+
367
+ Diagram showing the relationship between Common Baseline IM (CBIM), Appl IM (AIM), and Application Data Model (ADM).
368
+
369
+ **Figure 6.1-4: Separate Information and Data Model handling for an Application Type for Application Front-End**
370
+
371
+ ## 6.2 Initial SpIM Creation from CBIM
372
+
373
+ The Specialized Information Model is initially generated through operator specific specialisation of CBIM e.g. through definition of the operator-specific End-User groupings.
374
+
375
+ ## 6.3 AIM Integration into SpIM
376
+
377
+ After the initial SpIM has been created, AIMs are imported and consolidated into it. The SpIM takes into account the specific applications, the functionality included and the relevant business information.
378
+
379
+ ## 6.4 Consolidation of User Data in the SpIM
380
+
381
+ ### 6.5.1 Example of consolidation of data in the SpIM using aggregation
382
+
383
+ The Figure 6.5.1-1 below provides an example of building the SpIM by aggregating semantically identical data. Attributes that are common to at least two different service profiles are defined in IOCs that are then aggregated to these service profiles. For example, the Roaming1 IOC contains roaming data that is common to GPRS, EPS and CS service profiles, ODB3 contains operator determined barring data that is common to both GPRS and EPS service profiles and Trace contains data that is about subscriber and equipment trace common to all GPRS, CS, EPS and IMS profiles. Using aggregation means that the attribute value will be always same in each of the service profile that has aggregated the IOC where the attribute is defined. Note also that this example only shows how a portion of the data can be consolidated using aggregation.
384
+
385
+ ![UML Class Diagram showing aggregation relationships between Roaming classes and Service Profiles, and further down to BasicService, Trace, and ODB classes.](a33da0f14e456f92539ce3e9b7d81f9a_img.jpg)
386
+
387
+ The diagram illustrates a hierarchy of Information Object Classes (IOCs) using aggregation relationships, represented by lines with open diamond symbols. At the top level, three classes are shown: <<InformationObjectClass>> Roaming1, <<InformationObjectClass>> Roaming2, and <<InformationObjectClass>> Roaming3. Roaming1 and Roaming2 both aggregate <<InformationObjectClass>> UdcCsServiceProfile and <<InformationObjectClass>> UdcGprsServiceProfile. Roaming3 aggregates <<InformationObjectClass>> UdcEpsServiceProfile and <<InformationObjectClass>> UdcImssServiceProfile. Below these, <<InformationObjectClass>> UdcCsServiceProfile and <<InformationObjectClass>> UdcGprsServiceProfile both aggregate <<InformationObjectClass>> BasicService, <<InformationObjectClass>> Trace, and <<InformationObjectClass>> ODB1. <<InformationObjectClass>> UdcEpsServiceProfile aggregates <<InformationObjectClass>> Trace and <<InformationObjectClass>> ODB3. <<InformationObjectClass>> UdcImssServiceProfile also aggregates <<InformationObjectClass>> ODB3. At the bottom, <<InformationObjectClass>> BasicService, <<InformationObjectClass>> Trace, and <<InformationObjectClass>> ODB1 all aggregate <<InformationObjectClass>> ODB2. Additionally, <<InformationObjectClass>> ODB1 and <<InformationObjectClass>> ODB2 both aggregate <<InformationObjectClass>> ODB3.
388
+
389
+ UML Class Diagram showing aggregation relationships between Roaming classes and Service Profiles, and further down to BasicService, Trace, and ODB classes.
390
+
391
+ Figure 6.5.1-1: Consolidation of data in the SpIM using aggregation.
392
+
393
+ ### 6.5.2 Example of specialization for authentication methods
394
+
395
+ Figure 6.5.2-1 shows an example of how the CBIM can be further specialized for the purpose of considering different authentication methods.
396
+
397
+ ![UML Class Diagram showing authentication methods and their relationships. Classes include UdcCsServiceProfile, UdcGprsServiceProfile, UdcEpsServiceProfile, UdcImsServiceProfile, CsAka, GprsAka, EpsAka, ImsAka, IMPU, IMSI, IMPI, SipDigest, NassImsBundled, GprsImsBundled, AkaUsim, ImsAkaUsimImsim, and ImsAkaImsim. Relationships include associations like CsSPUsesCsAka, GprsSPUsesPsAka, EpsSPUsesEpsAka, IMPUDerivesFromIMSI, IMPUPairsOrDerivesFromIMPI, IMPIDerivesFromIMSI, IMSIPairsAkaUsim, IMPIPairsImsAkaImsim, ImsAkaUsesImsAkaImsim, and ImsAkaUsesAkaUsim.](7efae06af3af43ffe5d4b956a679cf54_img.jpg)
398
+
399
+ ```
400
+
401
+ classDiagram
402
+ class UdcCsServiceProfile
403
+ class UdcGprsServiceProfile
404
+ class UdcEpsServiceProfile
405
+ class UdcImsServiceProfile
406
+ class CsAka
407
+ class GprsAka
408
+ class EpsAka
409
+ class ImsAka
410
+ class IMPU
411
+ class IMSI
412
+ class IMPI
413
+ class SipDigest
414
+ class NassImsBundled
415
+ class GprsImsBundled
416
+ class AkaUsim
417
+ class ImsAkaUsimImsim
418
+ class ImsAkaImsim
419
+
420
+ UdcCsServiceProfile "0..1" *-- "0..*" CsAka : CsSPUsesCsAka
421
+ UdcGprsServiceProfile "0..*" *-- "0..*" GprsAka : GprsSPUsesPsAka
422
+ UdcEpsServiceProfile "0..*" *-- "0..*" EpsAka : EpsSPUsesEpsAka
423
+ UdcImsServiceProfile "0..1" *-- "0..*" ImsAka : IMSSPcontainsIMPU
424
+
425
+ IMPU "0..1" -- "0..1" IMSI : IMPUDerivesFromIMSI
426
+ IMPU "0..*" -- "0..*" IMPI : IMPUPairsOrDerivesFromIMPI
427
+ IMSI "0..1" -- "0..1" IMPI : IMPIDerivesFromIMSI
428
+
429
+ IMSI "1" -- "0..1" AkaUsim : IMSIPairsAkaUsim
430
+ IMPI "1" -- "0..1" ImsAkaImsim : IMPIPairsImsAkaImsim
431
+ ImsAkaImsim "1" -- "0..1" ImsAkaUsimImsim : ImsAkaUsesImsAkaImsim
432
+ ImsAkaUsimImsim "0..1" -- "0..1" AkaUsim : ImsAkaUsesAkaUsim
433
+
434
+ ImsAka "0..1" -- "0..*" NassImsBundled
435
+ ImsAka "0..1" -- "0..*" GprsImsBundled
436
+ ImsAka "0..1" -- "0..1" SipDigest
437
+
438
+ ```
439
+
440
+ UML Class Diagram showing authentication methods and their relationships. Classes include UdcCsServiceProfile, UdcGprsServiceProfile, UdcEpsServiceProfile, UdcImsServiceProfile, CsAka, GprsAka, EpsAka, ImsAka, IMPU, IMSI, IMPI, SipDigest, NassImsBundled, GprsImsBundled, AkaUsim, ImsAkaUsimImsim, and ImsAkaImsim. Relationships include associations like CsSPUsesCsAka, GprsSPUsesPsAka, EpsSPUsesEpsAka, IMPUDerivesFromIMSI, IMPUPairsOrDerivesFromIMPI, IMPIDerivesFromIMSI, IMSIPairsAkaUsim, IMPIPairsImsAkaImsim, ImsAkaUsesImsAkaImsim, and ImsAkaUsesAkaUsim.
441
+
442
+ Figure 6.5.2-1: Authentication methods
443
+
444
+ #### 6.5.3.1 AkaUsim
445
+
446
+ ##### 6.5.3.1.1 Definition
447
+
448
+ This object class represents data that is required to perform Authentication and Key Agreement (AKA) when the UE is equipped with a USIM. For details of AKA see subclause 6.3 in 3GPP TS 33.102 [6]. For example, an encrypted subscriber key and the AMF can be attributes of this object class.
449
+
450
+ #### 6.5.3.2 CsAka
451
+
452
+ ##### 6.5.3.2.1 Definition
453
+
454
+ This object class represents data that is required to perform AKA when accessing Circuit-Switched services, such as the sequence number used for AKA authentication to access CS services. For details of AKA see subclause 6.3 in 3GPP TS 33.102 [6].
455
+
456
+ #### 6.5.3.3 GPRS Aka
457
+
458
+ ##### 6.5.3.3.1 Definition
459
+
460
+ This object class represents data that is required to perform AKA when accessing GPRS services such as the sequence number used for AKA authentication to access GPRS services. For details of AKA see subclause 6.3 in 3GPP TS 33.102 [6].
461
+
462
+ #### 6.5.3.4 EpsAka
463
+
464
+ ##### 6.5.3.4.1 Definition
465
+
466
+ This object class represents data that is required to perform AKA when accessing Evolved Packet-Switched services, such as the sequence number used for AKA authentication to access EPS services. For details of AKA see subclause 6.3 in 3GPP TS 33.102 [6].
467
+
468
+ #### 6.5.3.5 ImsAkalsim
469
+
470
+ ##### 6.5.3.5.1 Definition
471
+
472
+ This object class represents data that is required to perform IMS AKA for accessing IMS services when the UE is equipped with a UICC that contains an ISIM, for example, the encrypted subscriber key and AMF that is used for accessing IMS services. For details of IMS AKA see subclause 6.1 in 3GPP TS 33.203 [7].
473
+
474
+ #### 6.5.3.6 ImsAka
475
+
476
+ ##### 6.5.3.6.1 Definition
477
+
478
+ This object class represents data that is required to perform IMS AKA when accessing IMS services, such as the sequence number used for AKA authentication to access IMS services. For details of IMS AKA see subclause 6.1 in 3GPP TS 33.203 [7].
479
+
480
+ #### 6.5.3.7 ImsAkaUsimIsim
481
+
482
+ ##### 6.5.3.7.1 Definition
483
+
484
+ This object class represents the data that is required to perform IMS AKA for accessing IMS services when the UE is equipped with either a USIM or an ISIM, for example, the realm. It aggregates one of the AkaUsim or ImsAkaIsim object classes, depending on whether the UE is equipped with a USIM or an ISIM, respectively. For details of IMS AKA see subclause 6.1 in 3GPP TS 33.203 [7].
485
+
486
+ #### 6.5.3.8 GPRSImdBundled
487
+
488
+ ##### 6.5.3.8.1 Definition
489
+
490
+ This abstract object class represents the data that is required to perform GPRS-IMS bundled authentication. For details of the GPRS-IMS bundled authentication see 3GPP TS 33.203 [6] Annex T.
491
+
492
+ NOTE: This object class is set to be abstract because it does not need any new particular data. The GPRS-IMS bundled authentication requires the IPv4 address or IPv6 prefix allocated by GPRS to the UE, therefore, data that is stored elsewhere. This object class is merely here for completeness, but need not be implemented.
493
+
494
+ #### 6.5.3.9 NassImdBundled
495
+
496
+ ##### 6.5.3.9.1 Definition
497
+
498
+ This object class represents the data that is required to perform NASS-IMS bundled authentication, such as the line identifier. For details of the NASS-IMS bundled authentication see 3GPP TS 33.203 [6] Annex R.
499
+
500
+ #### 6.5.3.10 SipDigest
501
+
502
+ ##### 6.5.3.10.1 Definition
503
+
504
+ This object class represents the data that is required to perform SIP Digest authentication for accessing IMS services. For example, it includes the H(A1) parameter of HTTP Digest, the realm, QoP, and Algorithm directives in HTTP Digest authentication. For details of the SIP Digest authentication see 3GPP TS 33.203 [6] Annex N.
505
+
506
+ ## 6.5 Construction of AIM
507
+
508
+ An AIM comprises all the information required by an application. In the construction of an AIM, the following possibilities exist with respect to the current version of the SpIM:
509
+
510
+ - AIMs may be constructed from new information not yet present in the current version of the SpIM.
511
+ - AIMs may be constructed by using information that already exists in the current version of the SpIM.
512
+ - AIMs may be constructed requiring both new information and information that already exists in the current version of the SpIM.
513
+
514
+ # --- 7 Application management
515
+
516
+ ## 7.1 Application Access Control Data
517
+
518
+ Specification 23.335 [8] in Chapter 5.2 defines the requirements for application access to the UDR including authentication and authorisation.
519
+
520
+ To be able to authenticate an application and to provide it access data in the UDR the following have to be stored:
521
+
522
+ - identity of the application including additional access protocol dependent authentication information (e.g. password)
523
+ - type of the application with associated Data Model
524
+
525
+ To be able to authorise an application for access to data in the UDR the following have to be stored:
526
+
527
+ - allowed PLMN-Id(s)
528
+ - allowed operations with the associated Data Model
529
+ - restrictions on operations possibly at information element level.
530
+
531
+ ## 7.2 Application Data Model and Mapping to Consolidated Data Model
532
+
533
+ ### 7.2.1 Application Data Views
534
+
535
+ Different applications have different needs when accessing the data. Consider a piece of data: some applications may need to read and write that data; other applications will only need to read the same data; and a third group of applications should not be able to access that data at all. Since the UDR implements the CDM, there must exist a mechanism to control the access of data per application, so that only the authorised subset of the CDM is exposed to that application with the correct access permissions, details on primary access control are to be found in Chapter 7.1 of this specification.
536
+
537
+ Access only to the authorised subset of the CDM is achieved by implementing Application Data Views in the UDR connected to the different application types. The concept is illustrated in Figure 7.2.1-1 in a simplified way. A detailed figure is given in Figure 7.2.1-2, and a more developed concept (considering different vendors) is provided in Figure 7.2.1-3.
538
+
539
+ According to Figure 7.2.1-1 , the UDR implements the CDM. Application Data Views are implemented for each application type accessing its specific user data within CDM in the UDR. The Application Data View is responsible for enabling and limiting applications access to data within the UDR.
540
+
541
+ ![Figure 7.2.1-1: Application Data Views in the UDR (simplified). A central circle labeled 'CDM' is surrounded by three segments: 'App. 1 Data View' (blue), 'App. 2 Data View' (purple), and 'App. 3 Data View' (green). Three boxes labeled 'FE 1', 'FE 2', and 'FE 3' are positioned outside the circle, with double-headed arrows pointing from each box to its corresponding data view segment.](4356776ca004ecba5d599667a155d7d4_img.jpg)
542
+
543
+ Figure 7.2.1-1: Application Data Views in the UDR (simplified). A central circle labeled 'CDM' is surrounded by three segments: 'App. 1 Data View' (blue), 'App. 2 Data View' (purple), and 'App. 3 Data View' (green). Three boxes labeled 'FE 1', 'FE 2', and 'FE 3' are positioned outside the circle, with double-headed arrows pointing from each box to its corresponding data view segment.
544
+
545
+ Figure 7.2.1-1: Application Data Views in the UDR (simplified)
546
+
547
+ ![Figure 7.2.1-2: Correlation of IM and Application Data View for a single Application type in the UDR. A box labeled 'App IM (AIM)' has arrows pointing to a table and a box labeled 'Specialized IM (SpIM)'. The 'Specialized IM (SpIM)' box also has an arrow pointing to the table. The table has three rows: 'App Data View' (spanning all three rows), 'App Data Model', 'App Data Model Mapping', and 'Capabilities for Apps'.](9cd90f495b95ad2116ff780248c26d95_img.jpg)
548
+
549
+ | | |
550
+ |---------------|------------------------|
551
+ | App Data View | App Data Model |
552
+ | | App Data Model Mapping |
553
+ | | Capabilities for Apps |
554
+
555
+ Figure 7.2.1-2: Correlation of IM and Application Data View for a single Application type in the UDR. A box labeled 'App IM (AIM)' has arrows pointing to a table and a box labeled 'Specialized IM (SpIM)'. The 'Specialized IM (SpIM)' box also has an arrow pointing to the table. The table has three rows: 'App Data View' (spanning all three rows), 'App Data Model', 'App Data Model Mapping', and 'Capabilities for Apps'.
556
+
557
+ Figure 7.2.1-2: Correlation of IM and Application Data View for a single Application type in the UDR
558
+
559
+ In a multi-vendor scenario, for a given application type, each Front End vendor and application version may implement their own data model. Therefore, data models for the same application need not be equal across different vendors or release of the software. This scenario conceptually requires a different application data model mapping for each application and vendor. The concept is illustrated in Figure 7.2.1-3. For each application type, there can be a number of Application Data Views, each one handling the mapping to the particular data model of the vendor of the Front End. For example, for Application type #1, there can be three Front End vendors, named FE<sub>1</sub>, FE<sub>2</sub>, FE<sub>3</sub>, respectively. Each of these front ends implements its own data model. A different Application Data View handles the correct mapping to each data model. In Figure 7.2.1-3, Application Data View 1<sub>1</sub> manages FE<sub>1</sub>, Application Data View 1<sub>2</sub> manages FE<sub>2</sub>, Application Data View 1<sub>3</sub> manages FE<sub>3</sub>, and so on.
560
+
561
+ ![Diagram illustrating Application Data Views in the UDR. A central circle labeled 'CD' is surrounded by segments labeled 'App 1_1', 'App 1_2', 'App 1_3', 'App 2_1', 'App 2_2', 'App 2_3', 'App 3_1', 'App 3_2', and 'App 3_3'. Each application segment is connected to a group of Functional Entity (FE) blocks. App 1_1 connects to FE 1_1, FE 1_2, and FE 1_3. App 1_2 connects to FE 1_1, FE 1_2, and FE 1_3. App 1_3 connects to FE 1_1, FE 1_2, and FE 1_3. App 2_1 connects to FE 2_1, FE 2_2, and FE 2_3. App 2_2 connects to FE 2_1, FE 2_2, and FE 2_3. App 2_3 connects to FE 2_1, FE 2_2, and FE 2_3. App 3_1 connects to FE 3_1, FE 3_2, and FE 3_3. App 3_2 connects to FE 3_1, FE 3_2, and FE 3_3. App 3_3 connects to FE 3_1, FE 3_2, and FE 3_3.](8fa679f79a1bb1f527cba9f29e784e89_img.jpg)
562
+
563
+ Diagram illustrating Application Data Views in the UDR. A central circle labeled 'CD' is surrounded by segments labeled 'App 1\_1', 'App 1\_2', 'App 1\_3', 'App 2\_1', 'App 2\_2', 'App 2\_3', 'App 3\_1', 'App 3\_2', and 'App 3\_3'. Each application segment is connected to a group of Functional Entity (FE) blocks. App 1\_1 connects to FE 1\_1, FE 1\_2, and FE 1\_3. App 1\_2 connects to FE 1\_1, FE 1\_2, and FE 1\_3. App 1\_3 connects to FE 1\_1, FE 1\_2, and FE 1\_3. App 2\_1 connects to FE 2\_1, FE 2\_2, and FE 2\_3. App 2\_2 connects to FE 2\_1, FE 2\_2, and FE 2\_3. App 2\_3 connects to FE 2\_1, FE 2\_2, and FE 2\_3. App 3\_1 connects to FE 3\_1, FE 3\_2, and FE 3\_3. App 3\_2 connects to FE 3\_1, FE 3\_2, and FE 3\_3. App 3\_3 connects to FE 3\_1, FE 3\_2, and FE 3\_3.
564
+
565
+ Figure 7.2.1-3: Application Data Views in the UDR
566
+
567
+ ## 7.3 Subscription and Notification Related Data
568
+
569
+ Specification 23.335 [8] in Chapter 5.7 and 5.8 defines the procedure of subscription and notification. Specification 29.335[9] in Chapter 6.6, 6.7 and Annex A defines the content and format of the subscription and notification messages.
570
+
571
+ Subscription can be done by subscription message (dynamic) or configuration of the UDR (permanent). To support both kinds of subscription and to allow authorised unsubscribe operations, the following information should be stored in the UDR:
572
+
573
+ - type of subscription, dynamic or permanent
574
+ - user identifier, e.g. IMSI, MSISDN, IMS public user identity or IMS private user identity, if not specified the subscription is applicable to all users' data of the application in the UDR.
575
+ - information on the data requested to be observed
576
+ - identity of the original (originating) subscribing entity identity, this item indicates the original entity which sent the subscription request message to the FE in order to subscribe to the notification of the specific events of the data requested to be observed
577
+ - notification condition(s), this item indicates the specific events on which the notification shall be triggered. The triggering events shall consist of one or more of the following: the addition of the observed data, the deletion of the observed data or the changes of the observed data.
578
+ - type of notification, this item indicates whether this subscription request should lead to a notification to any FE of the application type or cluster identifier, or to a notification to the FE requesting the notification.to originating entity or to an FE/application based on actual selection
579
+
580
+ To support dynamic subscriptions the following information has to be stored in the UDR:
581
+
582
+ - the subscription expiry time
583
+ - the identifier of the FE or the FE Cluster which sent the subscription message (conditional, if the notification type indicates that the notification is to be sent to the FE requesting the subscription, this item is needed.)
584
+
585
+ To support the notification of data modification, the following information should be stored in the UDR:
586
+
587
+ - additional data to be sent to the application in the notification when the notification condition is met
588
+
589
+ - the FE selection algorithm (conditional, if the notification type indicates that the notification is to be sent to any FE of the application type or cluster identifier, this item is needed. This is only the identifier of the selection algorithm, not the algorithm itself.)
590
+
591
+ If the Notification Type indicates that the notification is to be sent to any FE, when the notification condition is met, the UDR should use the FE select algorithm to select a proper FE to notify. For example, the UDR may select to notify the application actually serving the user.
592
+
593
+ # --- 8 Consolidated data model management
594
+
595
+ ## 8.1 Lifecycle Management of the Consolidated Data Model in the UDR
596
+
597
+ Figure 8.1-1 below shows the operational environment of UDC according to Figure 4.3-1. The Provisioning Gateway is an additional aspect which is essential for the operation of the UDR. The Provisioning Gateway provides a single logical point for consistent provisioning of user data for all services in the UDR. The mechanism used by the Provisioning Gateway to access UDR data using the CDM is outside the scope of the present document. The Application boxes denote Application Front Ends including Provisioning Front Ends according to 23.335 [8]. The Provisioning Front Ends access UDR data via the Ud reference point and are restricted by their Application Data Model.
598
+
599
+ Chapter 4.3 describes how AIM(s) may be added and consolidated into the SpIM and the generation of the Application Data Model and its mapping to the CDM. It is the decision of the operator when the newly added AIM(s) may become operational.
600
+
601
+ It is the decision of the operator, when a new actual version of the SpIM with the newly added AIM(s) is implemented into the UDR as actual version of the CDM.
602
+
603
+ The Provisioning Gateway provides a view of the actual version of the CDM to enable provisioning of all data stored by different applications in the UDR.
604
+
605
+ The CDM implementation into the UDR is an atomic operation.
606
+
607
+ ![Figure 8.1-1: Evolution of the CDM in a UDR. The diagram illustrates the process of updating the Consolidated Data Model (CDM) in a User Data Repository (UDR). At the top, a green box labeled 'BSS' points down to a blue box labeled 'Provisioning Gateway'. The 'Provisioning Gateway' points down to a circular diagram representing the 'Consolidated Data Model (CDM)'. This circle is divided into segments: 'Full Data View' (yellow), 'Appl 1 View' (yellow), 'Appl 2 view' (green), 'APPL3 view' (red), and 'APPL 1 view' (pink). To the right, 'Appl 1' (yellow box) and 'Appl 2' (green box) are connected to the circle via arrows labeled 'Ud'. Below the circle, a red box labeled 'new Appl' points up to the circle via an arrow labeled 'Ud'. To the left, a green box labeled 'new AIM' points up to a grey box labeled 'Generate ADM and mapping and new SpIM'. This grey box points to the 'APPL3 view' and 'APPL 1 view' segments. Above it, another grey box labeled 'Generate new CDM' points to the 'Full Data View' segment and to a green box labeled 'SpIM'. The 'SpIM' box points to the 'new AIM' box.](79e1709a7317ead45379cbb8ff3ba802_img.jpg)
608
+
609
+ Figure 8.1-1: Evolution of the CDM in a UDR. The diagram illustrates the process of updating the Consolidated Data Model (CDM) in a User Data Repository (UDR). At the top, a green box labeled 'BSS' points down to a blue box labeled 'Provisioning Gateway'. The 'Provisioning Gateway' points down to a circular diagram representing the 'Consolidated Data Model (CDM)'. This circle is divided into segments: 'Full Data View' (yellow), 'Appl 1 View' (yellow), 'Appl 2 view' (green), 'APPL3 view' (red), and 'APPL 1 view' (pink). To the right, 'Appl 1' (yellow box) and 'Appl 2' (green box) are connected to the circle via arrows labeled 'Ud'. Below the circle, a red box labeled 'new Appl' points up to the circle via an arrow labeled 'Ud'. To the left, a green box labeled 'new AIM' points up to a grey box labeled 'Generate ADM and mapping and new SpIM'. This grey box points to the 'APPL3 view' and 'APPL 1 view' segments. Above it, another grey box labeled 'Generate new CDM' points to the 'Full Data View' segment and to a green box labeled 'SpIM'. The 'SpIM' box points to the 'new AIM' box.
610
+
611
+ Figure 8.1-1: Evolution of the CDM in a UDR
612
+
613
+ ## 8.2 Activation and Deactivation of Application Adaptation
614
+
615
+ As described above the operator shall be capable of
616
+
617
+ - adding new AIM to SpIM, described in Chapter 4.3
618
+ - adding ADM to UDR together with adaptation to CDM as described in Chapter 4.3 and 8.1.
619
+ - generate and activate new actual CDM based on the current SpIM as described in Chapter 8.1 above
620
+ - activate the access of the application to its data in the UDR which can only be done after the implementation of the CDM containing that data and is done by associating the proper Application Data View to the application.
621
+ - deactivate the access of the application to its data in the UDR which is needed when, for example, the data of the application have changed. Deactivation is done by deleting the current association of Application Data View to the application.
622
+
623
+ # 9 Relation to other Information Models
624
+
625
+ ## 9.1 Relation to SuM Network Resource Model
626
+
627
+ The 3GPP SuM NRM as defined in the TS 32.172 [10] contains the information model related to the provisioning of the data of 3GPP services stored in the UDR.
628
+
629
+ # Annex A (informative): Change history
630
+
631
+ | Change history | | | | | | | |
632
+ |----------------|-------|-----------|-----|-----|---------------------------------------------|-------|--------|
633
+ | Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New |
634
+ | 2010-03 | SA#47 | SP-100066 | -- | -- | Presentation to SA for information | -- | 1.0.0 |
635
+ | 2010-06 | SA#48 | SP-100372 | -- | -- | Presentation to SA for approval | 1.0.0 | 2.0.0 |
636
+ | 2010-06 | SA#48 | -- | -- | -- | Publication | 2.0.0 | 9.0.0 |
637
+ | 2010-09 | SA#49 | SP-100489 | 001 | -- | Correct inconsistency of PsAka with GprsAka | 9.0.0 | 10.0.0 |
marked/Rel-10/32_series/32182/raw.md ADDED
@@ -0,0 +1,620 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+ Keywords
4
+ UDC, 3GPP
5
+
6
+ # 3GPP TS 32.182 V10.0.0 (2011-03) ---
7
+
8
+ *Technical Specification*
9
+
10
+ **3GPP**
11
+ **3rd Generation Partnership Project;**
12
+ **Technical Specification Group Services and System Aspects;**
13
+ **Telecommunication management;**
14
+ **User Data Convolution (UDC);**
15
+ **Common Baseline Informatic**
16
+
17
+ ---
18
+
19
+ 3GPP support office address
20
+ 650 Route des Lucioles - Sophia Antipolis
21
+ Valbonne - FRANCE
22
+ Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 10
23
+
24
+ ![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg)
25
+
26
+ The 3GPP logo, featuring the letters '3GPP' in a stylized font with a red signal icon below the 'G'.
27
+
28
+ 3GPP logo
29
+
30
+ Internet
31
+ <http://www.3gpp.org>
32
+
33
+ The present document has been developed within the 3<sup>rd</sup> Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP..
34
+
35
+ The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented.
36
+
37
+ This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification.
38
+
39
+ Specifications and reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices.
40
+
41
+ # ***Copyright Notification***
42
+
43
+ No part may be reproduced except as authorized by written permission.
44
+ The copyright and the foregoing restriction extend to reproduction in all media.
45
+
46
+ © 2011, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TTA, TTC).
47
+ All rights reserved.
48
+
49
+ UMTSTM is a Trade Mark of ETSI registered for the benefit of its members
50
+
51
+ 3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
52
+
53
+ LTE™ is a Trade Mark of ETSI currently being registered for the benefit of its Members and of the 3GPP Organizational Partners
54
+
55
+ GSM® and the GSM logo are registered and owned by the GSM Association
56
+
57
+ # Contents
58
+
59
+ | | |
60
+ |----------------------------------------------------------|----|
61
+ | Foreword ..... | 5 |
62
+ | Introduction ..... | 5 |
63
+ | 1 Scope..... | 6 |
64
+ | 2 References..... | 6 |
65
+ | 3 Definitions and abbreviations ..... | 6 |
66
+ | 3.1 Definitions..... | 6 |
67
+ | 3.2 Abbreviations ..... | 7 |
68
+ | 4 Modelling Approach ..... | 8 |
69
+ | 5 Information Object Classes..... | 8 |
70
+ | 5.1 Imported Information Entities and Local Labels ..... | 8 |
71
+ | 5.2 Class Diagram ..... | 8 |
72
+ | 5.2.1 Attributes and relationships..... | 8 |
73
+ | 5.2.2 Inheritance..... | 9 |
74
+ | 5.3 Information Object Class Definitions ..... | 10 |
75
+ | 5.3.1 EndUser ..... | 10 |
76
+ | 5.3.1.1 Definition ..... | 10 |
77
+ | 5.3.2 Identifier ..... | 10 |
78
+ | 5.3.2.1 Definition ..... | 10 |
79
+ | 5.3.3 UdcServiceProfile ..... | 10 |
80
+ | 5.3.3.1 Definition ..... | 10 |
81
+ | 5.3.4 EndDevice..... | 10 |
82
+ | 5.3.4.1 Definition ..... | 10 |
83
+ | 5.3.5 UdcCsServiceProfile..... | 10 |
84
+ | 5.3.5.1 Definition ..... | 10 |
85
+ | 5.3.6 UdcGprsServiceProfile..... | 11 |
86
+ | 5.3.6.1 Definition ..... | 11 |
87
+ | 5.3.7 UdcEpsServiceProfile ..... | 11 |
88
+ | 5.3.7.1 Definition ..... | 11 |
89
+ | 5.3.8 UdcImsServiceProfile ..... | 11 |
90
+ | 5.3.8.1 Definition ..... | 11 |
91
+ | 5.3.9 MSISDN..... | 11 |
92
+ | 5.3.9.1 Definition ..... | 11 |
93
+ | 5.3.10 IMSI..... | 11 |
94
+ | 5.3.10.1 Definition ..... | 11 |
95
+ | 5.3.11 IMPI..... | 11 |
96
+ | 5.3.11.1 Definition ..... | 11 |
97
+ | 5.3.12 IMPU..... | 12 |
98
+ | 5.3.12.1 Definition ..... | 12 |
99
+ | 5.3.13 E164..... | 12 |
100
+ | 5.3.13.1 Definition ..... | 12 |
101
+ | 5.3.14 NAI..... | 12 |
102
+ | 5.3.14.1 Definition ..... | 12 |
103
+ | 5.3.15 TelURI..... | 12 |
104
+ | 5.3.15.1 Definition ..... | 12 |
105
+ | 5.3.16 SIPURI..... | 12 |
106
+ | 5.3.16.1 Definition ..... | 12 |
107
+ | 5.3.17 UdcEndUserGroup ..... | 12 |
108
+ | 5.3.17.1 Definition ..... | 12 |
109
+ | 5.3.18 UdcSubscription ..... | 13 |
110
+ | 5.3.18.1 Definition ..... | 13 |
111
+ | 5.4 Information Relationship Definitions..... | 13 |
112
+ | 5.4.1. SubscriptionDeterminesSP..... | 13 |
113
+ | 5.4.1.1 Definition ..... | 13 |
114
+ | 5.4.2 SPMayIncludeID..... | 13 |
115
+
116
+ | | | |
117
+ |------------------------|---------------------------------|----|
118
+ | 5.4.2.1 | Definition ..... | 13 |
119
+ | 5.4.3 | EUHasSP ..... | 13 |
120
+ | 5.4.3.1 | Definition ..... | 13 |
121
+ | 5.4.4 | IdentifierPairsIdentifier ..... | 13 |
122
+ | 5.4.4.1 | Definition ..... | 13 |
123
+ | 5.4.5 | EUIDentifiedByID..... | 13 |
124
+ | 5.4.5.1 | Definition ..... | 13 |
125
+ | 5.4.6 | GroupMembership ..... | 14 |
126
+ | 5.4.6.1 | Definition ..... | 14 |
127
+ | 5.4.7 | TemporarilyPaired ..... | 14 |
128
+ | 5.4.7.1 | Definition ..... | 14 |
129
+ | 5.4.8 | CSSPcontainsMSISDN..... | 14 |
130
+ | 5.4.8.1 | Definition ..... | 14 |
131
+ | 5.4.9 | GPRSSPcontainsMSISDN..... | 14 |
132
+ | 5.4.9.1 | Definition ..... | 14 |
133
+ | 5.4.10 | EPSSPcontainsMSISDN..... | 14 |
134
+ | 5.4.10.1 | Definition ..... | 14 |
135
+ | 5.4.11 | IMSSPcontainsIMPU ..... | 14 |
136
+ | 5.4.11.1 | Definition ..... | 14 |
137
+ | 5.4.12 | MSISDNPairsIMSI ..... | 15 |
138
+ | 5.4.12.1 | Definition ..... | 15 |
139
+ | 5.4.13 | IMPIDerivesFromIMSI..... | 15 |
140
+ | 5.4.13.1 | Definition ..... | 15 |
141
+ | 5.4.14 | IMPUPairsOrDerivesFromIMPI..... | 15 |
142
+ | 5.4.14.1 | Definition ..... | 15 |
143
+ | 5.4.15 | IMPUDerivesFromIMSI..... | 15 |
144
+ | 5.4.15.1 | Definition ..... | 15 |
145
+ | 5.4.16 | MSISDNTakesFormatOfE164 ..... | 15 |
146
+ | 5.4.16.1 | Definition ..... | 15 |
147
+ | 5.4.17 | IMPITakesFormatOfNAI ..... | 15 |
148
+ | 5.4.17.1 | Definition ..... | 15 |
149
+ | 5.4.18 | IMPUTakesFormatOfTelURI ..... | 16 |
150
+ | 5.4.18.1 | Definition ..... | 16 |
151
+ | 5.4.19 | IMPUTakesFormatOfSIPURI ..... | 16 |
152
+ | 5.4.19.1 | Definition ..... | 16 |
153
+ | 5.4.20 | TelURIDerivesFromE164..... | 16 |
154
+ | 5.4.20.1 | Definition ..... | 16 |
155
+ | Annex A (informative): | Change history..... | 17 |
156
+
157
+ # --- Foreword
158
+
159
+ This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP).
160
+
161
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
162
+
163
+ Version x.y.z
164
+
165
+ where:
166
+
167
+ - x the first digit:
168
+ - 1 presented to TSG for information;
169
+ - 2 presented to TSG for approval;
170
+ - 3 or greater indicates TSG approved document under change control.
171
+ - y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
172
+ - z the third digit is incremented when editorial only changes have been incorporated in the document.
173
+
174
+ # --- Introduction
175
+
176
+ User Data Convergence (UDC) presents a layered architecture where user data is accessible at a logically unique repository called User Data Repository (UDR). One or more dataless applications access the user data that is stored in the UDR. In this context, applications can be front ends, for example an HSS-FE or an HLR-FE, or application servers. In order to support UDC, a Common Baseline Information Model is defined in this specification.
177
+
178
+ # --- 1 Scope
179
+
180
+ The present document specifies a Common Baseline Information Model for UDC [2]. This information model denotes an abstract, formal representation of entity types that are common to many applications using the UDR. CBIM describes the basic IOCs of UDC, their properties and their relationships. Detailed requirements for the specification of this Common Baseline Information Model are given in 3GPP TR 22.985 [2] and 3GPP TS 22.101 [3].
181
+
182
+ From the Common Baseline Information Model specialized information models and data models can be derived. All these derived models are out of the scope of this specification.
183
+
184
+ # --- 2 References
185
+
186
+ The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
187
+
188
+ - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
189
+ - For a specific reference, subsequent revisions do not apply.
190
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
191
+
192
+ - [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications".
193
+ - [2] 3GPP TR 22.985: "Service requirement for the User Data Convergence (UDC)".
194
+ - [3] 3GPP TS 22.101: "Service aspects; Service principles".
195
+ - [4] 3GPP TS 32.151: "Integration Reference Point (IRP) Information Service (IS) template (Release 8)".
196
+ - [5] 3GPP TS 32.152: "Integration Reference Point (IRP) Information Service (IS) Unified Modelling Language (UML) repertoire (Release 8)".
197
+ - [6] 3GPP TS 23.003: "Numbering, addressing and identification; (Release 8)".
198
+ - [7] 3GPP TS 23.228: "IP Multimedia Subsystem (IMS); Stage 2; (Release 8)".
199
+ - [8] ITU-T Recommendation E.164: "The International Public Telecommunication Numbering Plan".
200
+ - [9] IETF RFC 4282: "The Network Access Identifier".
201
+ - [10] IETF RFC 3966: "The tel URI for Telephone Numbers".
202
+ - [11] IETF RFC 3261: "SIP: Session Initiation Protocol".
203
+ - [12] 3GPP TS 32.181: "User Data Convergence; Framework for Model Handling and Management".
204
+
205
+ # --- 3 Definitions and abbreviations
206
+
207
+ ## 3.1 Definitions
208
+
209
+ For the purposes of the present document, the terms and definitions given in TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TR 21.905 [1].
210
+
211
+ **Common Baseline Information Model:** an abstract, formal representation of entity types common to many applications using the UDR. CBIM describes the basic IOCs of UDC, their properties and their relationships, so that these IOCs constitute the baseline for any given application. Therefore, CBIM provides flexibility (in its data structure
212
+
213
+ and content), extensibility and multi-application approach. In particular, CBIM provides support for the concepts of Subscription, Service Profile, End User, Identifiers, End User Group, and End Device, among others. CBIM does not define the models that are associated with each application and that are under their responsibility.
214
+
215
+ ## 3.2 Abbreviations
216
+
217
+ For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1].
218
+
219
+ | | |
220
+ |--------|------------------------------------------|
221
+ | CBIM | Common Baseline Information Model |
222
+ | UE | User Equipment |
223
+ | FE | Front End |
224
+ | IRP | Integration Reference Point |
225
+ | IMPI | IP Multimedia Private User Identity |
226
+ | IMPU | IP Multimedia Public User Identity |
227
+ | IMS | IP Multimedia Subsystem |
228
+ | IMSI | International Mobile Subscriber Identity |
229
+ | ISDN | Integrated Services Digital Network |
230
+ | IS | Information Service |
231
+ | ISIM | IM Services Identity Module |
232
+ | MSISDN | Mobile Subscriber ISDN Number |
233
+ | NAI | Network Access Identifier |
234
+ | UDC | User Data Convergence |
235
+ | UDR | User Data Repository |
236
+ | UML | Unified Modelling Language |
237
+ | URI | Uniform Resource Identifier |
238
+
239
+ # 4 Modelling Approach
240
+
241
+ The CBIM is not an Integration Reference Point (IRP) as it is not used for a management interface; however this specification follows the IRP IS template specified in 3GPP TS 32.151 [4] and reuses the UML repertoire described in 3GPP TS 32.152 [5].
242
+
243
+ NOTE: The intention of CBIM is to provide the basic common IOCs of UDC, including their definitions and relationships. Attributes of the IOCs are not intended to be part of this specification.
244
+
245
+ # 5 Information Object Classes
246
+
247
+ ## 5.1 Imported Information Entities and Local Labels
248
+
249
+ ## 5.2 Class Diagram
250
+
251
+ ### 5.2.1 Attributes and relationships
252
+
253
+ ![UML Class Diagram showing UdcServiceProfile, UdcSubscription, EndUser, Identifier, UdcEndUserGroup, and EndDevice classes and their relationships.](07b17a620c75522d53916a11e12d1bff_img.jpg)
254
+
255
+ ```
256
+ classDiagram
257
+ class UdcServiceProfile
258
+ class UdcSubscription
259
+ class EndUser
260
+ class Identifier
261
+ class UdcEndUserGroup
262
+ class EndDevice
263
+
264
+ UdcServiceProfile "0..*" -- "0..1" UdcSubscription : SubscriptionDeterminesSP
265
+ EndUser "1" -- "0..*" UdcServiceProfile : EUHasSP
266
+ EndUser "1" -- "0..*" Identifier : EUIdentifiedByD
267
+ EndUser "0..*" -- "0..*" UdcEndUserGroup : GroupMembership
268
+ Identifier "0..*" -- "0..*" EndDevice : TemporarilyPaired
269
+ Identifier "0..*" -- "0..*" Identifier : IdentifierPairsIdentifier
270
+ UdcServiceProfile "0..*" -- "0..*" Identifier : SPMayIncludeID
271
+ ```
272
+
273
+ The diagram illustrates the UDC CBIM Core View with the following classes and relationships:
274
+
275
+ - UdcServiceProfile** (Information Object Class) has a relationship with **UdcSubscription** (Information Object Class) labeled *SubscriptionDeterminesSP*. Multiplicity: 0..\* to 0..1.
276
+ - EndUser** (Information Object Class) has a relationship with **UdcServiceProfile** labeled *EUHasSP*. Multiplicity: 1 to 0..\*.
277
+ - EndUser** has a relationship with **Identifier** (Information Object Class) labeled *EUIdentifiedByD*. Multiplicity: 1 to 0..\*.
278
+ - EndUser** has a relationship with **UdcEndUserGroup** (Information Object Class) labeled *GroupMembership*. Multiplicity: 0..\* to 0..\*.
279
+ - Identifier** has a relationship with **EndDevice** (Information Object Class) labeled *TemporarilyPaired*. Multiplicity: 0..\* to 0..\*.
280
+ - Identifier** has a self-relationship labeled *IdentifierPairsIdentifier*. Multiplicity: 0..\* to 0..\*.
281
+ - UdcServiceProfile** has a relationship with **Identifier** labeled *SPMayIncludeID*. Multiplicity: 0..\* to 0..\*.
282
+
283
+ UML Class Diagram showing UdcServiceProfile, UdcSubscription, EndUser, Identifier, UdcEndUserGroup, and EndDevice classes and their relationships.
284
+
285
+ Figure 5.2.1-1: UDC CBIM Core View
286
+
287
+ ![UML Class Diagram showing relationships between service profiles and identifiers.](ebff22fb5dd6f50a90e44dca0f82f285_img.jpg)
288
+
289
+ ```
290
+
291
+ classDiagram
292
+ class UdcCsServiceProfile
293
+ class UdcGprsServiceProfile
294
+ class UdcEpsServiceProfile
295
+ class UdcImssServiceProfile
296
+ class MSISDN
297
+ class IMSI
298
+ class IMPI
299
+ class IMPU
300
+ class E164
301
+ class NAI
302
+ class TelURI
303
+ class SIPURI
304
+
305
+ UdcCsServiceProfile "0..1" *-- "0..*" MSISDN : CSSPcontainsMSISDN
306
+ UdcGprsServiceProfile "0..1" *-- "0..*" MSISDN : GPRSSPcontainsMSISDN
307
+ UdcEpsServiceProfile "0..1" *-- "0..*" IMSI : EPSSPcontainsMSISDN
308
+ UdcImssServiceProfile "0..*" *-- "0..1" IMPU : IMSSPcontainsIMPU
309
+
310
+ MSISDN "0..*" -- "0..*" IMSI : MSISDNPairsIMSI
311
+ IMSI "0..1" -- "0..1" IMPI : IMPIDerivesFromIMSI
312
+ IMPI "0..*" -- "0..*" IMPU : IMPUPairsOrDerivesFromIMPI
313
+
314
+ MSISDN "1" -- "1" E164 : MSISDNTakesFormatOfE164
315
+ IMSI "1" -- "1" NAI : IMPITakesFormatOfNAI
316
+ IMPI "1" -- "1" TelURI : IMPUTakesFormatOfTelURI
317
+ IMPU "1" -- "1" SIPURI : IMPUTakesFormatOfSIPURI
318
+
319
+ TelURI "1" -- "0..1" E164 : TelURIDerivesFromE164
320
+
321
+ ```
322
+
323
+ UML Class Diagram showing relationships between service profiles and identifiers.
324
+
325
+ **Figure 5.2.1-2: Identifiers**
326
+
327
+ ### 5.2.2 Inheritance
328
+
329
+ ![UML Class Diagram showing inheritance from UdcServiceProfile.](b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg)
330
+
331
+ ```
332
+
333
+ classDiagram
334
+ class UdcServiceProfile
335
+ class UdcCsServiceProfile
336
+ class UdcGprsServiceProfile
337
+ class UdcEpsServiceProfile
338
+ class UdcImssServiceProfile
339
+
340
+ UdcCsServiceProfile --|> UdcServiceProfile
341
+ UdcGprsServiceProfile --|> UdcServiceProfile
342
+ UdcEpsServiceProfile --|> UdcServiceProfile
343
+ UdcImssServiceProfile --|> UdcServiceProfile
344
+
345
+ ```
346
+
347
+ UML Class Diagram showing inheritance from UdcServiceProfile.
348
+
349
+ **Figure 5.2.2-1: UdcServiceProfile inheritance**
350
+
351
+ ![UML Class Diagram showing inheritance from Identifier.](367926125450c2bc3f4bdca9d59a62ba_img.jpg)
352
+
353
+ ```
354
+
355
+ classDiagram
356
+ class Identifier
357
+ class MSISDN
358
+ class IMSI
359
+ class IMPI
360
+ class IMPU
361
+
362
+ MSISDN --|> Identifier
363
+ IMSI --|> Identifier
364
+ IMPI --|> Identifier
365
+ IMPU --|> Identifier
366
+
367
+ ```
368
+
369
+ UML Class Diagram showing inheritance from Identifier.
370
+
371
+ **Figure 5.2.2-2: Identifier inheritance**
372
+
373
+ ## 5.3 Information Object Class Definitions
374
+
375
+ ### 5.3.1 EndUser
376
+
377
+ #### 5.3.1.1 Definition
378
+
379
+ In this context this object class represents an End User (as per 3GPP TS 21.905 [1]). This class represents the view that the telecommunication network has about the end user and contains the valid parameters that define the End User from UDC point of view. An EndUser object class has an End-User Identity attribute (EUI), which is described in 3GPP TS 21.905 [1].
380
+
381
+ ### 5.3.2 Identifier
382
+
383
+ #### 5.3.2.1 Definition
384
+
385
+ This abstract object class represents an end user identifier that is used within the network so that the different network functionalities can be used (mobility management, authentication, and service usage). This is an abstract IOC that can be inherited by the real identifier used in the network, like IMSI, MSISDN, IMPI, IMPU, etc.
386
+
387
+ NOTE: This object does not include identities that are not associated to a user, such as an IMEI, hostID, etc.
388
+
389
+ ### 5.3.3 UdcServiceProfile
390
+
391
+ #### 5.3.3.1 Definition
392
+
393
+ This object class represents the data characterizing a service assigned to an EndUser. It includes service preferences and settings chosen for an EndUser. The service profile contains the permanent and temporary data pertaining to an end user that is subscribed to a service. This IOC can be inherited by different service profiles, such as CS, GPRS, EPS, IMS service profiles and so on.
394
+
395
+ ### 5.3.4 EndDevice
396
+
397
+ #### 5.3.4.1 Definition
398
+
399
+ This object class represents a composite of hardware and software that implements service terminal functions and that the EndUser operates in order to get access to telecommunication services.
400
+
401
+ ### 5.3.5 UdcCsServiceProfile
402
+
403
+ #### 5.3.5.1 Definition
404
+
405
+ This object class represents the part of the UdcServiceProfile that contains data related to Circuit-Switched services. An example of further specialization of this object class, including attributes, is provided in 3GPP TS 32.181 [12].
406
+
407
+ ### 5.3.6 UdcGprsServiceProfile
408
+
409
+ #### 5.3.6.1 Definition
410
+
411
+ This object class represents the part of the UdcServiceProfile that contains data related to Packet-Switched services. An example of further specialization of this object class, including attributes, is provided in 3GPP TS 32.181 [12].
412
+
413
+ ### 5.3.7 UdcEpsServiceProfile
414
+
415
+ #### 5.3.7.1 Definition
416
+
417
+ This object class represents the part of the `UdcServiceProfile` that contains data related to the Evolved Packet System services. An example of further specialization of this object class, including attributes, is provided in 3GPP TS 32.181 [12].
418
+
419
+ ### 5.3.8 UdcImServiceProfile
420
+
421
+ #### 5.3.8.1 Definition
422
+
423
+ This object class represents the part of the `UdcServiceProfile` that contains data related to IMS services. An example of further specialization of this object class, including attributes, is provided in 3GPP TS 32.181 [12].
424
+
425
+ ### 5.3.9 MSISDN
426
+
427
+ #### 5.3.9.1 Definition
428
+
429
+ In this context this object class represents a Mobile Subscriber Integrated Services Digital Network Number (as per 3GPP TS 23.003 [6]). An MSISDN is allocated from an E.164 numbering plan.
430
+
431
+ ### 5.3.10 IMSI
432
+
433
+ #### 5.3.10.1 Definition
434
+
435
+ In this context this object class represents an International Mobile Subscriber Identity (as per 3GPP TS 23.003 [6]).
436
+
437
+ ### 5.3.11 IMPI
438
+
439
+ #### 5.3.11.1 Definition
440
+
441
+ In this context this object class represents an IMS Private User Identity (as per 3GPP TS 23.228 [7]). The Private User Identity takes the form of a Network Access Identifier (NAI), which is defined in IETF RFC 4282 [9]. It is possible for a representation of the IMSI to be contained within the NAI for the private user identity.
442
+
443
+ ### 5.3.12 IMPU
444
+
445
+ #### 5.3.12.1 Definition
446
+
447
+ In this context this object class represents an IMS Public User Identity (as per 3GPP TS 23.228 [7]). An IMPU takes the form of either a SIP URI (see IETF RFC 3261 [11]) or a Tel URI (see IETF RFC 3966 [10]). For UEs that are not equipped with an ISIM application, it is possible to derive a temporary IMPU from the IMSI (see 3GPP TS 23.003 [6] for details).
448
+
449
+ ### 5.3.13 E164
450
+
451
+ #### 5.3.13.1 Definition
452
+
453
+ This object class represents a telephone number crafted according to ITU-T Recommendation E.164 [8].
454
+
455
+ ### 5.3.14 NAI
456
+
457
+ #### 5.3.14.1 Definition
458
+
459
+ This object class represents a Network Access Identifier (as per IETF RFC 4282 [9]).
460
+
461
+ ### 5.3.15 TelURI
462
+
463
+ #### 5.3.15.1 Definition
464
+
465
+ This object class represents a telephone URI (as per IETF RFC 3966 [10]).
466
+
467
+ ### 5.3.16 SIPURI
468
+
469
+ #### 5.3.16.1 Definition
470
+
471
+ This object class represents a SIP URI (as per IETF RFC 3261 [11]).
472
+
473
+ ### 5.3.17 UdcEndUserGroup
474
+
475
+ #### 5.3.17.1 Definition
476
+
477
+ This IOC represents a grouping of several End Users by the operator. The IOC includes information that describes the grouping and criteria for membership.
478
+
479
+ Examples of UdcEndUserGroup may include the following: Closed User Group, VPN, and market segments.
480
+
481
+ ### 5.3.18 UdcSubscription
482
+
483
+ #### 5.3.18.1 Definition
484
+
485
+ This IOC represents common data shared by a group of UdcServiceProfile instances. This IOC exists due to the relationship of a subscriber to the service provider. The end user can be attached to different UDC subscriptions through UDC Service Profiles for different service usage (e.g. for a private and a professional service usage).
486
+
487
+ **Editor's Note:** The relationship between Identifier and UdcSubscription is left for further study.
488
+
489
+ ## 5.4 Information Relationship Definitions
490
+
491
+ ### 5.4.1. SubscriptionDeterminesSP
492
+
493
+ #### 5.4.1.1 Definition
494
+
495
+ This represents the association established between UdcSubscription and UdcServiceProfile due to common data shared by a group of UdcServiceProfile instances.
496
+
497
+ ### 5.4.2 SPMayIncludeID
498
+
499
+ #### 5.4.2.1 Definition
500
+
501
+ This represents the association established between `Identifier` and `UdcServiceProfile`.
502
+
503
+ ### 5.4.3 EUHasSP
504
+
505
+ #### 5.4.3.1 Definition
506
+
507
+ This represents the association established between `UdcServiceProfile` and `EndUser` due to the fact that any end user who is receiving a service has a service profile associated to it.
508
+
509
+ ### 5.4.4 IdentifierPairsIdentifier
510
+
511
+ #### 5.4.4.1 Definition
512
+
513
+ This represents the relation established by instances of `Identifier` with other instances of `Identifier`. For example, one instance of `Identifier` can be an IMPU IOC, and the other an IMPI IOC. The relation of both is generically described by this relationship.
514
+
515
+ ### 5.4.5 EUIdentifiedByID
516
+
517
+ #### 5.4.5.1 Definition
518
+
519
+ This represents an instance of `EndUser` that aggregates instances of `Identifier`.
520
+
521
+ ### 5.4.6 GroupMembership
522
+
523
+ #### 5.4.6.1 Definition
524
+
525
+ This represents the association established between `EndUser` and `UdcEndUserGroup` determined due to the operator selecting instances of `EndUser` belonging to `UdcEndUserGroup`.
526
+
527
+ ### 5.4.7 TemporarilyPaired
528
+
529
+ #### 5.4.7.1 Definition
530
+
531
+ This represents the temporarily association established between `EndDevice` and `Identifiers`, and vice versa. The relation is determined by an identifier (such as an MSISDN or an IMPU) being used from end devices, and from an end device being used by identifiers.
532
+
533
+ ### 5.4.8 CSSPcontainsMSISDN
534
+
535
+ #### 5.4.8.1 Definition
536
+
537
+ This represents an aggregation from `UdcCsServiceProfile` to `MSISDN`.
538
+
539
+ ### 5.4.9 GPRSSPcontainsMSISDN
540
+
541
+ #### 5.4.9.1 Definition
542
+
543
+ This represents an aggregation from `UdcGprsServiceProfile` to one or more instances of `MSISDN`.
544
+
545
+ ### 5.4.10 EPSSPcontainsMSISDN
546
+
547
+ #### 5.4.10.1 Definition
548
+
549
+ This represents an aggregation from `UdcEpsServiceProfile` to `MSISDN`.
550
+
551
+ ### 5.4.11 IMSSPcontainsIMPU
552
+
553
+ #### 5.4.11.1 Definition
554
+
555
+ This represents an aggregation from `UdcImServiceProfile` to `IMPU`.
556
+
557
+ ### 5.4.12 MSISDNPairsIMSI
558
+
559
+ #### 5.4.12.1 Definition
560
+
561
+ This represents the association established between `MSISDN` and `IMSI`. This might be the case when an `MSISDN` uses `IMSIs` included in a SIM application for authentication purposes.
562
+
563
+ ### 5.4.13 IMPIDerivesFromIMSI
564
+
565
+ #### 5.4.13.1 Definition
566
+
567
+ This represents the association established when an `IMPI` is built from the contents of an `IMSI`. This might be the case when a UE that is accessing IMS services is not equipped with a `ISIM` application, but just a `USIM` application in the `UICC`. See details of the derivation process in 3GPP TS 23.003 [6].
568
+
569
+ ### 5.4.14 IMPUPairsOrDerivesFromIMPI
570
+
571
+ #### 5.4.14.1 Definition
572
+
573
+ This represents the association established when an `IMPU` is paired with an `IMPI`, where the `IMPI` is used for authentication purposes of that `IMPU`.
574
+
575
+ ### 5.4.15 IMPUDerivesFromIMSI
576
+
577
+ #### 5.4.15.1 Definition
578
+
579
+ This represents the association established when an `IMPU` is derived from an `IMSI`. This might be the case when a UE that is accessing IMS services is not equipped with an `ISIM` application, but a `USIM` application in the `UICC`. See details of the derivation process in 3GPP TS 23.003 [6].
580
+
581
+ ### 5.4.16 MSISDNTakesFormatOfE164
582
+
583
+ #### 5.4.16.1 Definition
584
+
585
+ This represents the association established when an MSISDN is created from an E.164 number.
586
+
587
+ ### 5.4.17 IMPI Takes Format Of NAI
588
+
589
+ #### 5.4.17.1 Definition
590
+
591
+ This represents the association established when the IMPI takes the format of a NAI. See details in 3GPP TS 23.003 [6].
592
+
593
+ ### 5.4.18 IMPU Takes Format Of Tel URI
594
+
595
+ #### 5.4.18.1 Definition
596
+
597
+ This represents the association established when an IMPU takes the format of a Tel URI. See details in 3GPP TS 23.003 [6].
598
+
599
+ ### 5.4.19 IMPU Takes Format Of SIP URI
600
+
601
+ #### 5.4.19.1 Definition
602
+
603
+ This represents the association established when an IMPU takes the format of a SIP URI. See details in 3GPP TS 23.003 [6].
604
+
605
+ ### 5.4.20 Tel URI Derives From E164
606
+
607
+ #### 5.4.20.1 Definition
608
+
609
+ This represents the association established when a Tel URI is derived from an E.164 number.
610
+
611
+ # --- Annex A (informative): Change history
612
+
613
+ | Change history | | | | | | | | |
614
+ |----------------|-------|-----------|----|-----|------------------------------------|--|-------|--------|
615
+ | Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | | Old | New |
616
+ | 2009-12 | SA#46 | SP-090727 | -- | -- | Presentation to SA for information | | --- | 1.0.0 |
617
+ | 2010-03 | SA#47 | SP-100067 | -- | -- | Presentation to SA for Approval | | 1.0.0 | 2.0.0 |
618
+ | 2010-03 | -- | -- | -- | -- | Publication of SA approved version | | 2.0.0 | 9.0.0 |
619
+ | 2011-03 | - | - | - | - | Update to Rel-10 version (MCC) | | 9.0.0 | 10.0.0 |
620
+
marked/Rel-10/32_series/32240/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
marked/Rel-10/32_series/32250/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
marked/Rel-10/32_series/32252/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
marked/Rel-10/32_series/32270/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
marked/Rel-10/32_series/32271/raw.md ADDED
@@ -0,0 +1,933 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+
4
+
5
+
6
+
7
+ # Contents
8
+
9
+ | | |
10
+ |--------------------------------------------------------------------------------|-----------|
11
+ | Foreword ..... | 4 |
12
+ | 1 Scope..... | 5 |
13
+ | 2 References..... | 5 |
14
+ | 3 Definitions, symbols and abbreviations..... | 7 |
15
+ | 3.1 Definitions..... | 7 |
16
+ | 3.2 Symbols..... | 9 |
17
+ | 3.3 Abbreviations ..... | 9 |
18
+ | 4 Architecture considerations..... | 10 |
19
+ | 4.1 High level LCS architecture..... | 10 |
20
+ | 4.2 LCS offline charging architecture ..... | 11 |
21
+ | 4.3 LCS online charging architecture..... | 11 |
22
+ | 5 LCS charging principles and scenarios..... | 12 |
23
+ | 5.1 LCS charging principles..... | 12 |
24
+ | 5.2 LCS offline charging scenarios ..... | 12 |
25
+ | 5.2.1 Basic principles ..... | 12 |
26
+ | 5.2.2 Rf message flows..... | 12 |
27
+ | 5.2.3 CDR Generation ..... | 12 |
28
+ | 5.2.3.1 Mobile originated location request (MO-LR)..... | 13 |
29
+ | 5.2.3.2 Mobile terminated location request (MT-LR) ..... | 14 |
30
+ | 5.2.3.3 Network induced location request (NI-LR)..... | 16 |
31
+ | 5.2.4 Ga record transfer flows ..... | 16 |
32
+ | 5.2.5 B <sub>L</sub> CDR file transfer ..... | 16 |
33
+ | 5.3 LCS online charging scenarios..... | 17 |
34
+ | 5.3.1 Basic principles ..... | 17 |
35
+ | 5.3.2 Ro message flows..... | 17 |
36
+ | 5.3.2.1 Mobile originated Location Request (MO-LR)..... | 17 |
37
+ | 5.3.2.2 Mobile Terminated Location Request (MT-LR) ..... | 18 |
38
+ | 6 Definition of charging information..... | 19 |
39
+ | 6.1 Data description for LCS offline charging..... | 19 |
40
+ | 6.1.1 Rf message contents ..... | 19 |
41
+ | 6.1.2 Ga message contents..... | 19 |
42
+ | 6.1.3 CDR description on the B <sub>L</sub> interface..... | 19 |
43
+ | 6.1.3.1 LCS Records for Mobile Originated Location Request (LCS-GMO-CDR) ..... | 20 |
44
+ | 6.1.3.2 LCS Records for mobile terminated location request ..... | 20 |
45
+ | 6.1.3.2.1 LCS Records for Requesting GMLC (LCS-RGMT-CDR) ..... | 20 |
46
+ | 6.1.3.2.2 LCS Records for Home GMLC (LCS-HGMT-CDR) ..... | 21 |
47
+ | 6.1.3.2.3 LCS Records for Visited GMLC (LCS-VGMT-CDR)..... | 21 |
48
+ | 6.1.3.3 LCS Records for Network Initiated Location Request (LCS-GNI-CDR)..... | 22 |
49
+ | 6.2 Data description for LCS online charging..... | 22 |
50
+ | 6.2.1 R <sub>o</sub> message contents ..... | 22 |
51
+ | 6.2.1.1 LCS Credit-Control-Request Message ..... | 23 |
52
+ | 6.2.1.2 LCS Credit-Control-Answer Message..... | 24 |
53
+ | 6.3 LCS Charging Specific Parameters..... | 24 |
54
+ | 6.3.1 Definition of LCS charging information ..... | 24 |
55
+ | 6.3.1.1 LCS charging information assignment for Service Information ..... | 24 |
56
+ | 6.3.1.2 Definition of the LCS Information ..... | 25 |
57
+ | <b>Annex A (informative): Bibliography .....</b> | <b>26</b> |
58
+ | Annex B (informative): Change history..... | 27 |
59
+
60
+ # --- Foreword
61
+
62
+ This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP).
63
+
64
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
65
+
66
+ Version x.y.z
67
+
68
+ where:
69
+
70
+ - x the first digit:
71
+ - 1 presented to TSG for information;
72
+ - 2 presented to TSG for approval;
73
+ - 3 or greater indicates TSG approved document under change control.
74
+ - y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
75
+ - z the third digit is incremented when editorial only changes have been incorporated in the document.
76
+
77
+ # --- 1 Scope
78
+
79
+ The present document is part of a series of documents that specify charging functionality and charging management in GSM/UMTS networks. The GSM/UMTS core network charging architecture and principles are specified in 3GPP TS 32.240 [1], which provides an umbrella for other charging management documents that specify
80
+
81
+ - the content of the CDRs per domain and subsystem (offline charging);
82
+ - the content of real-time charging events per domain / subsystem (online charging);
83
+ - the functionality of online and offline charging for those domains and subsystems;
84
+ - the interfaces that are used in the charging framework to transfer the charging information (i.e. CDRs or charging events).
85
+
86
+ The complete document structure for these TSs is defined in 3GPP TS 32.240 [1].
87
+
88
+ The present document specifies the LCS Offline and Online Charging description for the LCS domain, based on the functional stage 2 description of the LCS in 3GPP TS 23.071 [201]. This charging description includes the offline and online charging architecture and scenarios specific to the LCS, as well as the mapping of the common 3GPP architecture specified in TS 32.240 [1] onto the LCS domain. It further specifies the structure and content of the CDRs for offline charging and the charging events for online charging. The present document is related to other 3GPP charging TSs as follows:
89
+
90
+ - The common 3GPP charging architecture is specified in TS 32.240 [1];
91
+ - The parameters, abstract syntax and encoding rules for these CDR types are specified in TS 32.298 [51].
92
+ - A transaction based mechanism for the transfer of CDRs within the network is specified in TS 32.295 [54].
93
+ - The file based mechanism used to transfer the CDRs from the network to the operator's billing domain (e.g. the billing system or a mediation device) is specified in TS 32.297 [52].
94
+ - The 3GPP Diameter application that is used for LCS domain offline and online charging is specified in TS 32.299 [50].
95
+
96
+ All terms, definitions and abbreviations, used in the present document, that are common across 3GPP TSs, are defined in 3GPP TR 21.905 [100]. Those that are common across charging management in GSM/UMTS domains, services, or subsystems are provided in the umbrella document 3GPP TS 32.240 [1] and are copied into clause 3 of the present document for ease of reading. Finally, those items that are specific to the present document are defined exclusively in the present document.
97
+
98
+ Furthermore, requirements that govern the charging work are specified in 3GPP TS 22.115 [102].
99
+
100
+ # --- 2 References
101
+
102
+ The following documents contain provisions, which through reference in this text, constitute provisions of the present document.
103
+
104
+ - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
105
+ - For a specific reference, subsequent revisions do not apply.
106
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
107
+
108
+ [1] 3GPP TS 32.240: "Telecommunication management; Charging management; Charging architecture and principles".
109
+
110
+ [2]-[9] Void.
111
+
112
+ - [10] 3GPP TS 32.250: "Telecommunication management; Charging management; Circuit Switched (CS) domain charging".
113
+ - [11]-[19] Void.
114
+ - [20] 3GPP TS 32.260: "Telecommunication management; Charging management; IP Multimedia Subsystem (IMS) charging".
115
+ - [21]-[29] Void.
116
+ - [30] 3GPP TS 32.270: "Telecommunication management; Charging management; Multimedia Messaging Service (MMS) charging".
117
+ - [31]-[49] Void
118
+ - [50] 3GPP TS 32.299: "Telecommunication management; Charging management; Diameter charging application".
119
+ - [51] 3GPP TS 32.298: "Telecommunication management; Charging management; Charging Data Record (CDR) encoding rules description".
120
+ - [52] 3GPP TS 32.297: "Telecommunication management; Charging management; Charging Data Record (CDR) file format and transfer".
121
+ - [53] 3GPP TS 32.296: "Telecommunication management; Charging management; Online Charging System (OCS) applications and interfaces".
122
+ - [54] 3GPP TS 32.295: "Telecommunication management; Charging management; Charging Data Record (CDR) transfer".
123
+ - [55]-[99] Void.
124
+ - [100] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications".
125
+ - [101]-[199] Void.
126
+ - [200] Void.
127
+ - [201] 3GPP TS 23.271: "Location Services (LCS); Functional description; Stage 2".
128
+ - [202] Void.
129
+ - [203] 3GPP TS 25.305: "User Equipment (UE) positioning in Universal Terrestrial Radio Access Network (UTRAN); Stage 2".
130
+ - [204] 3GPP TS 43.059: "Functional stage 2 description of Location Services (LCS) in GERAN".
131
+ - [206]-[299] Void.
132
+ - [301]-[399] Void.
133
+ - [400] Void.
134
+ - [401] RFC 3588: "Diameter Base Protocol".
135
+ - [402] IETF RFC 4006: "Diameter Credit Control Application".
136
+
137
+ # 3 Definitions, symbols and abbreviations
138
+
139
+ ## 3.1 Definitions
140
+
141
+ For the purposes of the present document, the terms and definitions defined in 3GPP TR 21.905 [100] and 3GPP TS 32.240 [1], and the following apply:
142
+
143
+ **accounting:** process of apportioning charges between the Home Environment, Serving Network and Subscriber.
144
+
145
+ **billing:** function whereby CDRs generated by the charging function(s) are transformed into bills requiring payment.
146
+
147
+ **Billing Domain:** part of the operator network, which is outside the telecommunications network, that receives and processes CDR files from the network charging functions. It includes functions that can provide billing mediation and billing or other (e.g. statistical) end applications. It is only applicable to offline charging (see “Online Charging System” for equivalent functionality in online charging).
148
+
149
+ **CDR field categories:** the CDR fields are defined in the present document. They are divided into the following categories:
150
+
151
+ - Mandatory (**M**): field that shall always be present in the CDR.
152
+ - Conditional (**C**): field that shall be present in a CDR if certain conditions are met.
153
+ - Operator Provisionable: Mandatory (**O<sub>m</sub>**): A field that operators have provisioned to always be included in the CDR.
154
+ - Operator Provisionable: Conditional (**O<sub>c</sub>**): A field that operators have provisioned to be included in the CDR if certain conditions are met.
155
+
156
+ **chargeable event:** activity utilizing telecommunications network resources and related services for:
157
+
158
+ - user to user communication (e.g. a single call, a data communication session or a short message); or
159
+ - user to network communication (e.g. service profile administration); or
160
+ - inter-network communication (e.g. transferring calls, signalling, or short messages); or
161
+ - mobility (e.g. roaming or inter-system handover); and
162
+ - that the network operator may want to charge for.
163
+
164
+ As a minimum, a chargeable event characterises the resource / service usage and indicates the identity of the involved end user(s).**charging:** a function within the telecommunications network and the associated OCS/BD components whereby information related to a chargeable event is collected, formatted, transferred and evaluated in order to make it possible to determine usage for which the charged party may be billed.
165
+
166
+ **Charging Data Record (CDR):** a formatted collection of information about a chargeable event (e.g. time of call set-up, duration of the call, amount of data transferred, etc) for use in billing and accounting. For each party to be charged for parts of or all charges of a chargeable event a separate CDR shall be generated, i.e. more than one CDR may be generated for a single chargeable event, e.g. because of its long duration, or because more than one charged party is to be charged.
167
+
168
+ **charging event:** a set of charging information forwarded by the CTF towards the CDF (offline charging) or towards the OCS (online charging). Each charging event matches exactly one chargeable event.
169
+
170
+ **charging function:** entity inside the network domain, subsystem or service that is involved in charging for that domain, subsystem or service.
171
+
172
+ **circuit switched domain:** domain within GSM / UMTS in which information is transferred in circuit switched mode.
173
+
174
+ **credit control:** Editor's note: FFS.
175
+
176
+ **domain:** part of a communication network that provides network resources using a certain bearer technology.
177
+
178
+ **Fully Qualified Partial CDR (FQPC):** partial CDR that contains a complete set of the fields specified in the present document. This includes all the mandatory and conditional fields as well as those fields that the PLMN operator has provisioned to be included in the CDR. The first Partial CDR shall be a Fully qualified Partial CDR.
179
+
180
+ **LCS Client:** software and/or hardware entity that interacts with a LCS Server for the purpose of obtaining location information for one or more Mobile Stations
181
+
182
+ LCS Clients subscribe to LCS in order to obtain location information. LCS Clients may or may not interact with human users. The LCS Client is responsible for formatting and presenting data and managing the user interface (dialogue). The LCS Client may reside in the Mobile Station (UE).
183
+
184
+ **LCS Server:** software and/or hardware entity offering LCS capabilities. The LCS Server accepts requests, services requests, and sends back responses to the received requests
185
+
186
+ The LCS server consists of LCS components, which are distributed to one or more PLMN and/or service provider.
187
+
188
+ **Location Based Service (LBS):** service provided either by teleoperator or a 3<sup>rd</sup> party service provider that utilizes the available location information of the terminal
189
+
190
+ Location Application offers the User Interface for the service. LBS is either a pull or a push type of service (see Location Dependent Services and Location Independent Services). In ETSI/GSM documentation of SoLSA, LBS is called "Location Related Service". ETSI and/or 3GPP -wide terminology harmonization is expected here.
191
+
192
+ **location estimate:** geographic location of an UE and/or a valid Mobile Equipment (ME), expressed in latitude and longitude data
193
+
194
+ The Location Estimate shall be represented in a well-defined universal format. Translation from this universal format to another geographic location system may be supported, although the details are considered outside the scope of the primitive services.
195
+
196
+ **middle tier (charging) TS:** used for the 3GPP charging TSs that specify the domain / subsystem / service specific, online and offline, charging functionality. These are all the TSs in the numbering range from 3GPP TS 32.250 to 3GPP TS 32.279, e.g. 3GPP TS 32.250 [10] for the CS domain, or 3GPP TS 32.270 [30] for the MMS service. Currently, there is only one "tier 1" TS in 3GPP, which is TS 32.240 [1] that specifies the charging architecture and principles. Finally, there are a number of top tier TSs in the 32.29x numbering range ([50] ff) that specify common charging aspects such as parameter definitions, encoding rules, the common billing domain interface or common charging applications.
197
+
198
+ **offline charging:** charging mechanism where charging information **does not** affect, in real-time, the service rendered.
199
+
200
+ **online charging:** charging mechanism where charging information can affect, in real-time, the service rendered and therefore a direct interaction of the charging mechanism with bearer/session/service control is required.
201
+
202
+ **Online Charging System:** **Editor's note: FFS.**
203
+
204
+ **packet switched domain:** domain within GSM / UMTS in which data is transferred in packet switched mode. Corresponds to the term "GPRS".
205
+
206
+ **partial CDR:** CDR that provides information on part of a subscriber session. A long session may be covered by several partial CDRs. Two formats are considered for Partial CDRs. One that contains all of the specified fields (FQPC); the second has a reduced format (RPC).
207
+
208
+ **Positioning method (/locating method):** method or technical solution, which is used to get an estimate of the target mobile's geographical location
209
+
210
+ **EXAMPLE:** Positioning methods based on radio cell coverage, GPS or Assisted GPS methods, which are based on the Time-Of-Arrival (TOA) algorithm, and OTDOA or E-OTD methods, which are based on the Time-Difference-Of-Arrival (TDOA) algorithm. The positioning methods are further described in UTRAN Stage 2, 3GPP TS 25.305 [203] and GERAN Stage 2, 3GPP TS 43.059 [204].
211
+
212
+ **target UE:** UE being positioned
213
+
214
+ **user:** an entity, not part of the 3GPP System, that uses network resources by means of a subscription. The user may or may not be identical to the subscriber holding that subscription.
215
+
216
+ **User Equipment (UE):** a device allowing a user access to network services. For the purpose of 3GPP specifications the interface between the UE and the network is the radio interface. A User Equipment can be subdivided into a number of domains, the domains being separated by reference points. Currently defined domains are the USIM and ME Domains. The ME Domain can further be subdivided into several components showing the connectivity between multiple
217
+
218
+ functional groups. These groups can be implemented in one or more hardware devices. An example of such a connectivity is the TE – MT interface. Further, an occurrence of a User Equipment is an MS for GSM as defined in GSM TS 04.02.UE in the present document may also refer to a Mobile Equipment or User Equipment used for emergency calls, that do not have valid SIM or USIM.
219
+
220
+ ## 3.2 Symbols
221
+
222
+ For the purposes of the present document, the following symbols apply:
223
+
224
+ | | |
225
+ |----|------------------------------------------------------------------------|
226
+ | B1 | Reference point for the CDR file transfer from the GMLC CGF to the BD, |
227
+ | Lr | Interface between Gateway MLCs |
228
+
229
+ ## 3.3 Abbreviations
230
+
231
+ For the purposes of the present document, the abbreviations defined in 3GPP TR 21.905 [100], 3GPP TS 23.271 [20] and 3GPP TS 32.240 [1], and the following apply:
232
+
233
+ | | |
234
+ |--------|-----------------------------------------------------------------------------------|
235
+ | 3G | 3 <sup>rd</sup> Generation |
236
+ | 3GPP | 3 <sup>rd</sup> Generation Partnership Project |
237
+ | AVP | Attribute Value Pair |
238
+ | BD | Billing Domain |
239
+ | CCA | Credit Control Answer |
240
+ | CCR | Credit Control Request |
241
+ | CDF | Charging Data Function |
242
+ | CDR | Charging Data Records |
243
+ | CGF | Charging Gateway Function |
244
+ | CS | Circuit-Switched |
245
+ | CTF | Charging Trigger Function |
246
+ | DCCA | Diameter Credit Control Application |
247
+ | ECUR | Event Charging with Unit Reservation |
248
+ | FTAM | File Transfer, Access and Management |
249
+ | GERAN | GSM EDGE Radio Access Network |
250
+ | GGSN | Gateway GPRS Support Node |
251
+ | GMLC | Gateway MLC |
252
+ | GPRS | General Packet Radio Service |
253
+ | GSM | Global System for Mobile communication |
254
+ | gsmSCF | GSM Service Control Function |
255
+ | H-GMLC | Home GMLC |
256
+ | HLR | Home Location Register |
257
+ | HPLMN | Home PLMN |
258
+ | HSS | Home Subscriber Server |
259
+ | IEC | Immediate Event Charging |
260
+ | IETF | Internet Engineering Task Force |
261
+ | IMS | IP Multimedia Subsystem |
262
+ | IMSI | International Mobile Subscriber Identity |
263
+ | IP | Internet Protocol |
264
+ | ITU-T | International Telecommunication Union - Telecommunications standardization sector |
265
+ | LCS | LoCation Service |
266
+ | MAP | Mobile Application Part |
267
+ | ME | Mobile Equipment |
268
+ | MO | Mobile Originated |
269
+ | MO-LR | Mobile Originated - Location Request |
270
+ | MS | Mobile Station |
271
+ | MSISDN | Mobile Station Integrated Services Data Network |
272
+ | MT | Mobile Terminated |
273
+ | MT-LR | Mobile Terminated - Location Request |
274
+ | NI-LR | Network Induced - Location Request |
275
+ | OCS | Online Charging System |
276
+ | PLMN | Public Land Mobile Network |
277
+ | PMD | Pseudonym Mediation Device functionality |
278
+ | PPR | Privacy Profile Register |
279
+ | PS | Packet Switched |
280
+
281
+ | | |
282
+ |--------|--------------------------------------------|
283
+ | RAN | Radio Access Network |
284
+ | R-GMLC | Requesting - GMLC |
285
+ | RPC | Reduced Partial CDR |
286
+ | SGSN | Serving GPRS Support Node |
287
+ | TR | Technical Report |
288
+ | TS | Technical Specification |
289
+ | UE | User Equipment |
290
+ | UMTS | Universal Mobile Telecommunications System |
291
+ | USIM | User Service Identity Module |
292
+ | UTRAN | Universal Terrestrial Radio Access Network |
293
+ | V-GMLC | Visited GMLC |
294
+ | VPLMN | Visited PLMN |
295
+
296
+ # 4 Architecture considerations
297
+
298
+ ## 4.1 High level LCS architecture
299
+
300
+ Figure 4.1 depicts the logical LCS architecture, as described in 3GPP TS 23.271 [201].
301
+
302
+ ![Figure 4.1: LCS logical architecture with inter-GMLC [Lr] interface. The diagram shows the logical architecture of the Location Service (LCS) within a Visited Packet Core Network (VPMLN). On the left, User Equipment (UE) connects to GERAN (via Um) and UTRAN (via Uu). GERAN connects to a 2G-MSC (via A) and a 2G-SGSN (via Gb). UTRAN connects to a 3G-SGSN (via Iu) and an MSC server (via Iu). The 2G-MSC and 2G-SGSN connect to a Visited GMLC (V-GMLC) via Lg interfaces. The 3G-SGSN and MSC server also connect to the V-GMLC via Lg interfaces. The V-GMLC connects to a Home GMLC (H-GMLC) via an Lr interface. The H-GMLC connects to a Requesting GMLC (R-GMLC) via an Lr interface. The R-GMLC connects to an External LCS Client via an Le interface. The R-GMLC also connects to a PMD (via Lid) and an HSS/HLR (via Lh). The H-GMLC connects to a PMD (via Lid) and an HSS/HLR (via Lh). The V-GMLC connects to a PMD (via Lid) and a PPR (via Lpp). The H-GMLC connects to a gsmSCF (via Lc) and a PMD (via Lid). The gsmSCF connects to the External LCS Client via an OSA-LCS interface. The VPMLN is indicated by a double-headed arrow at the top.](c2fc2621e8206d24427b56bcb2398fc0_img.jpg)
303
+
304
+ Figure 4.1: LCS logical architecture with inter-GMLC [Lr] interface. The diagram shows the logical architecture of the Location Service (LCS) within a Visited Packet Core Network (VPMLN). On the left, User Equipment (UE) connects to GERAN (via Um) and UTRAN (via Uu). GERAN connects to a 2G-MSC (via A) and a 2G-SGSN (via Gb). UTRAN connects to a 3G-SGSN (via Iu) and an MSC server (via Iu). The 2G-MSC and 2G-SGSN connect to a Visited GMLC (V-GMLC) via Lg interfaces. The 3G-SGSN and MSC server also connect to the V-GMLC via Lg interfaces. The V-GMLC connects to a Home GMLC (H-GMLC) via an Lr interface. The H-GMLC connects to a Requesting GMLC (R-GMLC) via an Lr interface. The R-GMLC connects to an External LCS Client via an Le interface. The R-GMLC also connects to a PMD (via Lid) and an HSS/HLR (via Lh). The H-GMLC connects to a PMD (via Lid) and an HSS/HLR (via Lh). The V-GMLC connects to a PMD (via Lid) and a PPR (via Lpp). The H-GMLC connects to a gsmSCF (via Lc) and a PMD (via Lid). The gsmSCF connects to the External LCS Client via an OSA-LCS interface. The VPMLN is indicated by a double-headed arrow at the top.
305
+
306
+ Figure 4.1: LCS logical architecture with inter-GMLC [Lr] interface
307
+
308
+ As can be seen in figure 4.1, the following LCS elements are relevant for charging:
309
+
310
+ - V-GMLC,
311
+ - H-GMLC
312
+ - R-GMLC.
313
+
314
+ **Editor's note:** Add a statement stating that the SGSN and the MSC have also a role in the LCS Charging and that the associated LCS Charging functionality is described in TS 32.250 and TS 32.251
315
+
316
+ ## 4.2 LCS offline charging architecture
317
+
318
+ As described in TS 32.240 [1], the CTF (an integrated component in each charging relevant NE) generates charging events and forwards them to the CDF. The CDF, in turn, generates CDRs which are then transferred to the CGF. Finally, the CGF creates CDR files and forwards them to the Billing Domain.
319
+
320
+ In LCS, all charging functions (CTF, CDF and CGF) reside within the LCS R/S. I.e. the GMLC is connected directly to the Billing Domain via the B1 interface. B1 is the LCS specific variant of the common Bx interface. This architecture implies that there exists no separate CDF and CGF for LCS, i.e. no corresponding open interfaces between any such functions, within the 3GPP standards.
321
+
322
+ Figure 4.2 depicts the mapping of the 3GPP common charging architecture, as laid down in 3GPP TS 32.240 [1], onto the LCS.
323
+
324
+ **Editor's note: A clarification for the LCS offline charging reference point is in discussion**
325
+
326
+ ![Diagram of LCS offline charging architecture showing GMLC connected to BD via B1 interface.](c78c2eefd86269d1740ab85a916f24f2_img.jpg)
327
+
328
+ The diagram illustrates the LCS offline charging architecture. On the left, a green rectangular box labeled 'GMLC' contains a smaller grey box labeled 'CDF/CGF'. A blue arrow points from the 'CDF/CGF' box to a yellow rectangular box on the right labeled 'BD'. Above the arrow, a white box labeled 'B1' indicates the interface between the GMLC and the BD.
329
+
330
+ Diagram of LCS offline charging architecture showing GMLC connected to BD via B1 interface.
331
+
332
+ **Figure 4.2: LCS offline charging architecture**
333
+
334
+ In addition to the standard approach depicted in figure 4.2, vendors may choose to implement separate CDF and CGF for LCS. In that case, the interfaces between these functions should comply with the definition of the Rf and Ga interfaces (3GPP TS 32.299 [50] and 3GPP TS 32.295 [54], respectively) as much as possible.
335
+
336
+ ## 4.3 LCS online charging architecture
337
+
338
+ LCS online charging is based on GMLC functionality that is further specified in the present document. For online charging, the GMLC utilises the Ro interface and application towards the OCS as specified in TS 32.299 [50]. The Ro reference point covers all online charging functionality required for LCS.
339
+
340
+ The LCS online charging architecture is depicted in figure 4.3.
341
+
342
+ ![Diagram of LCS online charging architecture showing GMLC connected to Online Charging System via Ro interface.](536951b2bbd94325ae266d8d1363df8f_img.jpg)
343
+
344
+ The diagram illustrates the LCS online charging architecture. On the left, a white rectangular box labeled 'GMLC' is connected by a horizontal line to a large blue rectangular box on the right labeled 'Online Charging System'. The connection line is labeled 'Ro'.
345
+
346
+ Diagram of LCS online charging architecture showing GMLC connected to Online Charging System via Ro interface.
347
+
348
+ **Figure 4.3: LCS online charging architecture**
349
+
350
+ Details on the interfaces and functions can be found in TS 32.240 [1] for the general architecture components, TS 32.296 [53] for the OCS, and TS 32.299 [50] for the Ro application.
351
+
352
+ # 5 LCS charging principles and scenarios
353
+
354
+ **Editor's note:** Include a brief introduction statement saying that this clause contains the CDR and charging event types and their trigger conditions.
355
+
356
+ ## 5.1 LCS charging principles
357
+
358
+ Charging information in the Service domain for LCS is collected for inter-operator charging purpose by the GMLC. The basic principle is that a network requesting location information may be charged by the network that provides the location information.
359
+
360
+ The GMLC shall collect the following charging information:
361
+
362
+ - Identity of the mobile subscriber to be located and of the entity requesting the location;
363
+ - Identity of the GMLC or PLMN serving the LCS Client;
364
+ - QoS Requested/Delivered: the charging information shall describe the quality of the location requested and delivered to the LCS client;
365
+ - Request Timestamp: the charging information shall record the date and time the location procedure was requested by the LCS client;
366
+ - Location services requested: the charging information shall describe the service types for which the LCS client is allowed to locate the particular UE;
367
+ - Usage of continuous/periodic tracking;
368
+ - Charging for Location Based Services (LBS): the charging information shall describe the service specific information in addition to the above location resource information.
369
+
370
+ The information listed above is captured for use cases in relation to:
371
+
372
+ - Mobile Originated Location Request;
373
+ - Mobile Terminated Location Request;
374
+ - Network Induced Location Request;
375
+
376
+ Refer to TS 23.271 [201] for further details on the above LCS transactions.
377
+
378
+ ## 5.2 LCS offline charging scenarios
379
+
380
+ ### 5.2.1 Basic principles
381
+
382
+ **Editor's note:** TBD.
383
+
384
+ ### 5.2.2 Rf message flows
385
+
386
+ Not applicable, as the separation of the CTF and CDF is not in the scope of the LCS charging standards. Refer to clause 4.2 for further information.
387
+
388
+ Note: Vendors may nevertheless implement a separate CTF and CDF for LCS charging. In this case, it is recommended that the approach chosen conforms to the principles and protocol applications specified in TS 32.299 [50].
389
+
390
+ ### 5.2.3 CDR Generation
391
+
392
+ **Editor's note:** This section shall also include the triggers of the CDR generation, the CDR types
393
+
394
+ The flows described in the present document specify the charging communications between the GMLC and the billing function for different charging scenarios. The LCS related messages associated with these charging scenarios are shown primarily for general information and to illustrate the charging triggers.
395
+
396
+ For the purpose of these examples, the following assumptions have been made:
397
+
398
+ - that the RAN location procedures are not depicted;
399
+ - that the CS and PS location procedures are not distinguished;
400
+ - that the LCS client has no privacy override capability;
401
+ - that the LCS charging procedures in the CS and the PS domains are not depicted
402
+
403
+ #### 5.2.3.1 Mobile originated location request (MO-LR)
404
+
405
+ Mobile Originated location request allows the UE to obtain its own geographical location or have its location information transferred to another LCS client. In this procedure, the R-GMLC, H-GMLC and V-GMLC are the same as no privacy checking is performed.
406
+
407
+ Figure 5.2.3.1 illustrates a Mobile Originated Location Request that allows a UE to request its own location.
408
+
409
+ ![Sequence diagram for Mobile Originated Location Request (MO-LR) within a Home Network. The diagram shows four lifelines: LCS Client, GMLC, MSC/SGSN, and UE. The sequence of messages is: 1. Location Services Invoke from UE to MSC/SGSN; 2. MAP Subscriber Location Report from MSC/SGSN to GMLC; 3. Location Information from GMLC to LCS Client; 4. Location Information ack from LCS Client to GMLC; 5. MAP Subscriber Location Report ack from GMLC to MSC/SGSN (marked with a circled '1'); 6. LCS MO-LR Return Result from MSC/SGSN to UE.](4636adff5682a064f0ae5f13a1d464a6_img.jpg)
410
+
411
+ ```
412
+
413
+ sequenceDiagram
414
+ participant UE
415
+ participant MSC/SGSN
416
+ participant GMLC
417
+ participant LCS_Client as LCS Client
418
+ Note over all: Home Network
419
+ UE->>MSC/SGSN: 1. Location Services Invoke
420
+ MSC/SGSN->>GMLC: 2. MAP Subscriber Location Report
421
+ GMLC->>LCS_Client: 3. Location Information
422
+ LCS_Client->>GMLC: 4. Location Information ack
423
+ GMLC->>MSC/SGSN: 5. MAP Subscriber Location Report ack (1)
424
+ MSC/SGSN->>UE: 6. LCS MO-LR Return Result
425
+
426
+ ```
427
+
428
+ Sequence diagram for Mobile Originated Location Request (MO-LR) within a Home Network. The diagram shows four lifelines: LCS Client, GMLC, MSC/SGSN, and UE. The sequence of messages is: 1. Location Services Invoke from UE to MSC/SGSN; 2. MAP Subscriber Location Report from MSC/SGSN to GMLC; 3. Location Information from GMLC to LCS Client; 4. Location Information ack from LCS Client to GMLC; 5. MAP Subscriber Location Report ack from GMLC to MSC/SGSN (marked with a circled '1'); 6. LCS MO-LR Return Result from MSC/SGSN to UE.
429
+
430
+ **Figure 5.2.3.1: Record trigger overview for MO-LR**
431
+
432
+ 1. The MSC (or SGSN) receives a Location Service Invoke from the UE
433
+ 2. The MSC (or SGSN) forwards the Location result to the GMLC by sending a MAP Subscriber Location Report
434
+ 3. The GMLC transfers the location information to the LCS client.
435
+ 4. The LCS Client sends to the GMLC the Location Information ack message signalling the result.
436
+ 5. The GMLC acknowledges the MAP Subscriber Location Report and the associated MO-LR CDR is processed as specified in TS 32.297 [52].
437
+ 6. The MSC (or SGSN) returns a Service Response message to the UE carrying any location estimate requested by the UE
438
+
439
+ The record trigger associated to the MO-LR is called 'LCS GMLC Mobile Originated' (LCS-GMO)
440
+
441
+ #### 5.2.3.2 Mobile terminated location request (MT-LR)
442
+
443
+ Mobile terminated location request allows an external LCS client to ask for the location of a mobile subscriber (target UE).
444
+
445
+ Figure 5.2.3.2 illustrates a Mobile Terminated Location Request scenario:
446
+
447
+ ![Sequence diagram for Mobile Terminated Location Request (MT-LR) showing interactions between Requesting Network (LCS Client, GMLC), Home Network (GMLC, HLR/HSS), and Visited Network (GMLC, MSC/SGSN, UE).](1b5a812c8aa20fd5cba28e97001d32de_img.jpg)
448
+
449
+ ```
450
+
451
+ sequenceDiagram
452
+ participant LCS_Client as LCS Client
453
+ participant GMLC_R as GMLC (Requesting)
454
+ participant GMLC_H as GMLC (Home)
455
+ participant HLR_HSS as HLR/HSS
456
+ participant GMLC_V as GMLC (Visited)
457
+ participant MSC_SGSN as MSC/SGSN
458
+ participant UE as UE
459
+
460
+ Note left of GMLC_R: Requesting Network
461
+ Note left of GMLC_H: Home Network
462
+ Note left of GMLC_V: Visited Network
463
+
464
+ LCS_Client->>GMLC_R: 1. Location Service Request
465
+ GMLC_R->>HLR_HSS: 2. Send Routing Info for LCS
466
+ HLR_HSS-->>GMLC_R: 3. Send Routing Info for LCS ack
467
+ GMLC_R->>GMLC_H: 4. LCS Service Request
468
+ Note right of GMLC_H: Privacy Check
469
+ GMLC_H->>HLR_HSS: 5. Send Routing Info for LCS
470
+ HLR_HSS-->>GMLC_H: 6. Send Routing Info for LCS ack
471
+ GMLC_H->>GMLC_V: 7. LCS Service Request
472
+ GMLC_V->>MSC_SGSN: 8. Provide Subscriber Location
473
+ Note right of MSC_SGSN: MT-LR procedures for CS and PS Domain
474
+ MSC_SGSN-->>GMLC_V: 9. Provide Subscriber Location ack
475
+ Note right of GMLC_V: LCS-VGMT-CDR Processing
476
+ GMLC_V->>GMLC_H: 10. LCS Service Response
477
+ Note right of GMLC_H: Privacy Check
478
+ Note right of GMLC_H: LCS-HGMT-CDR Processing
479
+ GMLC_H->>GMLC_R: 11. LCS Service Response
480
+ Note right of GMLC_R: LCS-RGMT-CDR Processing
481
+ GMLC_R->>LCS_Client: 12. LCS Service Response
482
+
483
+ ```
484
+
485
+ Sequence diagram for Mobile Terminated Location Request (MT-LR) showing interactions between Requesting Network (LCS Client, GMLC), Home Network (GMLC, HLR/HSS), and Visited Network (GMLC, MSC/SGSN, UE).
486
+
487
+ Figure 5.2.3.2: Record trigger overview for MT-LR
488
+
489
+ 1. The external LCS client requests the location of a target UE from the R-GMLC
490
+ 2. The R-GMLC requests the H-GMLC address by sending a MAP Send Routing Info for LCS message to the home HLR/HSS of the target UE to be located
491
+
492
+ 3. The HLR/HSS returns a MAP Send Routing Info for LCS ack message that contains the H-GMLC address
493
+ 4. The R-GMLC forwards the Location Service Request to the H-GMLC
494
+ 5. After performing privacy check, the H-GMLC requests the V-GMLC address by sending a MAP Send Routing Info for LCS message to the home HLR/HSS
495
+ 6. The HLR/HSS returns a MAP Send Routing Info for LCS ack message that contains the V-GMLC address
496
+ 7. The H-GMLC forwards the Location Service Request to the V-GMLC
497
+ 8. The V-GMLC forwards the Location request to the MSC or SGSN by sending a MAP Provider Subscriber Location Report
498
+ 9. After either a CS-MT-LR or PS-MT-LR was processed, the MSC or SGSN sends the acknowledgement of the MAP Provider Subscriber Location Report
499
+ The associated LCS VGMT CDR is processed as specified in TS 32.297 [52]
500
+ 10. The V-GMLC sends the location service response to the H-GMLC. After the H-GMLC has performed privacy check, the associated LCS HGMT CDR is processed as specified in TS 32.297 [52]
501
+ 11. The H-GMLC sends the location service response to the R-GMLC and the associated LCS RGMT CDR is processed as specified in TS 32.297 [52].
502
+ 12. The R-GMLC returns a Service Response message to the LCS client carrying any location estimate requested by the LCS client
503
+
504
+ #### 5.2.3.3 Network induced location request (NI-LR)
505
+
506
+ Network induced location request allows positioning for an emergency service call.
507
+
508
+ Figure 5.2.3.3 illustrates a Network Induced Location Request scenario:
509
+
510
+ ![Sequence diagram for Network Induced Location Request (NI-LR) scenario. The diagram shows four lifelines: LCS Client, GMLC, MSC/SGSN, and UE, all within a 'Home Network' frame. The sequence of messages is: 1. LCS Emergency Call Origination (UE to LCS Client); 2. Messages for individual positioning methods (UE to MSC/SGSN); 3. MAP Subscriber Location Report (MSC/SGSN to GMLC); 4. MAP Subscriber Location Report ack (GMLC to MSC/SGSN); 5. Location Information (GMLC to LCS Client), which also triggers 'LCS GNI CDR Processing' (GMLC to itself); 6. LCS Emergency Call Release (LCS Client to UE).](41a438d7e4adc17c3a4005e7c9500091_img.jpg)
511
+
512
+ Sequence diagram for Network Induced Location Request (NI-LR) scenario. The diagram shows four lifelines: LCS Client, GMLC, MSC/SGSN, and UE, all within a 'Home Network' frame. The sequence of messages is: 1. LCS Emergency Call Origination (UE to LCS Client); 2. Messages for individual positioning methods (UE to MSC/SGSN); 3. MAP Subscriber Location Report (MSC/SGSN to GMLC); 4. MAP Subscriber Location Report ack (GMLC to MSC/SGSN); 5. Location Information (GMLC to LCS Client), which also triggers 'LCS GNI CDR Processing' (GMLC to itself); 6. LCS Emergency Call Release (LCS Client to UE).
513
+
514
+ **Figure 5.2.3.3: Record trigger overview for NI-LR**
515
+
516
+ 1. An emergency call procedure is initiated between the UE and the LCS client
517
+ 2. Positioning procedures are instigated
518
+ 3. The MSC (or SGSN) forwards the Location request to the GMLC by sending a MAP Subscriber Location Report
519
+ 4. The GMLC acknowledges the MAP Subscriber Location Report
520
+ 5. The GMLC transfers the location information to the LCS client and the associated LCS-GNI-CDR is processed as specified in TS 32.297 [52].
521
+ 6. At some later time, the emergency services call is released.
522
+
523
+ ### 5.2.4 Ga record transfer flows
524
+
525
+ Not applicable, as the separation of the CDF and CGF is not in the scope of the LCS charging standards. Refer to clause 4.3 for further information.
526
+
527
+ **NOTE:** Vendors may nevertheless implement a separate CDF and CGF for LCS charging. In this case, it is recommended that the approach chosen conforms to the principles and protocol applications specified in TS 32.295 [54].
528
+
529
+ ### 5.2.5 B<sub>L</sub> CDR file transfer
530
+
531
+ The integrated CGF of the GMLC transfers the CDR files to the BD as described in TS 32.297 [52]. In LCS, both fully qualified partial CDRs (FQPC) and reduced partial CDRs (RPC), as specified in TS 32.240 [1] may be supported on the B<sub>L</sub> interface. In line with TS 32.240 [13], the support of FQPCs is mandatory, the support of RPCs is optional. For further details on the B<sub>L</sub> protocol application refer to TS 32.297 [52].
532
+
533
+ ## 5.3 LCS online charging scenarios
534
+
535
+ LCS online charging uses the credit control application as specified in TS 32.299 [50].
536
+
537
+ ### 5.3.1 Basic principles
538
+
539
+ *Editors Note: This section should be updated and aligned with 32.299. Some of this text will go into 32.299 and removed from this TS.*
540
+
541
+ Two cases for online charging are distinguished:
542
+
543
+ - Immediate Event Charging (IEC); and
544
+ - Event Charging with Unit Reservation (ECUR).
545
+
546
+ In the case of Immediate Event Charging (IEC), granting units to the GMLC is performed in a single operation that also includes the deduction of the corresponding monetary units from the subscriber's account. The charging process is controlled by the corresponding credit control request which is sent for a given credit control event.
547
+
548
+ In contrast, Event Charging with Unit Reservation (ECUR) also includes the process of requesting, reserving units and releasing and returning unused units. The deduction of the corresponding monetary units then occurs upon conclusion of the ECUR transaction. In this case, the credit control request is used to control the credit control session.
549
+
550
+ The GMLC may apply either IEC, where CCR Event messages are generated, or ECUR, using CCR Initial, Termination and Update. The decision whether to apply IEC or ECUR is based on the service and/or operator's policy.
551
+
552
+ NOTE: To the extent possible alignment with IETF RFC 4006 [402] is planned.
553
+
554
+ *Editor's note: Modify the text above with LCS specific description on what the GMLC requests from the ECF*
555
+
556
+ ### 5.3.2 Ro message flows
557
+
558
+ The message flows described in the present document specify the charging communications between the GMLC and the Online Charging System (OCS) for different charging scenarios. The LCS messages associated with these charging scenarios are shown primarily for general information and to illustrate the charging triggers that are also used for LCS offline charging.
559
+
560
+ #### 5.3.2.1 Mobile originated Location Request (MO-LR)
561
+
562
+ Figure 5.3.2.1 shows the credit control transactions that are required between GMLC and OCS during the mobile originated location request. In this scenario the UE is the party to charge for the location request.
563
+
564
+ ![Sequence diagram for LCS Online charging scenario for MO-LR. The diagram shows three main entities: MSC/SGSN, GMLC, and OCS. The MSC/SGSN sends a MAP Subscriber Location Report to the GMLC. The GMLC performs 'Location Request and UE validation'. It then enters a 'Credit Control Application' block, sending a CCR (Credit Control Request) to the OCS. The OCS performs 'LCS account and tariff validation' and returns a CCA (Credit Control Answer) to the GMLC. The GMLC then performs 'LCS validation and control' and finally sends a MAP Subscriber Location Report Ack back to the MSC/SGSN. The connections between MSC/SGSN and GMLC are labeled 'MAP', and between GMLC and OCS are labeled 'Ro'.](7ec4ba01d21d0840c67e18d51aeb1415_img.jpg)
565
+
566
+ ```
567
+
568
+ sequenceDiagram
569
+ participant MSC/SGSN
570
+ participant GMLC
571
+ participant OCS
572
+ Note over MSC/SGSN, GMLC: MAP
573
+ Note over GMLC, OCS: Ro
574
+ MSC/SGSN->>GMLC: MAP Subscriber Location Report
575
+ Note over GMLC: Location Request and UE validation
576
+ rect rgb(255, 255, 255)
577
+ Note over GMLC, OCS: Credit Control Application
578
+ GMLC->>OCS: CCR
579
+ Note over OCS: LCS account and tariff validation
580
+ OCS-->>GMLC: CCA
581
+ end
582
+ Note over GMLC: LCS validation and control
583
+ GMLC-->>MSC/SGSN: MAP Subscriber Location Report Ack
584
+
585
+ ```
586
+
587
+ Sequence diagram for LCS Online charging scenario for MO-LR. The diagram shows three main entities: MSC/SGSN, GMLC, and OCS. The MSC/SGSN sends a MAP Subscriber Location Report to the GMLC. The GMLC performs 'Location Request and UE validation'. It then enters a 'Credit Control Application' block, sending a CCR (Credit Control Request) to the OCS. The OCS performs 'LCS account and tariff validation' and returns a CCA (Credit Control Answer) to the GMLC. The GMLC then performs 'LCS validation and control' and finally sends a MAP Subscriber Location Report Ack back to the MSC/SGSN. The connections between MSC/SGSN and GMLC are labeled 'MAP', and between GMLC and OCS are labeled 'Ro'.
588
+
589
+ **Figure 5.3.2.1: LCS Online charging scenario for MO-LR**
590
+
591
+ #### 5.3.2.2 Mobile Terminated Location Request (MT-LR)
592
+
593
+ Figure 5.3.2.2 shows the credit control transactions that are required between GMLC and OCS during the mobile terminated location request.
594
+
595
+ ![Sequence diagram showing the interaction between LCS Client, GMLC, and OCS for MT-LR. The LCS Client sends a Location Service Request to the GMLC. The GMLC performs 'Location request and LCS Client validation'. Then, a 'Credit Control Application' block shows the GMLC sending a CCR to the OCS, which performs 'LCS account and tariff validation' and returns a CCA. Finally, the GMLC performs 'LCS validation and account reservation' and sends an LCS Service Response back to the LCS Client. Dashed lines labeled 'Le' and 'Ro' connect the LCS Client to GMLC and GMLC to OCS respectively.](9cd90f495b95ad2116ff780248c26d95_img.jpg)
596
+
597
+ ```
598
+ sequenceDiagram
599
+ participant LCS Client
600
+ participant GMLC
601
+ participant OCS
602
+ Note right of GMLC: Location request and LCS Client validation
603
+ Note right of OCS: LCS account and tariff validation
604
+ Note right of GMLC: LCS validation and account reservation
605
+
606
+ LCS Client->>GMLC: Location Service Request
607
+ GMLC->>OCS: CCR
608
+ OCS-->>GMLC: CCA
609
+ GMLC->>LCS Client: LCS Service Response
610
+ ```
611
+
612
+ Sequence diagram showing the interaction between LCS Client, GMLC, and OCS for MT-LR. The LCS Client sends a Location Service Request to the GMLC. The GMLC performs 'Location request and LCS Client validation'. Then, a 'Credit Control Application' block shows the GMLC sending a CCR to the OCS, which performs 'LCS account and tariff validation' and returns a CCA. Finally, the GMLC performs 'LCS validation and account reservation' and sends an LCS Service Response back to the LCS Client. Dashed lines labeled 'Le' and 'Ro' connect the LCS Client to GMLC and GMLC to OCS respectively.
613
+
614
+ Figure 5.3.2.2: LCS Online charging scenario for MT-LR
615
+
616
+ # 6 Definition of charging information
617
+
618
+ This clause provides Stage 3 specifications of the CDR type and content in line with the CDR type definitions provided in clause 5.2.3 and Diameter Credit Control messages for LCS
619
+
620
+ ## 6.1 Data description for LCS offline charging
621
+
622
+ Dedicated types of CDRs can be generated for LCS by the GMLC. The content of each CDR type is defined in one of the tables that are part of this clause. For each CDR type the parameter definition includes the parameter name, description and category.
623
+
624
+ Equipment vendors shall be able to provide all of the parameters listed in the CDR content table in order to claim compliance with the present document. However, since CDR processing and transport consume network resources, operators may opt to eliminate some of the parameters that are not essential for their operation. This operator provisionable reduction is specified by the parameter category.
625
+
626
+ A parameter category can have one of two primary values:
627
+
628
+ - M** This parameter is **M**andatory and shall always be present in the Diameter messages/CDR.
629
+ - C** This parameter shall be present in the Diameter message/CDR only when certain Conditions are met. These Conditions are specified as part of the parameter definition.
630
+
631
+ Some of these parameters are designated as Operator provisionable (**O**). Using TMN management functions or specific tools provided by an equipment vendor, operators may choose to include or omit the parameter from the charging event/CDR. Once omitted, this parameter is not generated in a CDR of the particular type.. To avoid any potential ambiguity, the CTF/CDF/CGF MUST be able to provide all these parameters. Only an operator can choose whether or not these parameters should be generated in its system, i.e. included in the charging Diameter message/CDR.
632
+
633
+ Those parameters that the operator configures to be present or absent are further qualified with the "Operator provisionable" indicator as follows:
634
+
635
+ - O<sub>m</sub>** This is a parameter that, if provisioned by the operator to be present, shall always be included in the Diameter messages/CDRs. In other words, an **O<sub>m</sub>** parameter that is provisioned to be present is a mandatory parameter.
636
+ - O<sub>c</sub>** This is a parameter that, if provisioned by the operator to be present, shall be included in the Diameter messages/CDRs when the specified conditions are met. In other words, an **O<sub>c</sub>** parameter that is configured to be present is a conditional parameter.
637
+
638
+ The GMLC's CGF shall be able to provide the CDRs at the Billing System interface in the format and encoding described in the present document. In LCS, both fully qualified partial CDRs (FQPC) and reduced partial CDRs (RPC), as specified in TS 32.240 [1] may be supported on the BI interface. In line with TS 32.240 [13], the support of FQPCs is mandatory, the support of RPCs is optional.
639
+
640
+ ### 6.1.1 Rf message contents
641
+
642
+ Not applicable. Refer to subclause 5.2.2 for further information.
643
+
644
+ ### 6.1.2 Ga message contents
645
+
646
+ Not applicable. Refer to subclause 5.2.3 for further information.
647
+
648
+ ### 6.1.3 CDR description on the B<sub>L</sub> interface
649
+
650
+ This clause provides Stage 3 specifications of the CDR type and content for the 3GPP LCS domain. For each of the CDR types, a parameter table, which gives a short description of the parameters, is provided. The detailed specification of the CDR parameters and their encoding is contained in TS 32.298 [51], while TS 32.297 [52] specify the details of the CDR file transfer to the BD.
651
+
652
+ #### 6.1.3.1 LCS Records for Mobile Originated Location Request (LCS-GMO-CDR)
653
+
654
+ If enabled, a LCS GMLC Mobile originated Charging Data Record (LCS-GMO-CDR) shall be produced for each mobile originated location request performed via the GMLC. The fields in the record are specified in table 6.1.3.1, which provides a brief description of each field.
655
+
656
+ **Table 6.1.3.1: LCS GMLC Mobile Originated CDR (LCS-GMO-CDR)**
657
+
658
+ | Field | Category | Description |
659
+ |------------------------------|----------------|------------------------------------------------------------------------------------------------------------------|
660
+ | Record Type | M | LCS GMLC Mobile Originated Record |
661
+ | Recording Entity | M | The E.164 address of this GMLC |
662
+ | LCS Client Type | C | The type of the LCS client that invoked the LR, if available. |
663
+ | LCS Client Identity | C | Further identification of the LCS client, if available. |
664
+ | Served IMSI | M | The IMSI of the subscriber that requests the location. |
665
+ | Served MSISDN | O <sub>m</sub> | The primary MSISDN of the subscriber that requests the location. |
666
+ | Serving Entity | C | The E.164 address of the serving MSC (in case of CS-MO-LR) or SGSN (in case of PS-MO-LR) |
667
+ | Location Estimate | O <sub>c</sub> | The location estimate for the subscriber if contained in geographic position and the LR was successful. |
668
+ | Positioning Data | C | The positioning method used or attempted, if available. |
669
+ | User Error | C | The Location Service type of error if any failure happened |
670
+ | Provider Error | O <sub>c</sub> | The protocol related type of error if any failure happened |
671
+ | Record Time Stamp | O <sub>m</sub> | Time of generation of the CDR |
672
+ | Local Record Sequence Number | O <sub>m</sub> | Consecutive record number created by this node. The number is allocated sequentially including all CDR types. |
673
+ | Record extensions | O <sub>c</sub> | A set of network/manufacturer specific extensions to the record. Conditioned upon the existence of an extension. |
674
+
675
+ #### 6.1.3.2 LCS Records for mobile terminated location request
676
+
677
+ ##### 6.1.3.2.1 LCS Records for Requesting GMLC (LCS-RGMT-CDR)
678
+
679
+ If enabled, a LCS Requesting GMLC Mobile terminated Charging Data Record (LCS-RGMT-CDR) shall be produced for each mobile a terminated location request is performed via the R-GMLC. The fields in the record are specified in table 6.1.3.2.1, which provides a brief description of each field.
680
+
681
+ **Table 6.1.3.2.1: LCS Requesting GMLC Mobile Terminated CDR (LCS-RGMT-CDR)**
682
+
683
+ | Field | Category | Description |
684
+ |------------------------------|----------------|------------------------------------------------------------------------------------------------------------------|
685
+ | Record Type | M | LCS Requesting GMLC Mobile Terminated Record |
686
+ | Recording Entity | M | The E.164 address of this GMLC |
687
+ | Home GMLC Identity | C | If available, the IP address of the HGMLC involved in the location request |
688
+ | LCS Client Type | C | The type of the LCS client that invoked the LR, if available. |
689
+ | LCS Client Identity | C | Further identification of the LCS client, if available. |
690
+ | Target IMSI | M | The IMSI of the targeted LCS subscriber |
691
+ | Target MSISDN | O <sub>m</sub> | The primary MSISDN of the targeted subscriber. |
692
+ | Location Type | M | The type of location information being requested. |
693
+ | LCS Priority | C | Priority of the LR, if available |
694
+ | Result Code | O <sub>m</sub> | The result code that indicate the result of the request or individual positioning |
695
+ | Record Time Stamp | O <sub>m</sub> | Time of generation of the CDR |
696
+ | Local Record Sequence Number | O <sub>m</sub> | Consecutive record number created by this node. The number is allocated sequentially including all CDR types. |
697
+ | Record extensions | O <sub>c</sub> | A set of network/manufacturer specific extensions to the record. Conditioned upon the existence of an extension. |
698
+
699
+ ##### 6.1.3.2.2 LCS Records for Home GMLC (LCS-HGMT-CDR)
700
+
701
+ If enabled, a LCS Home GMLC Mobile terminated Charging Data Record (LCS-HGMT-CDR) shall be produced for each mobile a terminated location request is performed via the H-GMLC. The fields in the record are specified in table 6.1.3.2.2, which provides a brief description of each field.
702
+
703
+ **Table 6.1.3.2.2: LCS Home GMLC Mobile Terminated CDR (LCS-HGMT-CDR)**
704
+
705
+ | Field | Category | Description |
706
+ |------------------------------|----------------|------------------------------------------------------------------------------------------------------------------|
707
+ | Record Type | M | LCS Home GMLC Mobile Terminated Record |
708
+ | Recording Entity | M | The E.164 address of this GMLC |
709
+ | Requesting GMLC Identity | C | If available, the IP address of the RGMLC involved in the location request |
710
+ | Visited GMLC Identity | C | If available, the IP address of the VGMLC involved in the location request |
711
+ | Serving Network Identity | O <sub>c</sub> | MCC and MNC of the serving network used during this record, if available. |
712
+ | LCS Client Type | C | The type of the LCS client that invoked the LR, if available. |
713
+ | LCS Client Identity | C | Further identification of the LCS client, if available. |
714
+ | Target IMSI | M | The IMSI of the targeted LCS subscriber |
715
+ | Target MSISDN | O <sub>m</sub> | The primary MSISDN of the targeted subscriber. |
716
+ | Location Type | M | The type of location information being requested. |
717
+ | LCS Priority | C | Priority of the LR, if available |
718
+ | Result Code | O <sub>m</sub> | The result code that indicate the result of the request or individual positioning |
719
+ | Record Time Stamp | O <sub>m</sub> | Time of generation of the CDR |
720
+ | Local Record Sequence Number | O <sub>m</sub> | Consecutive record number created by this node. The number is allocated sequentially including all CDR types. |
721
+ | Record extensions | O <sub>c</sub> | A set of network/manufacturer specific extensions to the record. Conditioned upon the existence of an extension. |
722
+
723
+ ##### 6.1.3.2.3 LCS Records for Visited GMLC (LCS-VGMT-CDR)
724
+
725
+ If enabled, a LCS Visited GMLC Mobile terminated Charging Data Record (LCS-VGMT-CDR) shall be produced for each mobile a terminated location request is performed via the V-GMLC. The fields in the record are specified in table 6.1.3.2.3, which provides a brief description of each field.
726
+
727
+ **Table 6.1.3.2.3: LCS Visited GMLC Mobile Terminated CDR (LCS-VGMT-CDR)**
728
+
729
+ | Field | Category | Description |
730
+ |------------------------------|----------------|------------------------------------------------------------------------------------------------------------------|
731
+ | Record Type | M | LCS Visited GMLC Mobile Terminated Record |
732
+ | Recording Entity | M | The E.164 address of this GMLC |
733
+ | Home GMLC Identity | C | If available, the IP address of the HGMLC involved in the location request |
734
+ | LCS Client Type | C | The type of the LCS client that invoked the LR, if available. |
735
+ | LCS Client Identity | C | Further identification of the LCS client, if available. |
736
+ | Target IMSI | M | The IMSI of the targeted LCS subscriber |
737
+ | Target MSISDN | O <sub>m</sub> | The primary MSISDN of the targeted subscriber. |
738
+ | Location Type | M | The type of location information being requested. |
739
+ | LCS Priority | C | Priority of the LR, if available |
740
+ | Result Code | O <sub>m</sub> | The result code that indicate the result of the request or individual positioning |
741
+ | Record Time Stamp | O <sub>m</sub> | Time of generation of the CDR |
742
+ | Local Record Sequence Number | O <sub>m</sub> | Consecutive record number created by this node. The number is allocated sequentially including all CDR types. |
743
+ | Record extensions | O <sub>c</sub> | A set of network/manufacturer specific extensions to the record. Conditioned upon the existence of an extension. |
744
+
745
+ #### 6.1.3.3 LCS Records for Network Initiated Location Request (LCS-GNI-CDR)
746
+
747
+ If enabled, a LCS GMLC Network Induced Charging Data Record (LCS-GNI-CDR) shall be produced for each network induced location request performed via the GMLC. The fields in the record are specified in table 6.1.3.3, which provides a brief description of each field.
748
+
749
+ **Table 6.1.3.3: LCS GMLC Network Induced CDR (LCS-GNI-CDR)**
750
+
751
+ | Field | Category | Description |
752
+ |------------------------------|----------------|------------------------------------------------------------------------------------------------------------------|
753
+ | Record Type | M | LCS GMLC Network Induced Record |
754
+ | Recording Entity | M | The E.164 address of this GMLC |
755
+ | LCS Client Type | C | The type of the LCS client that invoked the LR, if available. |
756
+ | LCS Client Identity | C | Further identification of the LCS client, if available. |
757
+ | Served IMSI | M | The IMSI of the subscriber that requests the location. |
758
+ | Served MSISDN | O <sub>m</sub> | The primary MSISDN of the subscriber that requests the location. |
759
+ | Serving Entity | C | The E.164 address of the serving MSC (in case of CS-NI-LR) or SGSN (in case of PS-NI-LR) |
760
+ | Result Code | O <sub>m</sub> | The result code that indicate the result of the request or individual positioning |
761
+ | Record Time Stamp | O <sub>m</sub> | Time of generation of the CDR |
762
+ | Local Record Sequence Number | O <sub>m</sub> | Consecutive record number created by this node. The number is allocated sequentially including all CDR types. |
763
+ | Record extensions | O <sub>c</sub> | A set of network/manufacturer specific extensions to the record. Conditioned upon the existence of an extension. |
764
+
765
+ ## 6.2 Data description for LCS online charging
766
+
767
+ ### 6.2.1 R<sub>o</sub> message contents
768
+
769
+ The credit control request for the "interim interrogation" and "final interrogation" reports the actual number of "units" that were used, from what was previously reserved. This determines the actual amount debited from the subscriber's account.
770
+
771
+ **Editor's note: The content above is FFS**
772
+
773
+ Table 6.2.1 describes the use of these messages for online charging.
774
+
775
+ **Table 6.2.1: Online Charging Messages Reference Table**
776
+
777
+ | Command-Name | Source | Destination | Abbreviation |
778
+ |------------------------|--------|-------------|--------------|
779
+ | Credit-Control-Request | GMLC | OCS | CCR |
780
+ | Credit-Control-Answer | OCS | GMLC | CCA |
781
+
782
+ #### 6.2.1.1 LCS Credit-Control-Request Message
783
+
784
+ Table 6.2.1.1 illustrates the basic structure of a Diameter credit control request message from GMLC as used for LCS online charging.
785
+
786
+ **Table 6.2.1.1: Credit-Control-Request (CCR) Message Contents for LCS**
787
+
788
+ | AVP | Category | Description |
789
+ |----------------------------------|----------------|---------------------------------------------------------------------------------------|
790
+ | Session-Id | M | Described in RFC 3588, diameter base protocol [401] |
791
+ | Origin-Host | M | Described in RFC 3588, diameter base protocol [401] |
792
+ | Origin-Realm | M | Described in RFC 3588, diameter base protocol [401] |
793
+ | Destination-Realm | M | Described in RFC 3588, diameter base protocol [401] |
794
+ | Auth-Application-Id | M | Described in RFC 3588, diameter base protocol [401] |
795
+ | Destination-Host | O <sub>c</sub> | Described in RFC 3588, diameter base protocol [401] |
796
+ | User-Name | O <sub>c</sub> | Described in RFC 3588, diameter base protocol [401] |
797
+ | Origin-State-Id | O <sub>c</sub> | Described in RFC 3588, diameter base protocol [401] |
798
+ | Event-Timestamp | O <sub>c</sub> | Described in RFC 3588, diameter base protocol [401] |
799
+ | CC-Request-Type | M | Described in Internet-Draft, Diameter Credit Control Application [402] |
800
+ | CC-Request-Number | M | Described in Internet-Draft, Diameter Credit Control Application [402] |
801
+ | CC-Sub-Session-Id | M | Described in Internet-Draft, Diameter Credit Control Application [402] |
802
+ | Acct-Multi-Session-Id | ? | Described in Internet-Draft, Diameter Credit Control Application [402] |
803
+ | Subscription-Id | O <sub>c</sub> | Described in Internet-Draft, Diameter Credit Control Application [402] |
804
+ | Service-Identifier | ? | Described in Internet-Draft, Diameter Credit Control Application [402] |
805
+ | Termination-Cause | ? | Described in Internet-Draft, Diameter Credit Control Application [402] |
806
+ | Requested-Service-Unit | O <sub>c</sub> | Described in Internet-Draft, Diameter Credit Control Application [402] |
807
+ | Requested-Action | O <sub>c</sub> | Described in Internet-Draft, Diameter Credit Control Application [402] |
808
+ | Used-Service-Unit | O <sub>c</sub> | Described in Internet-Draft, Diameter Credit Control Application [402] |
809
+ | Multiple-Services-Indicator | O <sub>M</sub> | Described in Internet-Draft, Diameter Credit Control Application [402] |
810
+ | Multiple-Services-Credit Control | O <sub>C</sub> | Described in Internet-Draft, Diameter Credit Control Application [402] |
811
+ | Service-Parameter-Info | O <sub>c</sub> | Described in Internet-Draft, Diameter Credit Control Application [402] |
812
+ | CC-Correlation-Id | ? | Described in Internet-Draft, Diameter Credit Control Application [402] |
813
+ | User-Equipment-Info | ? | Described in Internet-Draft, Diameter Credit Control Application [402] |
814
+ | LCS-Information | O <sub>c</sub> | Holds the LCS service specific parameters. It is further described in the table below |
815
+
816
+ NOTE: A full description and the detailed use of the AVPs for GMLC and for each CCR request type (initial/update/termination/event) is specified in TS 32.299 [50].
817
+
818
+ #### 6.2.1.2 LCS Credit-Control-Answer Message
819
+
820
+ Table 6.2.1.2 illustrates the basic structure of a Diameter credit control answer message as used for LCS charging. This message is always used by the OCS as specified below, independent of the receiving GMLC and the CCR request type that is being replied to.
821
+
822
+ **Table 6.2.1.2: Credit-Control-Answer (CCA) Message Contents for LCS**
823
+
824
+ | AVP | Category | Description |
825
+ |----------------------------------|----------------|------------------------------------------------------------------------|
826
+ | Session-Id | M | Described in RFC 3588, diameter base protocol [401] |
827
+ | Result-Code | M | Described in RFC 3588, diameter base protocol [401] |
828
+ | Origin-Host | M | Described in RFC 3588, diameter base protocol [401] |
829
+ | Origin-Realm | M | Described in RFC 3588, diameter base protocol [401] |
830
+ | Auth-Application-Id | M | Described in RFC 3588, diameter base protocol [401] |
831
+ | User-Name | O <sub>c</sub> | Described in RFC 3588, diameter base protocol [401] |
832
+ | Origin-State-Id | O <sub>c</sub> | Described in RFC 3588, diameter base protocol [401] |
833
+ | Event-Timestamp | O <sub>c</sub> | Described in RFC 3588, diameter base protocol [401] |
834
+ | CC-Request-Type | M | Described in Internet-Draft, Diameter Credit Control Application [402] |
835
+ | CC-Request-Number | M | Described in Internet-Draft, Diameter Credit Control Application [402] |
836
+ | CC-Session-Failover | ? | Described in Internet-Draft, Diameter Credit Control Application [402] |
837
+ | CC-Sub-Session-Id | M | Described in Internet-Draft, Diameter Credit Control Application [402] |
838
+ | Acct-Multi-Session-Id | ? | Described in Internet-Draft, Diameter Credit Control Application [402] |
839
+ | Subscription-Id | O <sub>c</sub> | Described in Internet-Draft, Diameter Credit Control Application [402] |
840
+ | Granted-Service-Unit | ? | Described in Internet-Draft, Diameter Credit Control Application [402] |
841
+ | Multiple-Services-Credit Control | O <sub>c</sub> | Described in Internet-Draft, Diameter Credit Control Application [402] |
842
+ | Cost-Information | O <sub>c</sub> | Described in Internet-Draft, Diameter Credit Control Application [402] |
843
+ | Final-Unit-Indication | O <sub>c</sub> | Described in Internet-Draft, Diameter Credit Control Application [402] |
844
+ | Check-Balance-Result | O <sub>c</sub> | Described in Internet-Draft, Diameter Credit Control Application [402] |
845
+ | Credit-Control-Failure-Handling | O <sub>c</sub> | Described in Internet-Draft, Diameter Credit Control Application [402] |
846
+ | Direct-Debiting-Failure-Handling | O <sub>c</sub> | Described in Internet-Draft, Diameter Credit Control Application [402] |
847
+ | Validity-Time | O <sub>c</sub> | Described in Internet-Draft, Diameter Credit Control Application [402] |
848
+ | Redirect-Host AVP | ? | Described in Internet-Draft, Diameter Credit Control Application [402] |
849
+ | Redirect-Host-Usage | ? | Described in Internet-Draft, Diameter Credit Control Application [402] |
850
+ | Redirect-Max-Cache-Time | ? | Described in Internet-Draft, Diameter Credit Control Application [402] |
851
+
852
+ ## 6.3 LCS Charging Specific Parameters
853
+
854
+ ### 6.3.1 Definition of LCS charging information
855
+
856
+ The LCS Information parameter used for LCS charging is provided in the Service Information parameter.
857
+
858
+ #### 6.3.1.1 LCS charging information assignment for Service Information
859
+
860
+ The components in the Service Information that are use for LCS charging can be found in Table 6.3.1.1.
861
+
862
+ **Table 6.3.1.1: Service Information used for LCS Charging**
863
+
864
+ | Field | Category | Description |
865
+ |---------------------|----------------|----------------------------------------------------------------------------------------------------------------------|
866
+ | Service Information | O <sub>M</sub> | A set of fields hold the 3GPP specific parameter as defined in 3GPP TS 32.299 [50]. |
867
+ | Subscription Id | O <sub>M</sub> | Used as defined in 3GPP TS 32.260 [20]. |
868
+ | LCS Information | O <sub>M</sub> | This field holds a set of MMTel services with theirs specific parameters. The details are defined in clause 6.3.1.2. |
869
+
870
+ #### 6.3.1.2 Definition of the LCS Information
871
+
872
+ LCS specific charging information is provided within the LCS Information, and the detailed structure of the LCS Information can be found in table 6.3.1.2.
873
+
874
+ **Table 6.3.1.2: Structure of the LCS Information**
875
+
876
+ | Field | Category | Description |
877
+ |-------------------|----------------|----------------------------------------------------------------------------------------------------------------------------|
878
+ | LCS Client ID | O <sub>c</sub> | This field holds the ID of the LCS client that invoked the LR, if available. |
879
+ | Location Type | O <sub>c</sub> | This field holds the type of location information being requested in case of MT-LR. |
880
+ | Location Estimate | O <sub>c</sub> | This field denotes the location of an MS in universal coordinates and the accuracy of the estimate upon successful MO-LR. |
881
+ | Positioning Data | O <sub>c</sub> | This field indicates the positioning method that was attempted to determine the location estimate for MO-LR, if available. |
882
+
883
+ # --- Annex A (informative): Bibliography
884
+
885
+ ## a) The 3GPP charging specifications
886
+
887
+ - 3GPP TS 32.251: "Telecommunication management; Charging management; Packet Switched (PS) domain charging".
888
+ - 3GPP TS 32.252: "Telecommunication management; Charging management; Wireless Local Area Network (WLAN) charging".
889
+ - 3GPP TS 23.125: "Overall High Level Functionality and Architecture Impacts of Flow Based Charging; Stage 2"
890
+
891
+ ## b) Common 3GPP specifications
892
+
893
+ - 3GPP TS 22.101: "Service aspects; Service Principles".
894
+ - 3GPP TS 22.115: "Service aspects; Charging and billing".
895
+ - 3GPP TS 23.002: "Network Architecture".
896
+ - 3GPP TS 23.003: "Numbering, addressing and identification".
897
+ - 3GPP TS 27.001: "General on Terminal Adaptation Functions (TAF) for Mobile Stations (MS)".
898
+
899
+ ## c) other Domain and Service specific 3GPP / ETSI specifications
900
+
901
+ - 3GPP TS 29.002: "Mobile Application Part (MAP) specification".
902
+ - GSM 04.02: "GSM Public Land Mobile Network (PLMN) access reference configuration".
903
+
904
+ ## d) Relevant ITU Recommendations
905
+
906
+ - ITU-T Recommendation D.93: "Charging and accounting in the international land mobile telephone service (provided via cellular radio systems)".
907
+ - ITU-T Recommendation E.164: "The international public telecommunication numbering plan".
908
+ - ITU-T Recommendation Q.767: "Application of the ISDN user part of CCITT signalling System No.7 for international ISDN interconnections".
909
+ - ITU-T Recommendation X.25: "Interface between Data Terminal Equipment (DTE) and Data Circuit-terminating Equipment (DCE) for terminals operating in the packet mode and connected to public data networks by dedicated circuit".
910
+ - ITU-T Recommendation X.121: "International numbering plan for public data networks".
911
+
912
+ ## e) Relevant IETF RFCs
913
+
914
+ - IETF RFC 959 (1985): "File Transfer Protocol".
915
+ - IETF RFC 1350: "The TFT Protocol (Revision 2)"
916
+
917
+ # Annex B (informative): Change history
918
+
919
+ | Change history | | | | | | | | |
920
+ |----------------|-------|-----------|------|-----|-----------------------------------------------------------|-----|--------|--------|
921
+ | Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Cat | Old | New |
922
+ | Sep 2003 | SA 21 | SP-030411 | -- | -- | Submitted to TSG SA#21 for Information | -- | 1.0.0 | 1.1.0 |
923
+ | Dec 2004 | SA 26 | SP-040781 | -- | -- | Submitted to TSG SA#26 for Approval | -- | 2.0.0 | 6.0.0 |
924
+ | Jun 2005 | SA 28 | SP-050278 | 0001 | -- | Add peer GMLC Identification and network ID to LCS CDRs | C | 6.0.0 | 6.1.0 |
925
+ | Jun 2005 | SA 28 | SP-050278 | 0002 | -- | Correction to scope | F | 6.0.0 | 6.1.0 |
926
+ | Jun 2005 | SA 28 | SP-050278 | 0003 | -- | Correction to references | F | 6.0.0 | 6.1.0 |
927
+ | Sep 2005 | SA 29 | SP-050622 | 0004 | -- | Correct GMLC address used in LCS CDRs | F | 6.1.0 | 6.2.0 |
928
+ | Jun 2007 | SA 36 | -- | -- | -- | Automatic upgrade to Rel-7 (no CR) at freeze of Rel-7. | -- | 6.2.0 | 7.0.0 |
929
+ | Dec 2008 | SA 42 | SP-080841 | 0005 | -- | Correction on Multiple Service indication and parameter | F | 7.0.0 | 7.1.0 |
930
+ | Dec 2008 | SA 42 | -- | -- | -- | Upgrade to Release 8 | -- | 7.1.0 | 8.0.0 |
931
+ | Dec 2009 | - | - | - | - | Update to Rel-9 version (MCC) | | 8.0.0 | 9.0.0 |
932
+ | Dec 2010 | SA_50 | SP-100759 | 0006 | 2 | Change the Title of Clause 6.1.1 to "Rf message contents" | F | 9.0.0 | 10.0.0 |
933
+ | June-2012 | SA_56 | SP-120361 | 0012 | 3 | Correction of Location Information field in LCS Charging | F | 10.0.0 | 10.1.0 |
marked/Rel-10/32_series/32272/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
marked/Rel-10/32_series/32273/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
marked/Rel-10/32_series/32274/raw.md ADDED
@@ -0,0 +1,1011 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+ # Keywords Charging, SMS, **3GPP TS 32.274 V10.0.0 (2011-03)**
4
+
5
+ *Technical Specification*
6
+
7
+ ## **3GPP** **3rd Generation Partnership Project;** Postal address **Technical Specification Group Services and System Aspects;** **Telecommunication management;** 3GPP support office address 650 Route des Lucioles - Sophia Antipolis Valbonne - FRANCE Tel.: +33 4 93 13 12 00 Fax: +33 4 93 13 47 36 **Charging management;** **Short Message Service**
8
+
9
+ ![LTE logo with '4ADVANCED' text above the 'e'](64662465bba247703fdec49c8f3309f9_img.jpg)
10
+
11
+ LTE logo with '4ADVANCED' text above the 'e'
12
+
13
+ Internet
14
+ <http://www.3gpp.org>
15
+
16
+ ![3GPP logo with a signal icon](390120de4fe440c42fea8154fcaad334_img.jpg)
17
+
18
+ 3GPP logo with a signal icon
19
+
20
+ ## **Copyright Notification**
21
+
22
+ No part may be reproduced except as authorized by written permission.
23
+ The copyright and the foregoing restriction extend to reproduction in all media.
24
+
25
+ © 2011, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TTA, TTC).
26
+ All rights reserved.
27
+
28
+ UMTS™ is a Trade Mark of ETSI registered for the benefit of its members
29
+
30
+ 3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners.
31
+
32
+ The present document has been developed within the 3rd Generation Partnership Project (3GPP) and may be further elaborated for the purposes of 3GPP.
33
+
34
+ ETSI™ is a Trade Mark of ETSI currently being registered for the benefit of its Members and of the 3GPP Organizational Partners and the GSM logo is a registered trademark of the GSM Association. The Organizational Partners accept no liability for any use of this Specification.
35
+
36
+ Specifications and reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices.
37
+
38
+ # --- Contents
39
+
40
+ | | |
41
+ |------------------------------------------------------------------------------------------|----|
42
+ | Foreword ..... | 5 |
43
+ | 1 Scope..... | 6 |
44
+ | 2 References..... | 6 |
45
+ | 3 Definitions and abbreviations ..... | 7 |
46
+ | 3.1 Definitions..... | 7 |
47
+ | 3.2 Abbreviations ..... | 7 |
48
+ | 4 Architecture considerations..... | 8 |
49
+ | 4.1 High level SMS architecture ..... | 8 |
50
+ | 4.2 SMS offline charging architecture ..... | 8 |
51
+ | 4.3 SMS online charging architecture..... | 8 |
52
+ | 5 SMS charging principles and scenarios ..... | 9 |
53
+ | 5.1 SMS charging principles..... | 9 |
54
+ | 5.1.1 General principles..... | 9 |
55
+ | 5.1.2 Segmentation and concatenation ..... | 9 |
56
+ | 5.1.3 Triggers for generation of charging information ..... | 9 |
57
+ | 5.2 SMS offline charging scenarios ..... | 11 |
58
+ | 5.2.1 Basic principles ..... | 11 |
59
+ | 5.2.2 Rf message flows..... | 11 |
60
+ | 5.2.3 CDR generation ..... | 11 |
61
+ | 5.2.3.1 Triggers for xxx-CDR charging information collection ..... | 11 |
62
+ | 5.2.3.2 Triggers for xxx-CDR Charging Information Addition ..... | 11 |
63
+ | 5.2.3.3 Triggers for xxx-CDR closure..... | 11 |
64
+ | 5.2.4 Ga record transfer flows ..... | 11 |
65
+ | 5.2.5 B <sub>xx</sub> CDR file transfer..... | 11 |
66
+ | 5.3 SMS online charging scenarios..... | 12 |
67
+ | 5.3.1 Basic principles ..... | 12 |
68
+ | 5.3.2 Ro message flows..... | 12 |
69
+ | 5.3.2.1 Simple Submission ..... | 12 |
70
+ | 5.3.2.2 Enhanced Submission..... | 13 |
71
+ | 5.3.2.3 Delivery Report..... | 13 |
72
+ | 5.3.2.4 Origination retry ..... | 13 |
73
+ | 5.3.2.5 Termination charge ..... | 15 |
74
+ | 5.3.2.6 Termination charge retry ..... | 17 |
75
+ | 5.3.2.7 Unsuccessful transaction..... | 19 |
76
+ | 5.3.2.8 IMS/SMS Interworking Messages Charging..... | 21 |
77
+ | 5.3.2.9 Simple Submission with SM service request..... | 23 |
78
+ | 5.3.3 Credit Control related ..... | 24 |
79
+ | 5.3.3.1 Triggers for stopping for an SMS Credit Control session ..... | 24 |
80
+ | 5.3.3.2 Triggers for providing interim information for a SMS Credit Control session..... | 24 |
81
+ | 6 Definition of charging information ..... | 25 |
82
+ | 6.1 Data description for SMS offline charging ..... | 25 |
83
+ | 6.1.1 Rf message contents ..... | 25 |
84
+ | 6.1.1.1 Summary of Offline Charging Message Formats ..... | 25 |
85
+ | 6.1.1.2 Structure for the Accounting Message Formats ..... | 25 |
86
+ | 6.1.1.2.1 Accounting-Request Message..... | 25 |
87
+ | 6.1.1.2.2 Accounting-Answer Message ..... | 25 |
88
+ | 6.1.2 Ga message contents..... | 25 |
89
+ | 6.1.3 CDR description on the B <sub>xx</sub> interface..... | 25 |
90
+ | 6.2 Data description for SMS online charging..... | 26 |
91
+ | 6.2.1 Ro message contents..... | 26 |
92
+ | 6.2.1.0 General..... | 26 |
93
+ | 6.2.1.1 Summary of Message Formats ..... | 27 |
94
+ | 6.2.1.2 Structure for the Credit Control Message Formats ..... | 27 |
95
+ | 6.2.1.2.1 Debit/Reserve Units Request Message ..... | 27 |
96
+ | 6.2.1.2.2 Debit / Reserve Units Response Message ..... | 28 |
97
+
98
+ | | | |
99
+ |------------------------|-------------------------------------------------------------------|----|
100
+ | 6.3 | SMS charging specific parameters..... | 29 |
101
+ | 6.3.1 | Definition of the SMS charging information..... | 29 |
102
+ | 6.3.1.1 | SMS charging information assignment for Service-Information ..... | 29 |
103
+ | 6.3.1.2 | Definition of the SMS Information..... | 30 |
104
+ | 6.3.2 | Formal parameter description..... | 31 |
105
+ | 6.3.2.1 | SMS charging information for CDRs ..... | 31 |
106
+ | 6.3.2.2 | SMS charging information for charging events ..... | 31 |
107
+ | Annex A (informative): | Change history..... | 32 |
108
+
109
+ # --- Foreword
110
+
111
+ This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP).
112
+
113
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
114
+
115
+ Version x.y.z
116
+
117
+ where:
118
+
119
+ - x the first digit:
120
+ - 1 presented to TSG for information;
121
+ - 2 presented to TSG for approval;
122
+ - 3 or greater indicates TSG approved document under change control.
123
+ - y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
124
+ - z the third digit is incremented when editorial only changes have been incorporated in the document.
125
+
126
+ # --- 1 Scope
127
+
128
+ The present document is part of a series of documents that specify charging functionality and charging management in GSM/UMTS networks. The GSM/UMTS core network charging architecture and principles are specified in 3GPP TS 32.240 [2], which provides an umbrella for other charging management TSs that specify:
129
+
130
+ - the content of the CDRs per domain / subsystem / service (offline charging);
131
+ - the content of real-time charging messages per domain / subsystem / service (online charging);
132
+ - the functionality of online and offline charging for those domains / subsystems / services;
133
+ - the interfaces that are used in the charging framework to transfer the charging information (i.e. CDRs or charging events).
134
+
135
+ The complete document structure for these TSs is defined in 3GPP TS 32.240 [2].
136
+
137
+ The present document specifies the Offline and Online Charging description for the Short Message Service (SMS), based on the functional description in 3GPP TS 23.040 [7] and on the SMS over IP in 3GPP TS 23.204 [8]. The present document does not replace existing offline SMS charging functionality and therefore is in addition to that defined in 3GPP TS 32.250 [9] and 3GPP TS 32.251 [10]. This charging description includes the offline and online charging architecture and scenarios specific to SMS, as well as the mapping of the common 3GPP charging architecture specified in 3GPP TS 32.240 [1] onto SMS. It further specifies the structure and content of the CDRs for offline charging, and the charging events for online charging. The present document is related to other 3GPP charging TSs as follows:
138
+
139
+ - The common 3GPP charging architecture is specified in 3GPP TS 32.240 [2];
140
+ - The parameters, abstract syntax and encoding rules for the CDRs are specified in 3GPP TS 32.298 [3];
141
+ - A transaction based mechanism for the transfer of CDRs within the network is specified in TS 32.295 [6];
142
+ - The file based mechanism used to transfer the CDRs from the network to the operator's billing domain (e.g. the billing system or a mediation device) is specified in 3GPP TS 32.297 [5];
143
+ - The 3GPP Diameter application that is used for SMS offline and online charging is specified in 3GPP TS 32.299 [4].
144
+
145
+ Furthermore, requirements that govern the charging work are specified in 3GPP TS 22.115 [102].
146
+
147
+ # --- 2 References
148
+
149
+ The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
150
+
151
+ - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
152
+ - For a specific reference, subsequent revisions do not apply.
153
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
154
+
155
+ - [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications".
156
+ - [2] 3GPP TS 32.240: "Telecommunication management; Charging management; Charging architecture and principles".
157
+ - [3] 3GPP TS 32.298: "Telecommunication management; Charging management; Charging Data Record (CDR) parameter description".
158
+ - [4] 3GPP TS 32.299: "Telecommunication management; Charging management; Diameter charging application".
159
+
160
+ - [5] 3GPP TS 32.297: "Telecommunication management; Charging management; Charging Data Record (CDR) file format and transfer".
161
+ - [6] 3GPP TS 32.295: "Telecommunication management; Charging management; Charging Data Record (CDR) transfer".
162
+ - [7] 3GPP TS 23.040: "Technical realization of Short Message Service (SMS)"
163
+ - [8] 3GPP TS 23.204: "Support of Short Message Service (SMS) over generic 3GPP Internet Protocol (IP) access; Stage 2"
164
+ - [9] 3GPP TS 32.250: "Telecommunication management; Charging management; Circuit Switched (CS) domain charging".
165
+ - [10] 3GPP TS 32.251: "Telecommunication management; Charging management; Packet Switched (PS) domain charging".
166
+ - [11] 3GPP TS 32.296: "Telecommunication management; Charging management; Online Charging System (OCS) applications and interfaces".
167
+ - [12] IETF RFC 4006: "Diameter Credit-Control Application"
168
+ - [13] 3GPP TS 32.270: "Telecommunication management; Charging management; Multimedia Messaging Service (MMS) charging".
169
+ - [14] 3GPP TS 23.038: "Alphabets and language-specific information".
170
+ - [15] 3GPP TS 32.260: "Telecommunication management; Charging management; IP Multimedia Services (IMS) charging".
171
+ - [16] 3GPP TS 22.142: " Value Added Services (VAS) for Short Message Service (SMS) requirements "
172
+
173
+ # --- 3 Definitions and abbreviations
174
+
175
+ ## 3.1 Definitions
176
+
177
+ For the purposes of the present document, the terms and definitions given in TR 21.905 [1], TS 32.240 [2] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TR 21.905 [1] or TS 32.240[2].
178
+
179
+ **SMS node:** An SMS node, in this specification, refers to either an SMS router, IP-SM-GW, SMS-SC or a combination of these nodes.
180
+
181
+ ## 3.2 Abbreviations
182
+
183
+ For the purposes of the present document, the abbreviations given in TR 21.905 [1], TS 32.240 [2] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1] or TS 32.240 [2].
184
+
185
+ # --- 4 Architecture considerations
186
+
187
+ ## 4.1 High level SMS architecture
188
+
189
+ The high level SMS architecture is as defined in 3GPP TS 23.040 [7]. Only the SMS Router, SMS-SC and the IP-SM-GW are within the scope of this specification. The details for the other nodes in the SMS architecture are defined within 3GPP TS 32.250 [9] and 3GPP TS 32.251 [10].
190
+
191
+ ## 4.2 SMS offline charging architecture
192
+
193
+ *Editor's Note: The offline architecture is For Further Study.*
194
+
195
+ ## 4.3 SMS online charging architecture
196
+
197
+ For online charging, the relevant SMS nodes utilise the Ro interface and application towards the OCS as specified in TS 32.299 [4]. The Ro reference point covers all online charging functionality required for SMS.
198
+
199
+ The SMS online charging architecture is depicted in figure 4.3.
200
+
201
+ ![Diagram of SMS online charging architecture showing SMS Router, SMS-SC, and IP-SM-GW connected to an Online Charging System via Ro interfaces.](e1a0d046fbe7f28f5e93a47091851747_img.jpg)
202
+
203
+ ```
204
+ graph LR; SR[SMS Router] -- Ro --> OCS[Online Charging System]; SC[SMS-SC] -- Ro --> OCS; ISGW[IP-SM-GW] -- Ro --> OCS;
205
+ ```
206
+
207
+ The diagram illustrates the SMS online charging architecture. On the left, three rectangular boxes are stacked vertically, labeled 'SMS Router', 'SMS-SC', and 'IP-SM-GW'. Each box has a horizontal line extending from its right side to a central vertical bus. Each of these horizontal lines is labeled 'Ro' at the point where it meets the bus. The central vertical bus is connected to a large blue rectangular box on the right labeled 'Online Charging System'.
208
+
209
+ Diagram of SMS online charging architecture showing SMS Router, SMS-SC, and IP-SM-GW connected to an Online Charging System via Ro interfaces.
210
+
211
+ **Figure 4.3: SMS online charging architecture**
212
+
213
+ Details on the interfaces and functions can be found in TS 32.240 [2] for the general architecture components, TS 32.296 [11] for the OCS, and 32.299 [4] for the Ro application.
214
+
215
+ # --- 5 SMS charging principles and scenarios
216
+
217
+ ## 5.1 SMS charging principles
218
+
219
+ ### 5.1.1 General principles
220
+
221
+ The Short Message Service comprises 4 main operational scenarios:
222
+
223
+ - Person to Person: The message is sent by a UE as originator and received by a UE as destination.
224
+ - Person to Application: The message is sent by a UE as originator and received by a third party application as destination.
225
+ - Application to Person: The message is sent by a third party application as originator and received by a UE as destination.
226
+ - Application to Application: The message is sent by a third party application as originator and received by another third party application as destination.
227
+
228
+ In addition SMS Nodes may apply services such as value added services specified in 3GPP TS 22.142 [16], services defined in industry standard protocols for SM submission from applications in a fixed network (protocols such as SMPP, UCP/EMI, OIS, CIMD, etc.) or vendor specific services as endorsed by 3GPP TS 23.040 [7].
229
+
230
+ As such, the SMS node collects charging information such as:
231
+
232
+ - the destination and source addresses applied for an SM;
233
+ - an indication of origination or termination handling;
234
+ - identification of the node(s) and connection(s) involved in the SM transaction;
235
+ - SM validity period;
236
+ - in scenarios involving an application / VASP, the charging information describes the identification of the application / VASP;
237
+ - requested SM service type.
238
+
239
+ ### 5.1.2 Segmentation and concatenation
240
+
241
+ Information about concatenated messages should be sent to the charging systems in order to apply the appropriate charging models. The charging system may be required to be stateful to process information about segmented messages.
242
+
243
+ ### 5.1.3 Triggers for generation of charging information
244
+
245
+ The following service level events shall, based on operator configuration, trigger the generation of charging information:
246
+
247
+ - Simple submission – based on reception at the SMS node.
248
+ - Enhanced submission – based on completion of the transaction handling at the SMS node.
249
+ - Origination retry – based on the enhanced submission where the initial handling fails and a redelivery attempt is initiated.
250
+ - Delivery report
251
+ - Termination – Application to Person scenario only.
252
+ - Termination retry – Application to Person scenario only – reattempt delivery of an SM to a terminating entity;
253
+ - SM service request.
254
+
255
+ Depending on the charging model applied, a "refund" may be necessary for unsuccessful delivery.
256
+
257
+ See clause 5.3 for detailed procedures associated with the triggers above.
258
+
259
+ ## 5.2 SMS offline charging scenarios
260
+
261
+ ### 5.2.1 Basic principles
262
+
263
+ *Editor's Note: For Further Study.*
264
+
265
+ ### 5.2.2 Rf message flows
266
+
267
+ *Editor's Note: For Further Study.*
268
+
269
+ ### 5.2.3 CDR generation
270
+
271
+ #### 5.2.3.1 Triggers for xxx-CDR charging information collection
272
+
273
+ *Editor's Note: For Further Study.*
274
+
275
+ #### 5.2.3.2 Triggers for xxx-CDR Charging Information Addition
276
+
277
+ *Editor's Note: For Further Study.*
278
+
279
+ #### 5.2.3.3 Triggers for xxx-CDR closure
280
+
281
+ *Editor's Note: For Further Study.*
282
+
283
+ ### 5.2.4 Ga record transfer flows
284
+
285
+ *Editor's Note: For Further Study.*
286
+
287
+ ### 5.2.5 B<sub>xx</sub> CDR file transfer
288
+
289
+ *Editor's Note: For Further Study.*
290
+
291
+ ## 5.3 SMS online charging scenarios
292
+
293
+ ### 5.3.1 Basic principles
294
+
295
+ SMS online charging uses the Credit Control application as specified in 3GPP TS 32.299 [4].
296
+
297
+ SMS charging may use the Immediate Event Charging (IEC) principle or the Event Charging with Unit Reservation (ECUR) principle as specified in 3GPP TS 32.299 [4]. The chargeable events for subscriber charging are associated with SM transactions.
298
+
299
+ An implementation may use either IEC or ECUR for charging events based on operator configuration.
300
+
301
+ The units used for quota shall be service specific and based on an SM.
302
+
303
+ The selection of the OCS is implementation specific as there is no guaranteed means of providing the OCS address to the CTF.
304
+
305
+ In addition, SMS charging may use the Refund Account principle when the operation has not been successfully completed after an Immediate Event Charging (IEC).
306
+
307
+ NOTE: For SMSIP, the IP-SM-GW may receive information relevant for online charging through signalling in IMS.
308
+
309
+ ### 5.3.2 Ro message flows
310
+
311
+ #### 5.3.2.1 Simple Submission
312
+
313
+ This clause contains message flows for the different operation models IEC (figure 5.3.2.1-1) and ECUR (figure 5.3.2.1-2).
314
+
315
+ ![Sequence diagram showing the online charging process for IEC. The diagram involves two main entities: SMS Node and OCS. The sequence of messages is: 1. SM-Submit or Forward-SM (incoming to SMS Node), 2. Debit Units Request (SMS Node to OCS), 3. Credit processing (internal to OCS), 4. Debit Units Response (OCS to SMS Node), 5. Forward-SM (outgoing from SMS Node).](5a95b187de0044da69b7322e04761b86_img.jpg)
316
+
317
+ ```
318
+ sequenceDiagram
319
+ participant External
320
+ participant SMS Node
321
+ participant OCS
322
+ Note right of OCS: 3. Credit processing
323
+ External->>SMS Node: 1. SM-Submit or Forward-SM
324
+ SMS Node->>OCS: 2. Debit Units Request
325
+ OCS->>SMS Node: 4. Debit Units Response
326
+ SMS Node->>External: 5. Forward-SM
327
+ ```
328
+
329
+ Sequence diagram showing the online charging process for IEC. The diagram involves two main entities: SMS Node and OCS. The sequence of messages is: 1. SM-Submit or Forward-SM (incoming to SMS Node), 2. Debit Units Request (SMS Node to OCS), 3. Credit processing (internal to OCS), 4. Debit Units Response (OCS to SMS Node), 5. Forward-SM (outgoing from SMS Node).
330
+
331
+ **Figure 5.3.2.1-1: Online charging in simple submission for IEC**
332
+
333
+ - 1) Depending on which SMS mechanism (i.e. SMS or SMSIP) is in operation, the SMS node receives an incoming SM-Submit or a MAP-Forward-SM.
334
+ - 2) The SMS node triggers a Debit Units Request message to the OCS.
335
+ - 3) The OCS performs the appropriate credit processing based on the received request.
336
+ - 4) The OCS responds with a Debit Units Response message to the SMS node.
337
+ - 5) If authorised, the SMS node continues the SM processing as appropriate for the origination procedures.
338
+
339
+ ![Sequence diagram for online charging in simple submission for ECUR. The diagram shows interactions between an external source, an SMS Node, and an OCS. The sequence is: 1. SM-Submit or Forward-SM to SMS Node; 2. Reserve Units Request (Initial) from SMS Node to OCS; 3. Credit processing in OCS; 4. Reserve Units Response (Initial) from OCS to SMS Node; 5. Forward short message from SMS Node; 6. Forward short message acknowledgement from SMS Node; 7. Reserve Units Request (Terminate) from SMS Node to OCS; 8. Credit processing in OCS; 9. Reserve Units Response (Terminate) from OCS to SMS Node.](af7916c89a458fdab6c3f443217388ae_img.jpg)
340
+
341
+ ```
342
+
343
+ sequenceDiagram
344
+ participant External
345
+ participant SMS Node
346
+ participant OCS
347
+ Note right of OCS: 3. Credit processing
348
+ Note right of OCS: 8. Credit processing
349
+ External->>SMS Node: 1. SM-Submit or Forward-SM
350
+ SMS Node->>OCS: 2. Reserve Units Request (Initial)
351
+ OCS->>SMS Node: 4. Reserve Units Response (Initial)
352
+ SMS Node->>External: 5. Forward short message
353
+ SMS Node->>SMS Node: 6. Forward short message acknowledgement
354
+ SMS Node->>OCS: 7. Reserve Units Request (Terminate)
355
+ OCS->>SMS Node: 9. Reserve Units Response (Terminate)
356
+
357
+ ```
358
+
359
+ Sequence diagram for online charging in simple submission for ECUR. The diagram shows interactions between an external source, an SMS Node, and an OCS. The sequence is: 1. SM-Submit or Forward-SM to SMS Node; 2. Reserve Units Request (Initial) from SMS Node to OCS; 3. Credit processing in OCS; 4. Reserve Units Response (Initial) from OCS to SMS Node; 5. Forward short message from SMS Node; 6. Forward short message acknowledgement from SMS Node; 7. Reserve Units Request (Terminate) from SMS Node to OCS; 8. Credit processing in OCS; 9. Reserve Units Response (Terminate) from OCS to SMS Node.
360
+
361
+ **Figure 5.3.2.1-2: Online charging in simple submission for ECUR**
362
+
363
+ - 1) Depending on which SMS mechanism (i.e. SMS or SMSIP) is in operation, the SMS node receives an incoming SM-Submit or a MAP-Forward-SM.
364
+ - 2) The SMS node triggers a Reserve Units Request (Initial) message to the OCS.
365
+ - 3) The OCS performs the appropriate credit processing based on the received request.
366
+ - 4) The OCS responds with a Reserve Units Response message to the SMS node.
367
+ - 5) If authorised, the SMS node continues the SM processing as appropriate for the origination procedures.
368
+ - 6) The SM transaction is successfully acknowledged.
369
+ - 7) The SMS node triggers a Reserve Units Request (Terminate) message to the OCS reporting the successful event transaction.
370
+ - 8) The OCS performs the appropriate credit processing based on the received request.
371
+ - 9) The OCS responds with a Reserve Units Response message to the SMS node..
372
+
373
+ #### 5.3.2.2 Enhanced Submission
374
+
375
+ The enhanced submission procedures are similar to the simple submission procedures using ECUR. However, the trigger for Reserve Units Request (Terminate) may be based on unsuccessful handling e.g. negative acknowledgement and with or without successful storage of the message for future redelivery attempts. See failure scenarios defined in clause 5.3.2.7.
376
+
377
+ #### 5.3.2.3 Delivery Report
378
+
379
+ The origination of delivery reports use the same procedures as the simple submission procedures as described within clause 5.3.2.1. The delivery report itself is contained within a new SM.
380
+
381
+ #### 5.3.2.4 Origination retry
382
+
383
+ This clause contains message flows for the different operation models IEC (figure 5.3.2.4-1) and ECUR (figure 5.3.2.4-2) for redelivery attempts in the origination direction.
384
+
385
+ ![Sequence diagram for IEC online charging in origination redelivery attempt. Lifelines: SMS Node and OCS. Steps: 1. Internal trigger to attempt redelivery attempt (SMS Node); 2. Debit Units Request (SMS Node to OCS); 3. Credit processing (OCS); 4. Debit Units Response (OCS to SMS Node); 5. Forward short message (SMS Node).](4801720824e4b5e2361a5564f91cfb70_img.jpg)
386
+
387
+ ```
388
+
389
+ sequenceDiagram
390
+ participant SMS Node
391
+ participant OCS
392
+ Note left of SMS Node: 1. Internal trigger to attempt redelivery attempt
393
+ SMS Node->>OCS: 2. Debit Units Request
394
+ Note right of OCS: 3. Credit processing
395
+ OCS-->>SMS Node: 4. Debit Units Response
396
+ SMS Node->>OCS: 5. Forward short message
397
+
398
+ ```
399
+
400
+ Sequence diagram for IEC online charging in origination redelivery attempt. Lifelines: SMS Node and OCS. Steps: 1. Internal trigger to attempt redelivery attempt (SMS Node); 2. Debit Units Request (SMS Node to OCS); 3. Credit processing (OCS); 4. Debit Units Response (OCS to SMS Node); 5. Forward short message (SMS Node).
401
+
402
+ **Figure 5.3.2.4-1: Online charging in origination redelivery attempt for IEC**
403
+
404
+ - 1) An SMS node internal trigger occurs to attempt a redelivery of a previously failed and stored SM.
405
+ - 2) The SMS node triggers a Debit Units Request message to the OCS.
406
+ - 3) The OCS performs the appropriate credit processing based on the received request.
407
+ - 4) The OCS responds with a Debit Units Response message to the SMS node.
408
+ - 5) If authorised, the SMS node continues the SM processing as appropriate for the origination procedures.
409
+
410
+ ![Sequence diagram for ECUR online charging in origination redelivery attempt. Lifelines: SMS Node and OCS. Steps: 1. Internal trigger to attempt redelivery attempt (SMS Node); 2. Reserve Units Request (Initial) (SMS Node to OCS); 3. Credit processing (OCS); 4. Reserve Units Response (Initial) (OCS to SMS Node); 5. Forward short message (SMS Node); 6. Forward short message acknowledgement (OCS to SMS Node); 7. Reserve Units Request (Terminate) (SMS Node to OCS); 8. Credit processing (OCS); 9. Reserve Units Response (Terminate) (OCS to SMS Node).](a33da0f14e456f92539ce3e9b7d81f9a_img.jpg)
411
+
412
+ ```
413
+
414
+ sequenceDiagram
415
+ participant SMS Node
416
+ participant OCS
417
+ Note left of SMS Node: 1. Internal trigger to attempt redelivery attempt
418
+ SMS Node->>OCS: 2. Reserve Units Request (Initial)
419
+ Note right of OCS: 3. Credit processing
420
+ OCS-->>SMS Node: 4. Reserve Units Response (Initial)
421
+ SMS Node->>OCS: 5. Forward short message
422
+ OCS-->>SMS Node: 6. Forward short message acknowledgement
423
+ SMS Node->>OCS: 7. Reserve Units Request (Terminate)
424
+ Note right of OCS: 8. Credit processing
425
+ OCS-->>SMS Node: 9. Reserve Units Response (Terminate)
426
+
427
+ ```
428
+
429
+ Sequence diagram for ECUR online charging in origination redelivery attempt. Lifelines: SMS Node and OCS. Steps: 1. Internal trigger to attempt redelivery attempt (SMS Node); 2. Reserve Units Request (Initial) (SMS Node to OCS); 3. Credit processing (OCS); 4. Reserve Units Response (Initial) (OCS to SMS Node); 5. Forward short message (SMS Node); 6. Forward short message acknowledgement (OCS to SMS Node); 7. Reserve Units Request (Terminate) (SMS Node to OCS); 8. Credit processing (OCS); 9. Reserve Units Response (Terminate) (OCS to SMS Node).
430
+
431
+ **Figure 5.3.2.4-2: Online charging in origination redelivery attempt for ECUR**
432
+
433
+ - 1) An SMS node internal trigger occurs to attempt a redelivery of a previously failed and stored SM.
434
+ - 2) The SMS node triggers a Reserve Units Request (Initial) message to the OCS.
435
+ - 3) The OCS performs the appropriate credit processing based on the received request.
436
+ - 4) The OCS responds with a Reserve Units Response message to the SMS node.
437
+
438
+ - 5) If authorised, the SMS node continues the SM processing as appropriate for the origination or termination procedures.
439
+ - 6) The SM transaction is successfully acknowledged.
440
+ - 7) The SMS node triggers a Reserve Units Request (Terminate) message to the OCS reporting the successful event transaction.
441
+ - 8) The OCS performs the appropriate credit processing based on the received request.
442
+ - 9) The OCS responds with a Reserve Units Response message to the SMS node.
443
+
444
+ #### 5.3.2.5 Termination charge
445
+
446
+ ![Sequence diagram showing online charging in termination for IEC. The diagram involves two main entities: SMS Node and OCS. The sequence of messages is: 1. SM-SUBMIT (incoming to SMS Node), 2. Debit Units Request (SMS Node to OCS), 3. Credit processing (OCS internal), 4. Debit Units Response (OCS to SMS Node), 5. Standard SMS handling (SMS Node internal).](724c7777b608e53be38b12b6fb3c43bc_img.jpg)
447
+
448
+ ```
449
+
450
+ sequenceDiagram
451
+ participant SMS Node
452
+ participant OCS
453
+ Note over SMS Node, OCS:
454
+ [Incoming Arrow]-->>SMS Node: 1. SM-SUBMIT
455
+ SMS Node->>OCS: 2. Debit Units Request
456
+ Note right of OCS: 3. Credit processing
457
+ OCS-->>SMS Node: 4. Debit Units Response
458
+ Note left of SMS Node: 5. Standard SMS handling
459
+
460
+ ```
461
+
462
+ Sequence diagram showing online charging in termination for IEC. The diagram involves two main entities: SMS Node and OCS. The sequence of messages is: 1. SM-SUBMIT (incoming to SMS Node), 2. Debit Units Request (SMS Node to OCS), 3. Credit processing (OCS internal), 4. Debit Units Response (OCS to SMS Node), 5. Standard SMS handling (SMS Node internal).
463
+
464
+ **Figure 5.3.2.5-1: Online charging in termination for IEC**
465
+
466
+ - 1) The SMS node receives an incoming SM-SUBMIT from an application destined for a mobile recipient.
467
+
468
+ NOTE: This scenario differs from simple submission charging as described in subclause 5.3.2.1 in that typically the mobile recipient (instead of originator or both parties) will be charged for such a short message.
469
+
470
+ - 2) The SMS node triggers a Debit Units Request message to the OCS.
471
+ - 3) The OCS performs the appropriate credit processing based on the received request.
472
+ - 4) The OCS responds with a Debit Units Response message to the SMS node.
473
+ - 5) If authorised, the SMS node continues the SM processing as appropriate for the termination procedures.
474
+
475
+ ![Sequence diagram showing online charging in termination for ECUR between an SMS Node and an OCS. The sequence starts with an external SM-SUBMIT to the SMS Node. The SMS Node sends a Reserve Units Request (Initial) to the OCS. The OCS performs credit processing and returns a Reserve Units Response (Initial). The SMS Node then forwards the short message. The OCS sends a Forward short message acknowledgement. The SMS Node sends a Reserve Units Request (Terminate) to the OCS. The OCS performs credit processing and returns a Reserve Units Response (Terminate).](fa859e4e468bfb2710a94527f2c504af_img.jpg)
476
+
477
+ ```
478
+
479
+ sequenceDiagram
480
+ participant External
481
+ participant SMS Node
482
+ participant OCS
483
+ Note right of OCS: 3. Credit processing
484
+ Note right of OCS: 8. Credit processing
485
+
486
+ External->>SMS Node: 1. SM-SUBMIT
487
+ SMS Node->>OCS: 2. Reserve Units Request (Initial)
488
+ OCS->>OCS: 3. Credit processing
489
+ OCS->>SMS Node: 4. Reserve Units Response (Initial)
490
+ SMS Node->>External: 5. Forward short message
491
+ External->>OCS: 6. Forward short message acknowledgement
492
+ SMS Node->>OCS: 7. Reserve Units Request (Terminate)
493
+ OCS->>OCS: 8. Credit processing
494
+ OCS->>SMS Node: 9. Reserve Units Response (Terminate)
495
+
496
+ ```
497
+
498
+ Sequence diagram showing online charging in termination for ECUR between an SMS Node and an OCS. The sequence starts with an external SM-SUBMIT to the SMS Node. The SMS Node sends a Reserve Units Request (Initial) to the OCS. The OCS performs credit processing and returns a Reserve Units Response (Initial). The SMS Node then forwards the short message. The OCS sends a Forward short message acknowledgement. The SMS Node sends a Reserve Units Request (Terminate) to the OCS. The OCS performs credit processing and returns a Reserve Units Response (Terminate).
499
+
500
+ **Figure 5.3.2.5-2: Online charging in termination for ECUR**
501
+
502
+ - 1) The SMS node receives an incoming SM-SUBMIT from an application destined for a mobile recipient.
503
+
504
+ NOTE: This scenario differs from simple submission charging as described in subclause 5.3.2.1 in that typically the mobile recipient (instead of originator or both parties) will be charged for such a short message.
505
+
506
+ - 2) The SMS node triggers a Reserve Units Request (Initial) message to the OCS.
507
+ - 3) The OCS performs the appropriate credit processing based on the received request.
508
+ - 4) The OCS responds with a Reserve Units Response message to the SMS node.
509
+ - 5) If authorised, the SMS node continues the SM processing as appropriate for the termination procedures.
510
+ - 6) The SM transaction is successfully acknowledged.
511
+ - 7) The SMS node triggers a Reserve Units Request (Terminate) message to the OCS reporting the successful event transaction.
512
+ - 8) The OCS performs the appropriate credit processing based on the received request.
513
+ - 9) The OCS responds with a Reserve Units Response message to the SMS node.
514
+
515
+ #### 5.3.2.6 Termination charge retry
516
+
517
+ ![Sequence diagram for IEC termination charge retry showing interactions between SMS Node and OCS.](c85ded401105f62f2d6ff26b3b5eb4af_img.jpg)
518
+
519
+ ```
520
+
521
+ sequenceDiagram
522
+ participant SMS Node
523
+ participant OCS
524
+ Note left of SMS Node: 1. Internal trigger to attempt redelivery attempt
525
+ SMS Node->>OCS: 2. Debit Units Request
526
+ Note right of OCS: 3. Credit processing
527
+ OCS-->>SMS Node: 4. Debit Units Response
528
+ Note left of SMS Node: 5. Standard SMS handling
529
+
530
+ ```
531
+
532
+ Sequence diagram for IEC termination charge retry showing interactions between SMS Node and OCS.
533
+
534
+ **Figure 5.3.2.6-1: Online charging in termination redelivery attempt for IEC**
535
+
536
+ - 1) An SMS node internal trigger occurs to attempt a redelivery of a previously failed and stored SM.
537
+ - 2) The SMS node triggers a Debit Units Request message to the OCS.
538
+ - 3) The OCS performs the appropriate credit processing based on the received request.
539
+ - 4) The OCS responds with a Debit Units Response message to the SMS node.
540
+ - 5) If authorised, the SMS node continues the SM processing as appropriate for the termination procedures.
541
+
542
+ ![Sequence diagram for ECUR termination charge retry showing interactions between SMS Node and OCS.](df82d77a0d2637cbf2da9ea920a554fa_img.jpg)
543
+
544
+ ```
545
+
546
+ sequenceDiagram
547
+ participant SMS Node
548
+ participant OCS
549
+ Note left of SMS Node: 1. Internal trigger to attempt redelivery attempt
550
+ SMS Node->>OCS: 2. Reserve Units Request (Initial)
551
+ Note right of OCS: 3. Credit processing
552
+ OCS-->>SMS Node: 4. Reserve Units Response (Initial)
553
+ SMS Node->>OCS: 5. Forward short message
554
+ OCS-->>SMS Node: 6. Forward short message acknowledgement
555
+ SMS Node->>OCS: 7. Reserve Units Request (Terminate)
556
+ Note right of OCS: 8. Credit processing
557
+ OCS-->>SMS Node: 9. Reserve Units Response
558
+
559
+ ```
560
+
561
+ Sequence diagram for ECUR termination charge retry showing interactions between SMS Node and OCS.
562
+
563
+ **Figure 5.3.2.6-2: Online charging in termination redelivery attempt for ECUR**
564
+
565
+ - 1) An SMS node internal trigger occurs to attempt a redelivery of a previously failed and stored SM.
566
+ - 2) The SMS node triggers a Reserve Units Request (Initial) message to the OCS.
567
+ - 3) The OCS performs the appropriate credit processing based on the received request.
568
+ - 4) The OCS responds with a Reserve Units Response message to the SMS node.
569
+
570
+ - 5) If authorised, the SMS node continues the SM processing as appropriate for the termination procedures.
571
+ - 6) The SM transaction is successfully acknowledged.
572
+ - 7) The SMS node triggers a Reserve Units Request (Terminate) message to the OCS reporting the successful event transaction.
573
+ - 8) The OCS performs the appropriate credit processing based on the received request.
574
+ - 9) The OCS responds with a Reserve Units Response message to the SMS node.
575
+
576
+ #### 5.3.2.7 Unsuccessful transaction
577
+
578
+ Unsuccessful transaction after IEC
579
+
580
+ The following flow in figure 5.3.2.7-1 only applies where a refund action is required for unsuccessful delivery.
581
+
582
+ ![Sequence diagram for Unsuccessful transaction after IEC. The diagram shows the interaction between an SMS Node and an OCS. The process starts with a 'Trigger to attempt delivery' at the SMS Node. The SMS Node sends a 'Debit Units Request' to the OCS. The OCS performs 'Credit processing' and responds with a 'Debit Units Response'. The SMS Node then attempts to 'Forward short message', but receives a 'Forward short message NOK' from the OCS. The SMS Node then sends a 'Debit Units Request (Refund Account)' to the OCS. The OCS performs 'Credit Refund' and responds with a 'Debit Units Response (Refund Account)'.](9b9d2abd741ed4bafe7f78f89961c663_img.jpg)
583
+
584
+ ```
585
+
586
+ sequenceDiagram
587
+ participant SMS Node
588
+ participant OCS
589
+ Note left of SMS Node: 1. Trigger to attempt delivery
590
+ SMS Node->>OCS: 2. Debit Units Request
591
+ Note right of OCS: 3. Credit processing
592
+ OCS-->>SMS Node: 4. Debit Units Response
593
+ SMS Node->>OCS: 5. Forward short message
594
+ OCS-->>SMS Node: 6. Forward short message NOK
595
+ SMS Node->>OCS: 7. Debit Units Request (Refund Account)
596
+ Note right of OCS: 8. Credit Refund
597
+ OCS-->>SMS Node: 9. Debit Units Response (Refund Account)
598
+
599
+ ```
600
+
601
+ Sequence diagram for Unsuccessful transaction after IEC. The diagram shows the interaction between an SMS Node and an OCS. The process starts with a 'Trigger to attempt delivery' at the SMS Node. The SMS Node sends a 'Debit Units Request' to the OCS. The OCS performs 'Credit processing' and responds with a 'Debit Units Response'. The SMS Node then attempts to 'Forward short message', but receives a 'Forward short message NOK' from the OCS. The SMS Node then sends a 'Debit Units Request (Refund Account)' to the OCS. The OCS performs 'Credit Refund' and responds with a 'Debit Units Response (Refund Account)'.
602
+
603
+ **Figure 5.3.2.7-1: Unsuccessful transaction after IEC**
604
+
605
+ - 1) The SMS node receives a trigger to attempt delivery of an SM. This may be for origination, termination or redelivery attempt.
606
+ - 2) The SMS node triggers a Debit Units Request message to the OCS.
607
+ - 3) The OCS performs the appropriate credit processing based on the received request.
608
+ - 4) The OCS responds with a Debit Units Response message to the SMS node.
609
+ - 5) If authorised, the SMS node continues the SM processing as appropriate for origination or termination procedures.
610
+ - 6) The SM transaction is acknowledged as an unsuccessful transaction (either via explicit signalling or an internal trigger).
611
+ - 7) The SMS node triggers a Debit Units Request (Refund Account) message to the OCS.
612
+ - 8) The OCS performs the appropriate refund processing based on the received request.
613
+ - 9) The OCS responds with a Debit Units Response (Refund Account) message to the SMS node.
614
+
615
+ ##### Unsuccessful transaction in ECUR
616
+
617
+ ![Sequence diagram illustrating an unsuccessful transaction in ECUR between an SMS Node and an OCS.](7f25db95ce3916c0e09803b861a2f7bc_img.jpg)
618
+
619
+ ```
620
+ sequenceDiagram
621
+ participant SMS Node
622
+ participant OCS
623
+ Note left of SMS Node: 1. Trigger to attempt delivery
624
+ SMS Node->>OCS: 2. Reserve Units Request (Initial)
625
+ Note right of OCS: 3. Credit processing
626
+ OCS-->>SMS Node: 4. Reserve Units Response (Initial)
627
+ SMS Node->>OCS: 5. Forward short message
628
+ OCS-->>SMS Node: 6. Forward short message NOK
629
+ SMS Node->>OCS: 7. Reserve Units Request (Terminate)
630
+ Note right of OCS: 8. Credit processing
631
+ OCS-->>SMS Node: 9. Reserve Units Response (Terminate)
632
+ ```
633
+
634
+ The diagram is a sequence diagram with two lifelines: SMS Node and OCS. The interaction begins with a self-message on the SMS Node labeled '1. Trigger to attempt delivery'. The SMS Node sends a '2. Reserve Units Request (Initial)' message to the OCS. The OCS performs '3. Credit processing' and responds with '4. Reserve Units Response (Initial)'. The SMS Node then sends '5. Forward short message' to the OCS. The OCS responds with '6. Forward short message NOK'. The SMS Node sends '7. Reserve Units Request (Terminate)' to the OCS. The OCS performs '8. Credit processing' and responds with '9. Reserve Units Response (Terminate)'.
635
+
636
+ Sequence diagram illustrating an unsuccessful transaction in ECUR between an SMS Node and an OCS.
637
+
638
+ **Figure 5.3.2.7-2: Unsuccessful transaction for ECUR**
639
+
640
+ - 1) The SMS node receives a trigger occurs to attempt delivery of an SM. This may be for origination, termination or redelivery attempt.
641
+ - 2) The SMS node triggers a Reserve Units Request (Initial) message to the OCS.
642
+ - 3) The OCS performs the appropriate credit processing based on the received request.
643
+ - 4) The OCS responds with a Reserve Units Response message to the SMS node.
644
+ - 5) If authorised, the SMS node continues the SM processing as appropriate for the origination or termination procedures.
645
+ - 6) The SM transaction is acknowledged as an unsuccessful transaction (either via explicit signalling or an internal trigger).
646
+ - 7) The SMS node triggers a Reserve Units Request (Terminate) message to the OCS reporting the used unit for the service to zero. This characterizes the unsuccessful event transaction.
647
+ - 8) The OCS performs the appropriate credit processing based on the received request.
648
+ - 9) The OCS responds with a Reserve Units Response message to the SMS node.
649
+
650
+ #### 5.3.2.8 IMS/SMS Interworking Messages Charging
651
+
652
+ This clause contains message flows for the different operation models IEC (figure 5.3.2.8-1) and ECUR (figure 5.3.2.8-2) for IMS/SMS Interworking messages in the origination direction.
653
+
654
+ ![Sequence diagram for online charging in origination IMS/SMS Interworking Messages for IEC. The diagram shows the interaction between an IP-SM-GW and an OCS. The process starts with an incoming SIP MESSAGE to the IP-SM-GW. The IP-SM-GW then parses the message and sends a Debit Units Request to the OCS. The OCS performs credit processing and returns a Debit Units Response. The IP-SM-GW then converts the SIP MESSAGE to 1 or n short messages and forwards them. The diagram includes a dashed line indicating a delay or continuation.](5445597cceefaca1ac89e710fe339325_img.jpg)
655
+
656
+ ```
657
+ sequenceDiagram
658
+ participant External
659
+ participant IP_SM_GW as IP-SM-GW
660
+ participant OCS
661
+ Note right of IP_SM_GW: 2. Parse the SIP MESSAGE
662
+ Note right of OCS: 4. Credit processing
663
+ Note right of IP_SM_GW: 6. Convert the SIP MESSAGE to 1 or n short messages
664
+
665
+ External->>IP_SM_GW: 1. SIP MESSAGE
666
+ IP_SM_GW->>OCS: 3. Debit Units Request
667
+ OCS->>IP_SM_GW: 5. Debit Units Response
668
+ IP_SM_GW->>External: 7. Forward segmented short messages
669
+ ```
670
+
671
+ Sequence diagram for online charging in origination IMS/SMS Interworking Messages for IEC. The diagram shows the interaction between an IP-SM-GW and an OCS. The process starts with an incoming SIP MESSAGE to the IP-SM-GW. The IP-SM-GW then parses the message and sends a Debit Units Request to the OCS. The OCS performs credit processing and returns a Debit Units Response. The IP-SM-GW then converts the SIP MESSAGE to 1 or n short messages and forwards them. The diagram includes a dashed line indicating a delay or continuation.
672
+
673
+ **Figure 5.3.2.8-1: Online charging in origination IMS/SMS Interworking Messages for IEC**
674
+
675
+ - 1) The IP-SM-GW receives an incoming SIP MESSAGE.
676
+ - 2) The IP-SM-GW parses the SIP MESSAGE.
677
+ - 3) The IP-SM-GW triggers a Debit Units Request message to the OCS.
678
+ - 4) The OCS performs the appropriate credit processing based on the received Debit Units Request.
679
+ - 5) The OCS responds with a Debit Units Response message to the IP-SM-GW.
680
+ - 6) IP-SM-GW converts the SIP MESSAGE to 1 or n ( $n \geq 1$ ) short messages.
681
+ - 7) If authorised, the IP-SM-GW forwards the segmented short messages.
682
+
683
+ ![Sequence diagram showing online charging in origination IMS/SMS Interworking Messages for ECUR. The diagram involves two main entities: IP-SM-GW and OCS. The sequence of messages is: 1. SIP MESSAGE (incoming to IP-SM-GW), 2. Parse the SIP MESSAGE (internal to IP-SM-GW), 3. Reserve Units Request (Initial) (IP-SM-GW to OCS), 4. Credit processing (internal to OCS), 5. Reserve Units Response (Initial) (OCS to IP-SM-GW), 6. Convert the SIP MESSAGE 1 or n short messages (internal to IP-SM-GW), 7. Forward segmented short messages (IP-SM-GW to OCS), 8. Forward segmented short messages acknowledgement (OCS to IP-SM-GW), 9. Reserve Units Request (Terminate) (IP-SM-GW to OCS), 10. Credit processing (internal to OCS), 11. Reserve Units Response (Terminate) (OCS to IP-SM-GW).](5b8a756d9a71c35f17db8bcb90b438a3_img.jpg)
684
+
685
+ ```
686
+
687
+ sequenceDiagram
688
+ participant External
689
+ participant IP-SM-GW
690
+ participant OCS
691
+ External->>IP-SM-GW: 1. SIP MESSAGE
692
+ Note over IP-SM-GW: 2. Parse the SIP MESSAGE
693
+ IP-SM-GW->>OCS: 3. Reserve Units Request (Initial)
694
+ Note over OCS: 4. Credit processing
695
+ OCS->>IP-SM-GW: 5. Reserve Units Response (Initial)
696
+ Note over IP-SM-GW: 6. Convert the SIP MESSAGE
697
+ 1 or n short messages
698
+ IP-SM-GW->>OCS: 7. Forward segmented short messages
699
+ Note over IP-SM-GW,OCS: ...
700
+ IP-SM-GW->>OCS:
701
+ OCS->>IP-SM-GW: 8. Forward segmented short messages acknowledgement
702
+ Note over IP-SM-GW,OCS: ...
703
+ OCS->>IP-SM-GW:
704
+ IP-SM-GW->>OCS: 9. Reserve Units Request (Terminate)
705
+ Note over OCS: 10. Credit processing
706
+ OCS->>IP-SM-GW: 11. Reserve Units Response (Terminate)
707
+
708
+ ```
709
+
710
+ Sequence diagram showing online charging in origination IMS/SMS Interworking Messages for ECUR. The diagram involves two main entities: IP-SM-GW and OCS. The sequence of messages is: 1. SIP MESSAGE (incoming to IP-SM-GW), 2. Parse the SIP MESSAGE (internal to IP-SM-GW), 3. Reserve Units Request (Initial) (IP-SM-GW to OCS), 4. Credit processing (internal to OCS), 5. Reserve Units Response (Initial) (OCS to IP-SM-GW), 6. Convert the SIP MESSAGE 1 or n short messages (internal to IP-SM-GW), 7. Forward segmented short messages (IP-SM-GW to OCS), 8. Forward segmented short messages acknowledgement (OCS to IP-SM-GW), 9. Reserve Units Request (Terminate) (IP-SM-GW to OCS), 10. Credit processing (internal to OCS), 11. Reserve Units Response (Terminate) (OCS to IP-SM-GW).
711
+
712
+ **Figure 5.3.2.8-2: Online charging in origination IMS/SMS Interworking Messages for ECUR**
713
+
714
+ - 1) The IP-SM-GW receives an incoming SIP MESSAGE.
715
+ - 2) The IP-SM-GW parses the SIP MESSAGE.
716
+ - 3) The IP-SM-GW triggers a Reserve Units Request (Initial) message to the OCS.
717
+ - 4) The OCS performs the appropriate credit processing based on the received Reserve Units Request.
718
+ - 5) The OCS responds with a Reserve Units Response message to the IP-SM-GW.
719
+ - 6) IP-SM-GW converts the SIP MESSAGE to 1 or n ( $n \geq 1$ ) short messages.
720
+ - 7) If authorised, the IP-SM-GW forwards segmented short messages.
721
+ - 8) All the short messages transactions are successfully acknowledged.
722
+ - 9) The IP-SM-GW triggers a Reserve Units Request (Terminate) message to the OCS reporting the successful event transaction.
723
+ - 10) The OCS performs the appropriate credit processing based on the received request.
724
+
725
+ 11) The OCS responds with a Reserve Units Response message to the IP-SM-GW.
726
+
727
+ #### 5.3.2.9 Simple Submission with SM service request
728
+
729
+ This clause contains message flows for operation models IEC (figure 5.3.2.9-1) where application of a SM service is subject to charging independent from the SM submission.
730
+
731
+ **Editors Note: Simple SM submission with SM service request for operation model ECUR is FFS.**
732
+
733
+ ![Sequence diagram for online charging in simple submission with SM service request for IEC. The diagram shows interactions between an external source, an SMS Node, and an OCS. The sequence is: 1. SM-SUBMIT to SMS Node; 2. Debit Units Request 1 from SMS Node to OCS; 3. Credit processing in OCS; 4. Debit Units Response 1 from OCS to SMS Node; 5. SM Service Requested in SMS Node; 6. Debit Units Request 2 from SMS Node to OCS; 7. Credit processing 2 in OCS; 8. Debit Units Response 2 from OCS to SMS Node; 9. Service Application in SMS Node; 10. Forward -SM from SMS Node to external destination.](09955ff8214ffb6947951fc0f60eb6ab_img.jpg)
734
+
735
+ ```
736
+ sequenceDiagram
737
+ participant External
738
+ participant SMS Node
739
+ participant OCS
740
+ Note right of OCS: 3. Credit processing
741
+ Note right of OCS: 7. Credit processing 2
742
+ Note right of SMS Node: 5. SM Service Requested
743
+ Note right of SMS Node: 9. Service Application
744
+
745
+ External->>SMS Node: 1. SM-SUBMIT
746
+ SMS Node->>OCS: 2. Debit Units Request 1
747
+ OCS->>SMS Node: 4. Debit Units Response 1
748
+ SMS Node->>OCS: 6. Debit Units Request 2
749
+ OCS->>SMS Node: 8. Debit Units Response 2
750
+ SMS Node->>External: 10. Forward -SM
751
+ ```
752
+
753
+ Sequence diagram for online charging in simple submission with SM service request for IEC. The diagram shows interactions between an external source, an SMS Node, and an OCS. The sequence is: 1. SM-SUBMIT to SMS Node; 2. Debit Units Request 1 from SMS Node to OCS; 3. Credit processing in OCS; 4. Debit Units Response 1 from OCS to SMS Node; 5. SM Service Requested in SMS Node; 6. Debit Units Request 2 from SMS Node to OCS; 7. Credit processing 2 in OCS; 8. Debit Units Response 2 from OCS to SMS Node; 9. Service Application in SMS Node; 10. Forward -SM from SMS Node to external destination.
754
+
755
+ **Figure 5.3.2.9-1: Online charging in simple submission with SM service request for IEC**
756
+
757
+ - 1) Depending on which SMS mechanism (i.e. SMS or SMSIP) is in operation, the SMS node receives an incoming SM-Submit or a MAP-Forward-SM which includes a SM service request (such as forwarding or SM copy).
758
+ - 2) The SMS node triggers a Debit Units Request message to the OCS for the SM submission.
759
+ - 3) The OCS performs the appropriate credit processing based on the received request.
760
+ - 4) The OCS responds with a Debit Units Response message for the SM submission to the SMS node.
761
+ - 5) If normal SM processing is authorized in step 4, the SMS Node analyzes the SM and detects that a SM service must be applied that is subject to charging.
762
+ - 6) If a SM service subject to charging is detected in step 5, the SMS node triggers an additional Debit Units Request message to the OCS for the requested SM service.
763
+ - 7) The OCS performs the appropriate credit processing based on the received request.
764
+ - 8) The OCS responds with a Debit Units Response message for the requested SM service to the SMS node.
765
+ - 9) If authorised in step 7, the SMS node applies the requested SM service.
766
+
767
+ NOTE 1: Depending on the nature of the requested SM service, "service application" may involve creating additional messages (for example in case of a SM copy service). This is deemed part of step 9 and not otherwise shown in this diagram.
768
+
769
+ 10) If authorised in step 4, the SMS node continues the SM processing as appropriate for the origination procedures.
770
+
771
+ NOTE 2: Authorization of SM processing is independent of the authorization for application of a SM service.
772
+ I.e. If authorization is for SM processing is granted in step 4 but authorization for SM service is refused in step 8 SM processing appropriate for the originating service continues without applying the requested SM service.
773
+
774
+ ### 5.3.3 Credit Control related
775
+
776
+ #### 5.3.3.1 Triggers for stopping for an SMS Credit Control session
777
+
778
+ Used in ECUR only, a Debit / Reserve Units Request message to terminate the credit control session is sent to OCS when:
779
+
780
+ - Validity time for granted quota expires
781
+ - Granted quota runs out (i.e. a successful event has occurred)
782
+ - Abort-Session-Request is received from the OCS
783
+
784
+ The expiration of the validity time for quota does not require the SMS procedures to be terminated. The CTF shall be configurable as to whether on expiration of validity time, the service should be aborted or not; i.e. whether the stored message should be deleted and no further (re-)delivery attempt should be made.
785
+
786
+ #### 5.3.3.2 Triggers for providing interim information for a SMS Credit Control session
787
+
788
+ The provision of interim information for credit control is not used in this release of the specification, due to the use of IEC and ECUR.
789
+
790
+ # --- 6 Definition of charging information
791
+
792
+ ## 6.1 Data description for SMS offline charging
793
+
794
+ ### 6.1.1 Rf message contents
795
+
796
+ #### 6.1.1.1 Summary of Offline Charging Message Formats
797
+
798
+ *Editor's Note: For Further Study.*
799
+
800
+ #### 6.1.1.2 Structure for the Accounting Message Formats
801
+
802
+ ##### 6.1.1.2.1 Accounting-Request Message
803
+
804
+ *Editor's Note: For Further Study.*
805
+
806
+ ##### 6.1.1.2.2 Accounting-Answer Message
807
+
808
+ *Editor's Note: For Further Study.*
809
+
810
+ ### 6.1.2 Ga message contents
811
+
812
+ *Editor's Note: For Further Study.*
813
+
814
+ ### 6.1.3 CDR description on the B<sub>xx</sub> interface
815
+
816
+ *Editor's Note: For Further Study.*
817
+
818
+ ## 6.2 Data description for SMS online charging
819
+
820
+ ### 6.2.1 Ro message contents
821
+
822
+ #### 6.2.1.0 General
823
+
824
+ The SMS node generates Debit / Reserve Units information that can be transferred from the CTF to the OCF. For this purpose, SMS online charging utilises the *Debit Units and Reserve Units* procedure that is specified in the 3GPP Debit / Reserve Units operation in 3GPP TS 32.299 [4].
825
+
826
+ The SMS node generates refund information that can be transferred from the CTF to the OCF. For this purpose, it uses REFUND procedure defined in IETF RFC 4006 [12] with extended AVPs.
827
+
828
+ The *Debit / Reserve Units* procedure employs the *Debit / Reserve Units Request* and *Debit / Reserve Units Response* messages.
829
+
830
+ The Refund Account procedure employs the Debit Units Request (Refund Account) request and response messages.
831
+
832
+ Table 6.2.1 describes the use of these messages for SMS online charging.
833
+
834
+ **Table 6.2.1: SMS Online Charging Messages contents**
835
+
836
+ | Command-Name | Source | Destination |
837
+ |--------------------------------|--------|-------------|
838
+ | Debit / Reserve Units Request | CTF | OCS |
839
+ | Debit / Reserve Units Response | OCS | CTF |
840
+
841
+ This clause 6.2.1 describes the different fields used in the credit control messages.
842
+
843
+ Detailed descriptions of the fields are provided in 3GPP TS 32.299 [4].
844
+
845
+ #### 6.2.1.1 Summary of Message Formats
846
+
847
+ #### 6.2.1.2 Structure for the Credit Control Message Formats
848
+
849
+ ##### 6.2.1.2.1 Debit/Reserve Units Request Message
850
+
851
+ Table 6.2.1.2.1 illustrates the basic structure of a *Debit / Reserve Units Request* message from SMS node as used for SMS online charging.
852
+
853
+ **Table 6.2.1.2.1: *Debit / Reserve Units Request* Message Contents for SMS**
854
+
855
+ | Field | Category | Description |
856
+ |-----------------------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
857
+ | Session Identifier | M | This field identifies the operation session. |
858
+ | Originator Host | M | This field contains the identification of the source point of the operation. |
859
+ | Originator Domain | M | This field contains the realm of the operation originator. |
860
+ | Destination Domain | M | This field contains the realm of the operation destination. |
861
+ | Operation Identifier | M | This field is a unique operation identifier. |
862
+ | Operation Token | M | This field contains the service context, i.e. SMS charging. |
863
+ | Operation Type | M | This field defines the transfer type: event for immediate event based charging and initial, terminate for ECUR based charging. |
864
+ | Operation Number | M | This field contains the sequence number of the transferred messages. |
865
+ | Destination Host | O <sub>C</sub> | This field contains the identification of the destination point of the operation. |
866
+ | User Name | O <sub>C</sub> | This field contains the identification of the source node. |
867
+ | Origination State | O <sub>C</sub> | Used for ECUR only. |
868
+ | Origination Timestamp | O <sub>C</sub> | This field contains the time when the operation is requested. |
869
+ | Subscriber Identifier | O <sub>M</sub> | This field contains the identification of the subscriber (i.e. MSISDN) that uses the requested service. |
870
+ | Termination Cause | O <sub>C</sub> | This field contains information about the cause for termination of a credit control session. Used for terminating credit control sessions in ECUR only. |
871
+ | Requested-Action | O <sub>C</sub> | This field contains the requested action, used for IEC only. |
872
+ | Multiple Operation | O <sub>M</sub> | This field indicate the occurrence of multiple operations. Used for ECUR only |
873
+ | Multiple Unit Operation | O <sub>C</sub> | This field contains the parameter for the quota management. Used for ECUR only |
874
+ | Subscriber Equipment Number | O <sub>C</sub> | This field contains the identification of the user equipment used to access service. Included if information is made available to the node. |
875
+ | Proxy Information | O <sub>C</sub> | This field contains the parameter of the proxy. |
876
+ | Route Information | O <sub>C</sub> | This field contains the parameter of the route. |
877
+ | Service Information | O <sub>M</sub> | This field holds the SMS specific parameter and is described in clause 6.3. |
878
+
879
+ ##### 6.2.1.2.2 Debit / Reserve Units Response Message
880
+
881
+ Table 6.2.1.2.2 illustrates the basic structure of a Debit / Reserve Units Response message as used for SMS charging. This message is always used by the OCS as specified below, independent of the receiving SMS node and the operation type that is being replied to.
882
+
883
+ **Table 6.2.1.2.2: Debit / Reserve Units Response Message Contents for SMS**
884
+
885
+ | Field | Category | Description |
886
+ |--------------------------------|----------------|---------------------------------------------------------------------------------------------------------------------------|
887
+ | Session Identifier | M | This field identifies the operation session. |
888
+ | Operation Result | M | This field identifies the result of the operation. |
889
+ | Originator Host | M | This field contains the identification of the source point of the operation. |
890
+ | Originator Domain | M | This field contains the realm of the operation originator. |
891
+ | Operation Identifier | M | This field is a unique operation identifier. |
892
+ | Operation Type | M | This field defines the transfer type: event for event based charging and start, interim, stop for session based charging. |
893
+ | Operation Number | M | This field contains the sequence number of the transferred messages. |
894
+ | Operation Failover | - | Not used for SMS in 3GPP. |
895
+ | Multiple Unit Operation | O <sub>C</sub> | This field contains the parameter for the quota management. Used in IEC for refund purpose and in ECUR. |
896
+ | Operation Failure Action | O <sub>C</sub> | This field defines the resulting operation at the SMS node if a failure has occurred at the OCS for ECUR. |
897
+ | Operation Event Failure Action | O <sub>C</sub> | This field defines the resulting operation at the SMS node if a failure has occurred at the OCS for IEC. |
898
+ | Redirection Host | O <sub>C</sub> | |
899
+ | Redirection Host Usage | O <sub>C</sub> | |
900
+ | Redirection Cache Time | O <sub>C</sub> | |
901
+ | Proxy Information | O <sub>C</sub> | This field contains the parameter of the proxy. |
902
+ | Route Information | O <sub>C</sub> | This field contains the parameter of the route. |
903
+ | Failed parameter | O <sub>C</sub> | This field contains missing and/or unsupported parameter that caused the failure. |
904
+ | Service Information | O <sub>C</sub> | This field contains SMS specific information. |
905
+
906
+ Editor's Note: The mechanism to carry refund information is For Future Study.
907
+
908
+ ## 6.3 SMS charging specific parameters
909
+
910
+ ### 6.3.1 Definition of the SMS charging information
911
+
912
+ #### 6.3.1.1 SMS charging information assignment for Service-Information
913
+
914
+ The components in the Service Information that are used for SMS charging can be found in table 6.3.1.1.
915
+
916
+ **Table 6.3.1.1: Service Information used for SMS Charging**
917
+
918
+ | Field | Category | Description |
919
+ |----------------------------------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
920
+ | Service Information | O <sub>M</sub> | This is a structured field and holds the 3GPP specific parameter as defined in TS 32.299 [50]. For SMS Charging the SMS-Information and selected parameters of MMS Information, PS-Information and IMS information are used. |
921
+ | SMS Information | O <sub>M</sub> | This is a structured field and holds the SMS specific parameters. The details are defined in table 6.3.1.2. |
922
+ | MMS Information | O <sub>M</sub> | This is a structure field and the following parameters are specific to SMS. The complete structure is defined in 3GPP TS 32.270 [13] |
923
+ | Originator Address | O <sub>M</sub> | This field holds the address of the originator of the SM. This will typically be an E.164 number or a shortcode. Multiple addresses may be carried if additional information is available, e.g. IMSI and E.164 number. |
924
+ | Submission Time | O <sub>C</sub> | This field holds the timestamp of when the submitted SM arrived at the originating SMS Node. The information to populate this field is obtained from the TP-Service-Center-Time-Stamp (TP-SCTS) as defined in 3GPP TS 23.040 [7]. If a refund or retransmission is required, the timestamp carries the timestamp associated with the original submitted SM. |
925
+ | Priority | O <sub>C</sub> | This field holds any priority information associated with an SM. Applicable to terminating procedures only. Priority handling is defined in 3GPP TS 23.040 [13]. The value "low" is not applicable. |
926
+ | Message Id | O <sub>M</sub> | This field carries the identity used to identify an SM in the SMS node associated with entity that submitted it. The information to populate this field is obtained from the TP-Message-Reference (TP-MR) as defined in 3GPP TS 23.040 [7]. |
927
+ | Message Size | O <sub>M</sub> | This field carries the length of the user data part of the SM. The information to populate this field is obtained from the TP-User-Data-Length (TP-UDL) as defined in 3GPP TS 23.040 [7] |
928
+ | Message Class | O <sub>M</sub> | Used as defined in 3GPP TS 32.270 [13]. It is implementation dependent the value selected for a specific transaction. |
929
+ | Delivery Report Requested | O <sub>C</sub> | This field indicates whether a delivery report is requested by the SM originator. The information to populate this field is obtained from the TP-Status-Report-Request (TP-SRR) as defined in 3GPP TS 23.040 [7] |
930
+ | PS Information | O <sub>C</sub> | This is a structured field and the following parameters are specific to SMS. The complete structure is defined in TS 32.251 [11]. |
931
+ | PDP Address | O <sub>C</sub> | This field holds the IP address used by the subscriber for the SMS transaction. Included if the SMS node is the IP-SM-GW. |
932
+ | 3GPP User Location Info | O <sub>C</sub> | This field holds the information about the location of the subscriber during the SMS transaction. |
933
+ | 3GPP RAT Type | O <sub>C</sub> | This field holds information about the radio access technology used for the SMS transaction. |
934
+ | IMS Information | O <sub>C</sub> | This is a structured field and the following parameters are specific to SMS. The complete structure is defined in TS 32.260 [15]. |
935
+ | User Session Id | O <sub>C</sub> | This field holds the session identifier. For a SIP session the Session-ID contains the SIP Call ID. |
936
+ | Number Portability routing information | O <sub>C</sub> | This field includes information on number portability after DNS/ENUM request from S-CSCF in the calling user's home network. |
937
+ | Carrier Select routing information | O <sub>C</sub> | This field includes information on carrier select after DNS/ENUM request from S-CSCF in the calling user's home network. |
938
+
939
+ #### 6.3.1.2 Definition of the SMS Information
940
+
941
+ The components in the SMS Information that are used for SMS charging can be found in table 6.3.1.2.
942
+
943
+ **Table 6.3.1.2: SMS Information used for SMS Charging**
944
+
945
+ | Field | Category | Description |
946
+ |-----------------------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
947
+ | SMS Node | O <sub>M</sub> | Identifies the SMS Node as IP-SM-GW or SMS Router or a combined IP-SM-GW / SMS Router or as SMS-SC. |
948
+ | SM Client Address | O <sub>M</sub> | This field holds the address of the SMS node to which the charging system is connected to. This may be the same as the SMSC Address field. |
949
+ | Originator SCCP Address | O <sub>C</sub> | This field holds the SCCP calling address used to receive the SM at the SMS node. Only present if SMSIP is not used for the inward connection. |
950
+ | Originator Received Address | O <sub>C</sub> | This field holds the original, unmodified address of the originator of the SM, as received by the SMS node, in case address manipulation (such as number plan corrections) have been applied in the SMS node. This will typically be an E.164 number or a shortcode. Multiple addresses may be carried if additional information is available, e.g. IMSI and E.164 number. |
951
+ | Recipient Info | O <sub>C</sub> | This field holds recipient information for the SM. Each occurrence of this field denotes a different recipient.<br>Multiple occurrences of this field are allowed in case<br>- multiple recipients are associated with the charged event and<br>- all other charging information is identical for all recipients.<br>In case the SM contains a Delivery Report, as described in subclause 5.3.2.3, this field identifies the recipient of this Delivery Report. This recipient information must correspond to the originator information of the message that triggered this Delivery Report. (Note 2) |
952
+ | Recipient Address | O <sub>C</sub> | This field holds the address of the recipient of the SM. This will typically be an E.164 number or a shortcode. Multiple addresses may be carried if additional information is available, e.g. shortcode or IMSI and E.164 number. |
953
+ | Recipient Received Address | O <sub>C</sub> | This field holds the original, unmodified address of the recipient of the SM, as received by the SMS node, in case address manipulation (such as number plan corrections) have been applied in the SMS node. This will typically be an E.164 number or a shortcode. Multiple addresses may be carried if additional information is available, e.g. shortcode or IMSI and E.164 number. |
954
+ | Recipient SCCP Address | O <sub>C</sub> | This field holds the SCCP called address used by the SMS node to onward deliver the SM. Only present if SMSIP is not used for the outward connection. |
955
+ | SM Destination Interface | O <sub>M</sub> | This is a structured field containing information describing the interface on which the SM is to be delivered (i.e. the next hop)<br>In case the charging event is for person to application messaging or for application to application messaging (see subclause 5.1.1) this field holds the identification of the application. (See also Note 3) |
956
+ | SM Protocol Id | O <sub>C</sub> | This field holds the TP-PROTOCOL-ID (TP-PID) as defined in 3GPP TS 23.040 [7]. This field relates to the recipient when charging MT SMS messages as specified in 32.240 [1]. |
957
+ | SMSC Address | O <sub>M</sub> | This field holds the address of the SMSC to which the originating or terminating SM is directed to. |
958
+ | SM Data Coding Scheme | O <sub>M</sub> | This field holds the data coding scheme used within the SM. The information to populate this field is obtained from TP-DCS header. |
959
+ | | | |
960
+ | SM Message Type | O <sub>M</sub> | This field identifies the message that triggered the generation of charging information. |
961
+ | SM Originator Interface | O <sub>M</sub> | This is a structured field containing information describing the interface on which the SM was received by the SMS node (i.e. the previous hop)<br>In case the charging event is for application to person messaging or for application to application messaging (see subclause 5.1.1) this field holds the identification of the application. (See also Note 3) |
962
+ | SM Protocol Id | O <sub>C</sub> | This field holds the TP-PROTOCOL-ID (TP-PID) as defined in 3GPP TS 23.040 [7] This field relates to the originator when charging MO SMS messages as specified in 32.240 [1]. |
963
+ | SM Reply Path Requested | O <sub>C</sub> | This field carries an indication of whether a reply SM to an original SM shall follow the same path as identified by the TP-Reply-Path (TP-RP) flag. |
964
+ | SM User Data Header | O <sub>C</sub> | This field carries the user data header extracted from the user data of the SM. The user data header (TP-UDH) is specified in 3GPP TS 23.040 [7] |
965
+ | SM Status | O <sub>C</sub> | This field holds the information from the TP-Status field in a Status-Report TPDU. This information is only applicable to delivery report charging procedures or where ECUR is employed. |
966
+ | SM Discharge Time | O <sub>C</sub> | This field holds the time associated with the event being reported in the SM Status field. This information is only applicable to delivery report charging procedures. |
967
+ | Number of Messages Sent | O <sub>C</sub> | Indicates the number of SMSs sent by the IMS application if applicable. |
968
+
969
+ | | | |
970
+ |-----------------|----|--------------------------------------------------------------------------------------------------------------------------------------------------|
971
+ | SM Service Type | Oc | This field indicates the type of SM service that caused the charging interaction. It is only applicable for SM supplementary service procedures. |
972
+ |-----------------|----|--------------------------------------------------------------------------------------------------------------------------------------------------|
973
+
974
+ NOTE 1: The case of multi-destinations of SMS refers to SMS and Internet Electronic Mail interworking as specified in subclause 3.8 of TS 23.040 [7]
975
+
976
+ NOTE 2: Implementations vary as to the originator address that is presented to an end user for a Delivery Report. Typically the originator address either identifies the SMS node that generated the Delivery Report or the originator address of a Delivery Report identifies the recipient of the original message that triggered this Report. It is expected that the charging event contains the information presented to the end user.
977
+
978
+ NOTE 3: There is a distinction between short numbers (as conveyed in originator and/or recipient address fields) and the identification of SM applications (as carried in SM Originator Interface and/or SM Destination Interface). Short numbers are used by end users to address a service of an applications. Multiple short numbers may map to one application capable of multiple services. The identification of an application is how an application is known to the operator.
979
+
980
+ ### 6.3.2 Formal parameter description
981
+
982
+ #### 6.3.2.1 SMS charging information for CDRs
983
+
984
+ *Editor's Note: For Future Study.*
985
+
986
+ #### 6.3.2.2 SMS charging information for charging events
987
+
988
+ *Editor's Note: For Future Study.*
989
+
990
+ # Annex A (informative): Change history
991
+
992
+ | Change history | | | | | | | | | |
993
+ |----------------|-------|-----------|------|-----|----------------------------------------------------------------------------|------|-------|--------|--|
994
+ | Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Ca t | Old | New | |
995
+ | Sep 2007 | SP-37 | SP-070620 | -- | -- | Submitted to TSG SA#37 for Information | -- | 1.0.0 | | |
996
+ | Dec 2007 | SP-38 | SP-070748 | -- | -- | Submitted to TSG SA#38 for Approval | -- | 2.0.0 | 8.0.0 | |
997
+ | Dec 2007 | -- | -- | -- | -- | editHelp: the figures are now visible in normal view | -- | 8.0.0 | 8.0.1 | |
998
+ | Mar 2008 | SP-39 | SP-080074 | 0001 | -- | Correction on Service Information for SMS Charging | F | 8.0.1 | 8.1.0 | |
999
+ | Jun 2008 | SP-40 | SP-080330 | 0002 | -- | Support of Number Portability and Carrier Selection in SMS Online Charging | B | 8.1.0 | 8.2.0 | |
1000
+ | Sep 2008 | SP-41 | SP-081216 | 0003 | -- | Multiple SMS destination – Alignment with TS 23.040 | C | 8.2.0 | 8.3.0 | |
1001
+ | Sep 2008 | SP-41 | SP-081224 | 0004 | -- | Introduce Online Charging from SMS-SC into 3GPP TS 32.274 | B | 8.2.0 | 8.3.0 | |
1002
+ | Dec 2008 | SP-42 | SP-080706 | 0005 | -- | Correction on Multiple Unit Operation category | F | 8.3.0 | 8.4.0 | |
1003
+ | Dec 2008 | SP-42 | SP-080706 | 0006 | -- | Add SMS-SC as SMS node type | B | 8.3.0 | 8.4.0 | |
1004
+ | Dec 2008 | SP-42 | SP-080706 | 0007 | -- | Additional Address Info for SMS charging | B | 8.3.0 | 8.4.0 | |
1005
+ | Dec 2008 | SP-42 | SP-080706 | 0008 | -- | Add charging of SMS services to 32.274 | B | 8.3.0 | 8.4.0 | |
1006
+ | Mar 2009 | SP-43 | SP-090045 | 0009 | -- | SMS IE structure alignment | F | 8.4.0 | 8.5.0 | |
1007
+ | Jun 2009 | SP-44 | SP-090293 | 0010 | -- | Clarification of "Termination charge" and application addressing | F | 8.5.0 | 8.6.0 | |
1008
+ | Sep 2009 | SP-45 | SP-090536 | 0011 | -- | IE usage for Delivery Reports and Application Identifiers | F | 8.6.0 | 8.7.0 | |
1009
+ | Dec 2009 | - | - | - | - | Update to Rel-9 version (MCC) | - | 8.7.0 | 9.0.0 | |
1010
+ | Mar 2011 | - | - | - | - | Update to Rel-10 version (MCC) | - | 9.0.0 | 10.0.0 | |
1011
+
marked/Rel-10/32_series/32275/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
marked/Rel-10/32_series/32280/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
marked/Rel-10/32_series/32295/raw.md ADDED
@@ -0,0 +1,1201 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+
4
+
5
+
6
+
7
+ # Contents
8
+
9
+ | | |
10
+ |------------------------------------------------------------------------------|-----------|
11
+ | Foreword ..... | 4 |
12
+ | 1 Scope..... | 5 |
13
+ | 2 References..... | 5 |
14
+ | 3 Definitions, symbols and abbreviations ..... | 6 |
15
+ | 3.1 Definitions..... | 6 |
16
+ | 3.2 Abbreviations ..... | 8 |
17
+ | 3.3 Symbols..... | 9 |
18
+ | 4 Architecture Considerations..... | 9 |
19
+ | 4.1 High level architecture ..... | 9 |
20
+ | 5 Transfer principles and scenarios..... | 10 |
21
+ | 5.1 Transfer principles..... | 10 |
22
+ | 5.1.1 Charging related transfer requirements ..... | 10 |
23
+ | 5.1.2 CDR Transport by GTP' ..... | 10 |
24
+ | 5.1.2.1 CDF - CGF communication..... | 11 |
25
+ | 5.1.2.2 CGF - CGF communication..... | 11 |
26
+ | 5.1.3 Port usage ..... | 12 |
27
+ | 5.2 GTP' transfer scenarios ..... | 12 |
28
+ | 5.2.1 Basic principles ..... | 12 |
29
+ | 5.2.2 GTP' messaging cases..... | 12 |
30
+ | 5.2.2.1 The normal CDR packet transfer..... | 13 |
31
+ | 5.2.2.2 The CDF-CGF connection breaks before a successful CDR reception..... | 14 |
32
+ | 5.2.2.3 The CDF-CGF connection breaks after a successful CDR reception..... | 16 |
33
+ | 5.2.2.4 CGF redundancy mechanism..... | 17 |
34
+ | 6 Data description for the transfer..... | 20 |
35
+ | 6.1 The GTP' charging protocol ..... | 20 |
36
+ | 6.1.1 Usage of GTP Header in charging..... | 20 |
37
+ | 6.1.2 Information Elements (IEs) ..... | 20 |
38
+ | 6.2 GTP' Message Types..... | 21 |
39
+ | 6.2.1 List of all GTP' message types ..... | 21 |
40
+ | 6.2.2 Reused GTP message types..... | 22 |
41
+ | 6.2.3 GTP message type modifications, implied by GTP'..... | 23 |
42
+ | 6.2.4 GTP' message types..... | 23 |
43
+ | 6.2.4.1 Node Alive Request..... | 23 |
44
+ | 6.2.4.2 Node Alive Response..... | 23 |
45
+ | 6.2.4.3 Redirection Request..... | 23 |
46
+ | 6.2.4.4 Redirection Response ..... | 25 |
47
+ | 6.2.4.5 Data Record Transfer Request..... | 25 |
48
+ | 6.2.4.5.1 Information Elements in Data Record Transfer Request ..... | 25 |
49
+ | 6.2.4.5.2 Packet Transfer Command IE ..... | 25 |
50
+ | 6.2.4.5.3 Data Record Packet IE ..... | 27 |
51
+ | 6.2.4.5.4 Sequence Numbers of Released Packets IE ..... | 27 |
52
+ | 6.2.4.5.5 Sequence Numbers of Cancelled Packets IE..... | 28 |
53
+ | 6.2.4.5.6 Private Extension IE..... | 28 |
54
+ | 6.2.4.6 Data Record Transfer Response ..... | 28 |
55
+ | 6.3 Data Record Format in GTP' ..... | 29 |
56
+ | 6.3.1 Standard Data Record Format ..... | 29 |
57
+ | 6.3.2 Private Data Record Formats..... | 29 |
58
+ | 6.4 Data Record Format Version for CDRs..... | 30 |
59
+ | <b>Annex A (informative): Bibliography .....</b> | <b>31</b> |
60
+ | Annex B (informative): Change history..... | 32 |
61
+
62
+ # --- Foreword
63
+
64
+ This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP).
65
+
66
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
67
+
68
+ Version x.y.z
69
+
70
+ where:
71
+
72
+ - x the first digit:
73
+ - 1 presented to TSG for information;
74
+ - 2 presented to TSG for approval;
75
+ - 3 or greater indicates TSG approved document under change control.
76
+ - y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
77
+ - z the third digit is incremented when editorial only changes have been incorporated in the document.
78
+
79
+ # --- 1 Scope
80
+
81
+ The present document is part of a series of documents that specify charging functionality and charging management in 3GPP networks (GSM/UMTS/EPS). The 3GPP core network charging architecture and principles are specified in 3GPP TS 32.240 [1], which provides an umbrella for other charging management TSs that specify:
82
+
83
+ - the content of the CDRs per domain / subsystem / service (offline charging),
84
+ - the content of real-time charging messages per domain / subsystem / service (online charging);
85
+ - the functionality of online and offline charging for those domains / subsystems / services;
86
+ - the interfaces that are used in the charging framework to transfer the charging information (i.e. CDRs or charging events)
87
+
88
+ The complete document structure for these TSs is defined in TS 32.240 [1].
89
+
90
+ The present document specifies the transaction based mechanism for the near real time transfer of CDRs within the network.
91
+
92
+ The present document is related to other 3GPP charging TSs as follows:
93
+
94
+ - The common 3GPP charging architecture is specified in TS 32.240 [1];
95
+ - The parameters, abstract syntax and encoding rules for the CDRs are specified in TS 32.298 [51];
96
+ - The file based mechanism used to transfer the CDRs from the network to the operator's billing domain (e.g. the post-processing system or a mediation device) is specified in TS 32.297 [52];
97
+
98
+ The 3GPP Diameter application that is used for offline and online charging is specified in TS 32.299 [50].
99
+
100
+ All terms, definitions and abbreviations used in the present document, that are common across 3GPP TSs, are defined in the 3GPP Vocabulary, TR 21.905 [100]. Those that are common across charging management in 3GPP domains services, or subsystems are provided in the umbrella document TS 32.240 [1] and are copied into clause 3 of the present document for ease of reading. Finally, those items that are specific to the present document are defined exclusively in the present document.
101
+
102
+ Furthermore, requirements that govern the charging work are specified in 3GPP TS 22.115 [101].
103
+
104
+ # --- 2 References
105
+
106
+ The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
107
+
108
+ - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
109
+ - For a specific reference, subsequent revisions do not apply.
110
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
111
+
112
+ - [1] 3GPP TS 32.240: "Telecommunication management; Charging management; Charging Architecture and Principles".
113
+ - [2]-[9] Void.
114
+ - [10] 3GPP TS 32.250: "Telecommunication management; Charging management; Circuit Switched (CS) domain charging".
115
+ - [11] 3GPP TS 32.251: "Telecommunication management; Charging management; Packet Switched (PS) domain charging".
116
+
117
+ | | |
118
+ |-------------|---------------------------------------------------------------------------------------------------------------------------|
119
+ | [12]-[29] | Void. |
120
+ | [30] | 3GPP TS 32.270: "Telecommunication management; Charging management; Multimedia Messaging Service (MMS) charging". |
121
+ | [31]-[49] | Void. |
122
+ | [50] | 3GPP TS 32.299: "Telecommunication management; Charging management; Diameter charging application". |
123
+ | [51] | 3GPP TS 32.298: "Telecommunication management; Charging management; Charging Data Record (CDR) parameter description". |
124
+ | [52] | 3GPP TS 32.297: "Telecommunication management; Charging management; Charging Data Record (CDR) file format and transfer". |
125
+ | [53]-[99] | Void. |
126
+ | [100] | TR 21.905: "Vocabulary for 3GPP Specifications". |
127
+ | [101] | 3GPP TS 22.115 "Service aspects; Charging and billing" |
128
+ | [102]-[199] | Void. |
129
+ | [200] | 3GPP TS 29.060: "General Packet Radio Service (GPRS); GPRS Tunnelling Protocol (GTP) across the Gn and Gp interface". |
130
+ | [201] | 3GPP TS 29.274: "Evolved GPRS Tunnelling Protocol for Control Plane (GTPv2-C); Stage 3". |
131
+ | [202]-[299] | Void. |
132
+ | [300]-[399] | Void. |
133
+ | [400-403] | Void. |
134
+ | [404] | IETF RFC 768 (1980): "User Datagram Protocol" (STD 6). |
135
+ | [405] | IETF RFC 793 (1981): "Transmission Control Protocol" (STD 7). |
136
+ | [406] | IETF RFC 791 (1981): "Internet Protocol" (STD 5). |
137
+ | [407] | IETF RFC 792 (1981): "Internet Control Message Protocol" (STD 5). |
138
+
139
+ # --- 3 Definitions, symbols and abbreviations
140
+
141
+ ## 3.1 Definitions
142
+
143
+ For the purposes of the present document, the following terms and definitions given in 3GPP TR 21.905 [50], 3GPP TS 32.240 [1], and the following apply:
144
+
145
+ **2G- / 3G-:** prefixes 2G- and 3G- refers to functionality that supports only GSM or UMTS, respectively, e.g. 2G-CDF refers only to the GSM functionality of an CDF.
146
+
147
+ **accounting:** process of apportioning charges between the Home Environment, Serving Network and User.
148
+
149
+ **billing:** function whereby CDRs generated by the charging function are transformed into bills requiring payment.
150
+
151
+ **Billing Domain:** Part of the operator network, which is outside the core network, that receives and processes CDR files from the core network charging functions. It includes functions that can provide billing mediation and billing other (e.g. statistical) end applications. It is only applicable to offline charging (see "Online Charging System" for equivalent functionality in online charging).
152
+
153
+ **CDR field Categories:** the CDR fields are defined in the present document. They are divided into the following categories:
154
+
155
+ - **Mandatory (M):** field that shall be present in the CDR.
156
+ - **Conditional (C):** field that shall be present in a CDR if certain conditions are met.
157
+ - **Operator Provisionable: Mandatory (O<sub>M</sub>):** A field that operators have provisioned to be included in the CDR for all conditions.
158
+ - **Operator Provisionable: Conditional (O<sub>C</sub>):** A field that operators have provisioned to be included in the CDR if certain conditions are met.
159
+
160
+ **chargeable event:** activity utilizing telecommunications network infrastructure and related services for:
161
+
162
+ - user to user communication (e.g. a single call, a data communication session or a short message); or
163
+ - user to network communication (e.g. service profile administration); or
164
+ - inter-network communication (e.g. transferring calls, signalling, or short messages); or
165
+ - mobility (e.g. roaming or inter-system handover); and
166
+ - that the network operator wants to charge for.
167
+
168
+ **charged party:** user involved in a chargeable event who has to pay parts or the whole charges of the chargeable event, or a third party paying the charges caused by one or all users involved in the chargeable event, or a network operator.
169
+
170
+ **charging:** function whereby information related to a chargeable event is formatted and transferred in order to make it possible to determine usage for which the charged party may be billed.
171
+
172
+ **Charging Data Record (CDR):** A formatted collection of information about a chargeable event (e.g. time of call set-up, duration of the call, amount of data transferred, etc) for use in billing and accounting. For each party to be charged for parts of or all charges of a chargeable event a separate CDR shall be generated, i.e. more than one CDR may be generated for a single chargeable event, e.g. because of its long duration, or because more than one charged party is to be charged.
173
+
174
+ **charging function:** entity inside the core network domain, subsystem or service that is involved in charging for that domain, subsystem or service.
175
+
176
+ **circuit switched domain:** domain within GSM / UMTS in which information is transferred in circuit mode.
177
+
178
+ **domain:** part of a communication network that provides services using a certain technology.
179
+
180
+ **GPRS:** Packet Services for GSM and UMTS systems.
181
+
182
+ **GTP':** GPRS protocol, used for CDR transport. It is derived from GTP with enhancements to improve transport reliability necessary for CDRs. NOTE: This protocol is not used for tunnelling.
183
+
184
+ **GSM only:** qualifier indicating that this clause or paragraph applies only to a GSM system. For multi-system cases this is determined by the current serving radio access network.
185
+
186
+ **inter-system change:** change of radio access between different radio access technologies such as GSM and UMTS.
187
+
188
+ **in GSM,....:** qualifier indicating that this paragraph applies only to GSM System.
189
+
190
+ **in UMTS,....:** qualifier indicating that this paragraph applies only to UMTS System.
191
+
192
+ **middle tier (charging) TS:** used for the 3GPP charging TSs that specify the domain / subsystem / service specific, online and offline, charging functionality. These are all the TSs in the numbering range from 3GPP TS 32.250 [10] to 3GPP TS 32.27x [3x], e.g. 3GPP TS 32.250 [10] for the CS domain, or 3GPP TS 32.270 [30] for the MMS service. Currently, there is only one "tier 1" TS in 3GPP, which is the TS 32.240 [1] that specifies the charging architecture and principles. Finally, there are a number of top tier TSs in the 32.29x numbering range ([50] ff) that specify common charging aspects such as parameter definitions, encoding rules, the common BD interface or common charging applications.
193
+
194
+ **near real time:** near real time charging and billing information is to be generated, processed, and transported to a desired conclusion in less than 1 minute.
195
+
196
+ **observed IMEI ticket:** record used to describe an EIR relevant event e.g. a blacklisted IMEI.
197
+
198
+ **offline charging:** charging mechanism where charging information **does not** affect, in real-time, the service rendered.
199
+
200
+ **online charging:** charging mechanism where charging information can affect, in real-time, the service rendered and therefore a direct interaction of the charging mechanism with session/service control is required.
201
+
202
+ **Online Charging System:** the entity that performs real-time credit control. Its functionality includes transaction handling, rating, online correlation and management of subscriber accounts/balances.
203
+
204
+ **packet switched domain:** domain in which data is transferred between core network elements.
205
+
206
+ **Real-time:** real time charging and billing information is to be generated, processed, and transported to a desired conclusion in less than 1 second.
207
+
208
+ **subscriber:** A subscriber is an entity (associated with one or more users) that is engaged in a Subscription with a service provider. The subscriber is allowed to subscribe and unsubscribe services, to register a user or a list of users authorised to enjoy these services, and also to set the limits relative to the use that associated users make of these services.
209
+
210
+ **UMTS only:** qualifier indicating that this clause or paragraph applies only to a UMTS system. For multi-system cases this is determined by the current serving radio access network.
211
+
212
+ **user:** An entity, not part of the 3GPP System, that uses network resources by means of a subscription. The user may or may not be identical to the subscriber holding that subscription.
213
+
214
+ ## 3.2 Abbreviations
215
+
216
+ For the purposes of the present document, the abbreviations defined in 3GPP TR 21.905 [50], 3GPP TS 32.240 [1] and the following apply:
217
+
218
+ | | |
219
+ |-----------|----------------------------------------------------|
220
+ | 3G | 3 <sup>rd</sup> Generation |
221
+ | 3GPP | 3 <sup>rd</sup> Generation Partnership Project |
222
+ | AS | Application Server |
223
+ | ASN.1 | Abstract Syntax Notation One |
224
+ | BD | Billing Domain |
225
+ | CDF | Charging Data Function |
226
+ | CDR | Charging Data Record |
227
+ | CG | Charging Gateway |
228
+ | CGF | Charging Gateway Function |
229
+ | CS | Circuit SwitchedDRP Data Record Packet |
230
+ | EPS | Evolved Packet System |
231
+ | E-UTRAN | Evolved Universal Terrestrial Radio Access Network |
232
+ | GPRS | General Packet Radio Service |
233
+ | GTP | GPRS Tunnelling Protocol |
234
+ | GTPv2-C | GTP version 2 – Control Plane |
235
+ | GTP' | GPRS protocol, used for CDR transport |
236
+ | IE | Information Element |
237
+ | IP | Internet Protocol |
238
+ | IPv4 | Internet Protocol version 4 |
239
+ | IPv6 | Internet Protocol version 6 |
240
+ | NE | Network Element |
241
+ | OCS | Online Charging System |
242
+ | PDN | Packet Data Network |
243
+ | PS | Packet-Switched |
244
+ | PT | Protocol Type (Field in GTP' header) |
245
+ | S-SMO-CDR | SGSN Short Message Mobile Originated - CDR |
246
+ | TAP | Transferred Account Procedure |
247
+ | TLV | Type, Length, Value (GTP header format) |
248
+ | TV | Type, Value |
249
+
250
+ ## 3.3 Symbols
251
+
252
+ For the purposes of the present document, the following symbols apply:
253
+
254
+ | | |
255
+ |----|-----------------------------------------------------------------------------------------------|
256
+ | Bx | The reference point between any (generic) 3G domain, subsystem or service CGF and the BD. |
257
+ | Ga | Reference point between a CDF and the CGF for CDR transfer. |
258
+ | Rf | Reference Point between the CTF within a 3G network element and the CDF for offline charging. |
259
+
260
+ # 4 Architecture Considerations
261
+
262
+ ## 4.1 High level architecture
263
+
264
+ The Ga is the reference point from the Charging Data Function (CDF) to the Charging Gateway Function (CGF), which is intended for the transport of Charging Data Records (CDRs).
265
+
266
+ By definition, dealing with CDRs only implies that Ga is solely related to offline charging.
267
+
268
+ The following figure 4.1 depicts the position of the Ga reference point within the overall 3GPP offline charging architecture.
269
+
270
+ ![Figure 4.1: Logical ubiquitous offline charging architecture. The diagram shows a 3GPP network (grey box) containing three domains: CN Domain (yellow), Service nodes (orange), and Sub-system (purple). Each domain contains a Charging Trigger Function (CTF, pink vertical bar) and a Charging Data Function (CDF, green vertical bar). Arrows labeled Rf point from the CTF to the CDF within each domain. Arrows labeled Ga point from the CDF in the Service nodes and Sub-system to a Charging Gateway Function (CGF, orange vertical bar). An arrow labeled Bx points from the CGF to the Billing Domain (blue box).](0bf9346902e9a3bdabf05ceacc1947f5_img.jpg)
271
+
272
+ Figure 4.1: Logical ubiquitous offline charging architecture. The diagram shows a 3GPP network (grey box) containing three domains: CN Domain (yellow), Service nodes (orange), and Sub-system (purple). Each domain contains a Charging Trigger Function (CTF, pink vertical bar) and a Charging Data Function (CDF, green vertical bar). Arrows labeled Rf point from the CTF to the CDF within each domain. Arrows labeled Ga point from the CDF in the Service nodes and Sub-system to a Charging Gateway Function (CGF, orange vertical bar). An arrow labeled Bx points from the CGF to the Billing Domain (blue box).
273
+
274
+ | | |
275
+ |-------------|----------------------------------------------------------------------------------------------|
276
+ | <b>CTF:</b> | <b>Charging Trigger Function</b> |
277
+ | <b>CDF:</b> | <b>Charging Data Function</b> |
278
+ | <b>CGF:</b> | <b>Charging Gateway Function</b> |
279
+ | <b>BD:</b> | <b>Billing Domain.</b> This may also be a billing mediation device / post-processing system. |
280
+
281
+ **Figure 4.1: Logical ubiquitous offline charging architecture**
282
+
283
+ As illustrated in the above figure 4.1, the CDF in each network domain, service or subsystem is relevant for the network side of the Ga reference point. Different mappings of the ubiquitous offline charging functions, CDF and CGF, onto physical implementations are possible. Further details of the configuration refer to 3GPP TS 32.240 [1]. Details of the implementation options per domain / subsystem / service (usually a subset of the overall possible variants described above) are specified in the respective middle tier TS, e.g. for EPC Charging in TS 32.251[11].
284
+
285
+ The transport protocol associated to the Ga reference point, providing functions for transfer of CDRs from CDF to CGF, is **GTP'** (because of its derivation from the GTP protocol as specified in TS 29.060[200]).
286
+
287
+ # --- 5 Transfer principles and scenarios
288
+
289
+ ## 5.1 Transfer principles
290
+
291
+ The GTP' protocol is optional, and is used for CDR transport between the CDFs and the CGF.
292
+
293
+ ### 5.1.1 Charging related transfer requirements
294
+
295
+ Each CDF will have an O&M configurable address list of CGFs (Charging Gateways) to which it can send its CDRs. The list will be organized in CGF address priority order. If the primary CGF is not available (e.g. out of service), then the CDF shall send the CDRs to the secondary CGF and so on.
296
+
297
+ Each CDR generating function will only send the records to the CGF(s) of the same PLMN, not to CGF(s) located in other PLMNs.
298
+
299
+ Each CGF in the PLMN may know of other CGFs' network addresses (e.g., for redundancy reasons, to be able to recommend another CGF address). This is achieved by O&M configuration facilities that will enable each CGF to have a configurable list of peer CGF addresses.
300
+
301
+ ### 5.1.2 CDR Transport by GTP'
302
+
303
+ GTP' has been designed to deliver the CDR(s) from the CDF, which generates charging data records (CDRs) to the CGF(s). This protocol is required if the CGF resides outside the CDFs. It utilizes some aspects of GTP (defined in TS 29.060 [200]), which is used for packet data tunnelling in the backbone network.
304
+
305
+ GTP' operates on the Ga interface and does not imply the use of any specific backbone network.
306
+
307
+ GTP' performs the following functions:
308
+
309
+ - CDR transfer between the CDF and the CGF.
310
+ - Redirection of CDRs to another CGF.
311
+ - Detect communication failures between the communicating peers, using echo messaging.
312
+ - Advertise to peers about its CDR transfer capability (e.g., after a period of service downtime).
313
+ - Prevents duplicate CDRs that might arise during redundancy operations.
314
+ If so configured, the CDR duplication prevention function may also be carried out by marking potentially duplicated CDR packets, and, delegating the final duplicate deletion task to a CGF or the Billing Domain (instead of handling the possible duplicates solely by GTP' messaging).
315
+
316
+ #### 5.1.2.1 CDF - CGF communication
317
+
318
+ As illustrated in Figure 5.1, the CDF - CGF communications are carried out using GTP' over UDP/TCP and IP.
319
+
320
+ ![Diagram showing protocol layers between CDF and CGF for CDRs. The diagram consists of two vertical stacks of five boxes representing protocol layers. The left stack is labeled 'CDF' at the bottom and the right stack is labeled 'CGF' at the bottom. Above each stack is the label 'CDRs' with a horizontal arrow pointing from the left 'CDRs' to the right 'CDRs'. The layers in each stack, from top to bottom, are: GTP', UDP/TCP, IP, L2, and L1. Horizontal lines connect corresponding layers between the CDF and CGF stacks.](7e670a2b556b53ea9002dfff3a420e08_img.jpg)
321
+
322
+ Diagram illustrating the protocol layers between the CDF and the CGF for CDRs. The diagram shows two stacks of protocol layers. The left stack is labeled CDF and the right stack is labeled CGF. Above each stack is the label CDRs with a horizontal arrow pointing from the left CDRs to the right CDRs. The layers in each stack, from top to bottom, are: GTP', UDP/TCP, IP, L2, and L1. Horizontal lines connect corresponding layers between the CDF and CGF stacks.
323
+
324
+ Diagram showing protocol layers between CDF and CGF for CDRs. The diagram consists of two vertical stacks of five boxes representing protocol layers. The left stack is labeled 'CDF' at the bottom and the right stack is labeled 'CGF' at the bottom. Above each stack is the label 'CDRs' with a horizontal arrow pointing from the left 'CDRs' to the right 'CDRs'. The layers in each stack, from top to bottom, are: GTP', UDP/TCP, IP, L2, and L1. Horizontal lines connect corresponding layers between the CDF and CGF stacks.
325
+
326
+ **Figure 5.1: Protocol layers between the CDF and the CGF**
327
+
328
+ #### 5.1.2.2 CGF - CGF communication
329
+
330
+ If necessary, CGF to CGF communications are carried out using GTP' over UDP/TCP and IP. This is illustrated in Figure 5.2.
331
+
332
+ ![Diagram showing protocol layers between two CGFs for CDRs. The diagram consists of two vertical stacks of five boxes representing protocol layers. The left stack is labeled 'CGF' at the bottom and the right stack is labeled 'CGF' at the bottom. Above each stack is the label 'CDRs' with a horizontal arrow pointing from the left 'CDRs' to the right 'CDRs'. The layers in each stack, from top to bottom, are: GTP', UDP/TCP, IP, L2, and L1. Horizontal lines connect corresponding layers between the two CGF stacks.](7c6d9bfe9c31ce872722d60b73d20df1_img.jpg)
333
+
334
+ Diagram illustrating the protocol layers between two CGFs for CDRs. The diagram shows two stacks of protocol layers. The left stack is labeled CGF and the right stack is labeled CGF. Above each stack is the label CDRs with a horizontal arrow pointing from the left CDRs to the right CDRs. The layers in each stack, from top to bottom, are: GTP', UDP/TCP, IP, L2, and L1. Horizontal lines connect corresponding layers between the two CGF stacks.
335
+
336
+ Diagram showing protocol layers between two CGFs for CDRs. The diagram consists of two vertical stacks of five boxes representing protocol layers. The left stack is labeled 'CGF' at the bottom and the right stack is labeled 'CGF' at the bottom. Above each stack is the label 'CDRs' with a horizontal arrow pointing from the left 'CDRs' to the right 'CDRs'. The layers in each stack, from top to bottom, are: GTP', UDP/TCP, IP, L2, and L1. Horizontal lines connect corresponding layers between the two CGF stacks.
337
+
338
+ **Figure 5.2: Protocol layers between CGFs**
339
+
340
+ ### 5.1.3 Port usage
341
+
342
+ Transporting the CDRs from the CDFs to the CGF over the Ga reference point may facilitate charging. The Path Protocol may be UDP (compliant with STD 0006[404]) or TCP (compliant with STD 0007[405]) over IP.
343
+
344
+ - UDP as the Path Protocol
345
+
346
+ Ports for signalling the request messages:
347
+
348
+ - The UDP Destination Port may be the server port number 3386 which has been reserved for GTP'. Alternatively another port can be used, which has been configured by O&M, except Port Number 2123 which is used by GTPv2-C.
349
+ - The UDP Source Port is a locally allocated port number at the sending network element.
350
+
351
+ NOTE: UDP Source Port number should be different than UDP Source Port number allocated to GTPv2 (see TS 29.274 [201]).
352
+
353
+ Ports for signalling the response messages:
354
+
355
+ - The UDP Destination Port value shall be the value of the Source Port of the corresponding request message.
356
+ - The UDP Source Port shall be the value from the Destination Port of the corresponding request message.
357
+
358
+ - TCP as Path Protocol
359
+
360
+ The TCP Destination Port may be the server port number 3386, which has been reserved for G-PDUs. Alternatively, another port may be used as configured by O&M. Extra implementation-specific destination ports are possible but all CGFs shall support the server port number.
361
+
362
+ The TCP Source Port is a random port, locally assigned at the sending network element.
363
+
364
+ - Network layer and lower layers
365
+
366
+ Beneath the Path Protocol there is the network IP layer, which shall be the Internet Protocol (IP) compliant with STD 0005(see [406] and [407]). Beneath the network IP layer are the L2 and L1 layers, which are not specified, in the present document.
367
+
368
+ ## 5.2 GTP' transfer scenarios
369
+
370
+ ### 5.2.1 Basic principles
371
+
372
+ Each function (i.e. CDF and CGF) that supports the GTP' shall be capable of handling or responding with a "Service/Version not supported" message if that function is configured to be addressed by another peer function.
373
+
374
+ ### 5.2.2 GTP' messaging cases
375
+
376
+ The following example cases represent the three different key *Data Record Transfer Request/Response* messaging related CDR handling schemes. Cases (2) and (3) represent situations involving the redundancy mechanism.
377
+
378
+ - (1) The normal CDR packet transfer:
379
+
380
+ The CDF sends successfully a CDR packet to the CGF, and since the CDF gets a response (Request Accepted) for the Data Record Transfer Request, there is no need to use the CGF redundancy mechanism and redirect the CDR packet traffic flow to an other CGF.
381
+
382
+ - (2) The CDF-CGF connection breaks before a successful CDR reception:
383
+
384
+ In this case the CDR packet sent by the CDF is lost before it is received by the CGF. (The loss might be caused by a link failure or e.g. a major CGF failure.)
385
+
386
+ - (3) The CDF-CGF connection breaks after a successful CDR reception:
387
+
388
+ In this case the CDR sent by the CDF is received correctly by the CGF and moved to its non-volatile memory (or even to the next NE in the communication chain). Anyhow, the CDF-CGF communication stops working, in this example case, before the CDF gets the positive response (Data Record Transfer Response: Request Accepted) which would acknowledge that the CDR packet was successfully received by CGF.
389
+
390
+ #### (4) CGF redundancy mechanism
391
+
392
+ An overview on the mechanism, involved in cases (2) and (3), preventing duplicated CDR packets to enter a BD.
393
+
394
+ The next four clauses describe in more detail each of these key *Data Record Transfer Request / Response* messaging schemes.
395
+
396
+ #### 5.2.2.1 The normal CDR packet transfer
397
+
398
+ Figure 5.3 represents the default mode of CDR transfer from the CDR generating functions (CDFs) to the CDR collecting functions (CGFs).
399
+
400
+ ![Sequence diagram of normal CDR transfer process between a CDF and CGF. Lifelines: CDF, CGF's volatile memory, Non-volatile CGF memory. Steps: 1. CDF sends 'Data Record Transfer Request: Send Data Record Packet' to CGF's volatile memory. 2. CGF's volatile memory stores CDRs in non-volatile CGF memory. 3. CGF's volatile memory sends 'Data Record Transfer Response: Request Accepted' back to CDF. 4. CDF deletes successfully sent CDRs from its buffers. Ellipses indicate further steps.](e9d825d87c5f85c8dba0664eace96ef4_img.jpg)
401
+
402
+ ```
403
+
404
+ sequenceDiagram
405
+ participant CDF
406
+ participant CGF as CGF's volatile memory
407
+ participant NVM as Non-volatile CGF memory
408
+ Note left of CDF: 4. < Successfully sent CDRs are deleted from the CDF buffers >
409
+ CDF->>CGF: 1. Data Record Transfer Request: Send Data Record Packet
410
+ CGF->>NVM: 2. CDRs are stored in a secure way
411
+ CGF->>CDF: 3. Data Record Transfer Response: Request Accepted
412
+ Note right of CGF: ...
413
+ Note right of NVM: ...
414
+
415
+ ```
416
+
417
+ Sequence diagram of normal CDR transfer process between a CDF and CGF. Lifelines: CDF, CGF's volatile memory, Non-volatile CGF memory. Steps: 1. CDF sends 'Data Record Transfer Request: Send Data Record Packet' to CGF's volatile memory. 2. CGF's volatile memory stores CDRs in non-volatile CGF memory. 3. CGF's volatile memory sends 'Data Record Transfer Response: Request Accepted' back to CDF. 4. CDF deletes successfully sent CDRs from its buffers. Ellipses indicate further steps.
418
+
419
+ **Figure 5.3: A normal CDR transfer process between a CDF and CGF**
420
+
421
+ - 1) The CDR generating entity sends CDR(s) in a packet to CGF (that is the current primary Charging Gateway Functionality for the specific CDF, "CGF1"). The sending is performed by using the *Data Record Transfer Request* message, with the *Packet Transfer Command* IE having the value "Send Data Record Packet".
422
+ - 2) The CGF opens the received message and stores the packet contents in a safe way (to e.g. a redundant RAM memory unit or a mirrored non-volatile memory or even to another node).
423
+ - 3) The CDR receiving entity (CGF) sends confirmation of the successful packet reception to the CDF (CDF). The confirmation is performed by using the *Data Record Transfer Response* message, with the **Cause** value being "Request Accepted".
424
+ - 4) After the positive response "Request Accepted" is received by the CDF, it may delete the successfully sent CDRs from its send buffer.
425
+
426
+ The general principle of GTP' to retransmit the request if the response has not been received within a configurable time-out limit, is also followed here in point 1). The maximum amount of retries is a configurable value.
427
+
428
+ #### 5.2.2.2 The CDF-CGF connection breaks before a successful CDR reception
429
+
430
+ Figure 5.4 describes the exceptional case when the CDR transfer from a CDR generating entity (CDF) to the primary CDR packet collecting entity (CGF1) fails in a way that the CGF1 is not able to store the CDR packet sent by the CDF. (The reason for the failure in packet transfer may be e.g. a link failure between the CDF and CGF1, or a capacity exhausting error in the storage device of CGF1, or a general CGF1 system failure or CGF1 maintenance break.)
431
+
432
+ ![Sequence diagram illustrating the CDR transfer process when the primary CGF1 fails. The diagram shows interactions between CDF, CGF1, CGF2, and a CDR post-processing system. The CDF sends a request to CGF1, which fails. The CDF then resends the request to CGF2, which succeeds. The CDF receives a response from CGF2, deletes its own buffers, and then sends a Node Alive request to CGF1. CGF1 responds. Finally, the CDF sends an empty request to CGF1, which is accepted, and then a release request to CGF2, which is also accepted.](a26e142d3df5bef41a84a9dd099d7825_img.jpg)
433
+
434
+ ```
435
+
436
+ sequenceDiagram
437
+ participant CDF
438
+ participant CGF1
439
+ participant CGF2
440
+ participant CDR_post_processing_system as CDR post-processing system
441
+
442
+ Note left of CDF: 1. Data Record Transfer Request: Send Data Record Packet
443
+ CDF->>CGF1:
444
+ Note right of CGF1: 2. < CDRs not stored to non-volatile memory nor sent to postprocessing >
445
+ Note left of CDF: 3. < No positive response to CDF even to resent requests >
446
+ Note left of CDF: 4. Data Record Transfer Request: Send possibly duplicated Data Record Packet
447
+ CDF->>CGF2:
448
+ Note right of CGF2: 5. < CGF2 stores the CDR packet contents to its buffer for pot. dupl. packets >
449
+ Note left of CDF: 6. Data Record Transfer Response: Request Accepted
450
+ CDF->>CGF2:
451
+ Note left of CDF: 7. < CDRs are deleted from CDF buffers >
452
+ Note left of CDF: 8. Node Alive Request
453
+ CDF->>CGF1:
454
+ Note right of CGF1: 9. Node Alive Response: Request Accepted
455
+ Note left of CDF: 10. Data Record Transfer Request: Send possibly duplicated Data Record Packet (empty)
456
+ CDF->>CGF1:
457
+ Note right of CGF1: 11. Data Record Transfer Response: Request Accepted
458
+ Note left of CDF: 12. Data Record Transfer Request: Release Data Record Packet
459
+ CDF->>CGF2:
460
+ Note right of CDR_post_processing_system: 13. CDRs
461
+ CDR_post_processing_system->>CGF2:
462
+ Note left of CDF: 14. Data Record Transfer Response: Request Accepted
463
+ CDF->>CGF2:
464
+
465
+ ```
466
+
467
+ Sequence diagram illustrating the CDR transfer process when the primary CGF1 fails. The diagram shows interactions between CDF, CGF1, CGF2, and a CDR post-processing system. The CDF sends a request to CGF1, which fails. The CDF then resends the request to CGF2, which succeeds. The CDF receives a response from CGF2, deletes its own buffers, and then sends a Node Alive request to CGF1. CGF1 responds. Finally, the CDF sends an empty request to CGF1, which is accepted, and then a release request to CGF2, which is also accepted.
468
+
469
+ **Figure 5.4: Duplicate prevention case: CDR sending via CGF1 had not succeeded**
470
+
471
+ - 1) The CDR generating entity (CDF) sends CDR(s) in a packet to CGF (that is, the current primary CGF for the specific CDF, "CGF1"). The sending is performed by using the *Data Record Transfer Request* message, with the *Packet Transfer Command* IE having the value "Send Data Record Packet".
472
+ - 2) Due to a failure in the CDF-CGF1 communication link of CGF1, the CGF1 is not able to store the packet sent by the CDF in a safe way (to e.g. a redundant RAM memory unit or a mirrored non-volatile memory or to another node).
473
+ - 3) Therefore the CDF is not able to get a response (or it could alternatively get a negative response like "No resources available" as the *Cause* value in the *Data Record Transfer Response* message).
474
+
475
+ - 4) The CDF may now first test the CDF-CGF2 link by an Echo Request message that the CGF2 would respond by the Echo Response.) Then, the CDF sends the same CDR packet that could not be sent to CGF1 to the next CGF in its CGF preference list (here CGF2) using the *Data Record Transfer Request* message, with the *Packet Transfer Command* IE having the value "Send possible duplicated Data Record Packet".
476
+ - 5) As the connection to the CGF2 is working, the CGF2 is able to process the CDR packet. Since the packet was marked by the sending CDF to be potentially duplicated, it is stored into the CGF2, but not yet sent forward towards the BD.
477
+ - 6) The CGF2 sends confirmation of the successful packet reception to the CDF. The confirmation is performed by using the *Data Record Transfer Response* message, with the **Cause** value being "Request Accepted"
478
+ - 7) The CDF can now delete the now successfully sent (potentially duplicated) CDRs from its CDR buffer (but it keeps the sequence number(s) of the sent potentially duplicated packet(s) in a buffer dedicated for that.
479
+ - 8) When CGF1 is recovering after a system reboot, it sends a *Node Alive Request* message to the configured peer CDF(s), and so the CDF notices that it can again successfully communicate with the CGF1. (The CDF may also detect this by using the *Echo Request* messages, which would be answered by CGF1 by the *Echo Response* message.)
480
+ - 9) CDF acknowledges the CGF1 by *Node Alive Response* message.
481
+ - 10) For the earlier unacknowledged *Data Record Transfer Request* message(s), the CDF sends CGF1 empty test packet(s) (with no CDR payload in the Data Record Packet IE but just the other parts of the message frame).
482
+ - 11) CGF1 responds with *Data Record Transfer Response* message, with the **Cause** value being "Request Accepted", because in this example case CGF1 had lost the communication capability towards CDF before storing the previously received (and by CGF1 unacknowledged) CDR packet.
483
+ - 12) Now CDF knows that the CGF1 had not originally been able to process and forward the original version of the CDR packet from the CDF, and it indicates CGF2 that CGF2 can send the CDR packet(s) related to the previously unacknowledged GTP' *Sequence Number(s)* to post-processing. Those packets' *Sequence Numbers* are indicated in the *Sequence Numbers of the Released Packets* IE.
484
+ - 13) CGF2 shall now be able to send the released records towards the post-processing system.
485
+ - 14) CGF2 responds with *Data Record Transfer Response* message, with the **Cause** value being 'Request Accepted'.
486
+
487
+ After all the potentially duplicated packets are cleared from CGF(s), the CDF can continue in normal way the transfer of CDRs.
488
+
489
+ #### 5.2.2.3 The CDF-CGF connection breaks after a successful CDR reception
490
+
491
+ ![Sequence diagram illustrating duplicate prevention when a connection breaks after successful CDR reception. Entities involved: CDF, CGF1, CGF2, and CDR post-processing system.](16152cf1d84aea10848758f51a91ff6a_img.jpg)
492
+
493
+ ```
494
+
495
+ sequenceDiagram
496
+ participant CDF
497
+ participant CGF1
498
+ participant CGF2
499
+ participant PPS as CDR post-processing system
500
+
501
+ CDF->>CGF1: 1. Data Record Transfer Request: Send Data Record Packet
502
+ Note right of CGF1: < 2. CDR packet contents is stored to non-volatile
503
+ CGF1 memory or sent for postprocessing >
504
+ CGF1-->>PPS:
505
+ Note over CDF, CGF1: 3. < No positive response to CDF, even to resent requests >
506
+ CDF->>CGF2: 4. Data Record Transfer Request: Send possibly duplicated Data Record Packet
507
+ Note right of CGF2: 5. < CGF2 stores the CDR packet contents to its buffer for pot. dupl. packets >
508
+ CGF2->>CDF: 6. Data Record Transfer Response: Request Accepted
509
+ Note left of CDF: 7. < CDRs are deleted from
510
+ CDF buffers >
511
+ Note over CDF, PPS: . . .
512
+ CDF->>CGF1: 8. Node Alive Request
513
+ CGF1->>CDF: 9. Node Alive Response
514
+ CDF->>CGF1: 10. Data Record Transfer Request: Send possibly
515
+ duplicated Data Record Packet (empty)
516
+ CGF1->>CDF: 11. Data Record Transfer Response: Request related
517
+ to possibly duplicated packets already fulfilled
518
+ CDF->>CGF2: 12. Data Record Transfer Request: Cancel Data Record Packet
519
+ Note right of CGF2: 13. < The cancelled packet(s) are deleted in CGF2 >
520
+ CGF2->>CDF: 14. Data Record Transfer Response: Request Accepted
521
+
522
+ ```
523
+
524
+ Sequence diagram illustrating duplicate prevention when a connection breaks after successful CDR reception. Entities involved: CDF, CGF1, CGF2, and CDR post-processing system.
525
+
526
+ **Figure 5.5: Duplicate prevention case: CDR sending via CGF1 had succeeded**
527
+
528
+ - 1) The CDR generating entity (CDF) sends CDR(s) in a packet to CGF (that is the current primary Charging Gateway Functionality for the specific CDF, "CGF1"). The sending is performed by using the *Data Record Transfer Request* message, with the *Packet Transfer Command* IE having the value "Send Data Record Packet".
529
+ - 2) The CGF1 is able to store the packet sent by the CDF in a safe way (to e.g. a redundant RAM memory unit or a mirrored non-volatile memory or to another network element, e.g. post-processing system).
530
+ - 3) Since the CDF-CGF1 communication connection is now broken, the CDF is not able to get the response "Request Accepted" as the **Cause** value in the *Data Record Transfer Response* message.
531
+ - 4) Then the CDF sends the same CDR packet that could not be sent to CGF1 to the next CGF in its CGF preference list (here CGF2) a *Data Record Transfer Request* message, with the *Packet Transfer Command* IE having the
532
+
533
+ value "Send possible duplicated Data Record Packet". (That sending may be preceded by the testing of the CDF-CGF2 link by an *Echo Request* message, that the CGF2 would respond by the *Echo Response*.)
534
+
535
+ - 5) As the connection to CGF2 is working, CGF2 is able to process the CDR packet. Since the packet was marked by the sending CDF to be potentially duplicated, it is stored in CGF2, but not yet sent forward towards the post processing or BD.
536
+ - 6) The CGF2 sends confirmation of the successful packet reception to the CDF. The confirmation is performed by using the *Data Record Transfer Response* message, with the **Cause** value being "Request Accepted".
537
+ - 7) The CDF can now delete the now successfully sent (potentially duplicated) CDRs from its CDR buffer (but it keeps the sequence number(s) of the sent potentially duplicated packet(s) in a buffer dedicated for that.
538
+ - 8) When CGF1 is recovering after a system reboot, it sends a *Node Alive Request* message to the configured peer CDF(s), and so the CDF notices that it can again successfully communicate with the CGF1. (The CDF may also detect this by using the *Echo Request* messages, which would be answered by CGF1 by the *Echo Response* message.)
539
+ - 9) CDF acknowledges the CGF1 by *Node Alive Response* message.
540
+ - 10) For the earlier unacknowledged *Data Record Transfer Request* message(s), the CDF sends CGF1 empty test packet(s) (with no CDR payload in the *Data Record Packet* IE but just the other parts of the message frame).
541
+ - 11) CGF1 responds with *Data Record Transfer Response* message, with the **Cause** value being "Request related to possibly duplicated packets already fulfilled", because in this example case CGF1 had lost the communication capability towards CDF after storing the previously received (and by CGF1 unacknowledged) CDR packet.
542
+ - 12) Now CDF knows that the CGF1 had originally been able to process and forward the original version of the CDR packet from the CDF, and it indicates CGF2 that CGF2 can cancel the CDR packet(s) related to the previously unacknowledged GTP' CDF-CGF1 Sequence Number(s). Those packets' *Sequence Numbers* are indicated in the *Sequence Numbers of the Cancelled Packets* IE.
543
+ - 13) CGF2 shall now delete the cancelled packet(s) from its buffer for potentially duplicated packets.
544
+ - 14) CGF2 responds with *Data Record Transfer Response* message, with the **Cause** value being "Request Accepted".
545
+
546
+ After all the potentially duplicated packets are cleared from CGF(s), the CDF can continue in normal way the transfer of CDRs.
547
+
548
+ #### 5.2.2.4 CGF redundancy mechanism
549
+
550
+ A summary of the CGF redundancy mechanism, which prevents duplicated CDR packets to enter the BS, is described below.
551
+
552
+ This, or other mechanisms, are deployed to enhance the reliability of CDR transport.
553
+
554
+ The general logic of the duplicate CDR packet prevention in CGF redundancy cases is shown in Figure 5.6, where the messages are numbered sequentially, alternative messages are indicated by an index character ("a" or "b") that follows the arrow sequence number. The main mechanism of the messaging in CGF redundancy cases (when a CDF-CGF link is down or a CGF is not working) is based on CDF (1) first trying to send a CDR packet to CGF1. In case no acknowledgement or a successful response is received (2) from CGF1 due to any reason, e.g. such as the request not reaching CGF1 despite repeated attempts (or the responses from CGF1 to the CDF are lost after the CGF1 has either stored it securely, or, forwarded it towards post-processing (2b)), the unacknowledged CDR packets are redirected to CGF2. The invocation for a re-transmission may be triggered by a time-out mechanism.
555
+
556
+ The CDF may first test the CDF-CGF2 link by sending an 'Echo Request' message to CGF2, in response to which CGF2 would respond with the 'Echo Response' message. The CDR packets not successfully received by the primary CGF (=CGF1) are sent to CGF2 (3), and are marked as potential duplicates, and CGF2 responds to the request(s) (4). Such CDRs, i.e. CDRs that are marked as potential duplicates would wait there for further commands from CDF.
557
+
558
+ When the CDF detects (5) & (6) that the primary CGF, in this case CGF1 is again able to communicate with it on receiving *Node Alive Request* (or getting a *Echo Response* from CGF2 to a *Echo Request* sent by the CDF) it answers by *Node Alive Response*. Then the CDF tests CGF1 with an empty packet (7), retrying continuously if no response is received, using e.g. increasing timeouts (using the old unacknowledged packet's Sequence Number, if the CGF1 would consider the packet to be a new one (8a) or an already received one (8b)). According to the response received from
559
+
560
+ CGF1, the CDF gives the CGF2 a command to either release (9a) or cancel (9b) the corresponding CDR packet from CGF2. CGF2 then confirms the decision (10), and is able to send the CDRs towards the BS (11a).
561
+
562
+ **Error handling:** By default, retransmissions after configurable timeouts are used. If after the CGF1 communication failure, the CDR packet sending from CDF to CGF2 does not succeed, the CDF tries to use CGF3 as the intermediate CDR packet storage entity, etc. If no acknowledgement (10) is received by the CDF for its message(s) (9a) or (9b), the CDF will retransmit the message (9a) or (9b) continuously and persistently, using e.g. increasing time intervals. An alarm should be sent to the O&M system if a communication link goes down. It shall be possible to release/cancel CDR packets from CGFs and unacknowledged sequence numbers from CDFs by O&M operations if permanent CDF-CGF link failures would occur. The buffers containing the Sequence Numbers of potentially duplicated packets, and the buffers containing the numbers of unacknowledged CDR packets shall be kept up to date (with CDR packet transfers) using transaction mechanisms. In the case of the CDF-CGF1 communication link being down, any new CDRs generated by the CDF are sent to a properly working CGF2, instead of the CGF1.
563
+
564
+ ![Sequence diagram of the General CGF redundancy messaging scheme showing interactions between CDF, CGF1, CGF2, and a post-processing System.](9cd90f495b95ad2116ff780248c26d95_img.jpg)
565
+
566
+ ```
567
+
568
+ sequenceDiagram
569
+ participant CDF
570
+ participant CGF1
571
+ participant CGF2
572
+ participant PS as post-processing System
573
+
574
+ Note left of CGF1: 8.b) Req. rel. to poss. dupl. packet already fulfilled
575
+ CDF->>CGF1: 1. Send Data Record Packet
576
+ CGF1-->>CDF: 2. ( No response to CDF)
577
+ CDF->>CGF2: 3. Send Data Record Packet: pot.dupl.
578
+ CGF2-->>CDF: 4. Request Accepted
579
+ CDF->>CGF2: 9.a) Release Data Record Packet
580
+ CDF->>CGF2: 9.b) Cancel Data Record Packet
581
+ CGF2-->>CDF: 10. Request Accepted
582
+ CDF->>CGF1: 5. Node Alive Request
583
+ CGF1-->>CDF: 6. Node Alive Response
584
+ CDF->>CGF1: 7. Send Data Record Packet: pot.dupl., empty
585
+ CGF1-->>CDF: 8.a) Request Accepted
586
+ CGF1->>PS: 2.b) CDRs
587
+ PS->>CGF2: 11.a) CDRs
588
+
589
+ ```
590
+
591
+ The diagram illustrates the General CGF redundancy messaging scheme. It features four main entities: CDF (Customer Data Function), CGF1 (CGF 1), CGF2 (CGF 2), and a post-processing System. Each CGF and the post-processing System have a local buffer for CDRs (Customer Data Records). The sequence of messages is as follows:
592
+
593
+
594
+ - The CDF sends a "1. Send Data Record Packet" to CGF1.
595
+ - CGF1 responds with "2. ( No response to CDF)" to the CDF.
596
+ - The CDF then sends a "3. Send Data Record Packet: pot.dupl." to CGF2.
597
+ - CGF2 responds with "4. Request Accepted" to the CDF.
598
+ - The CDF sends "9.a) Release Data Record Packet" and "9.b) Cancel Data Record Packet" to CGF2.
599
+ - CGF2 responds with "10. Request Accepted" to the CDF.
600
+ - The CDF sends "5. Node Alive Request" to CGF1.
601
+ - CGF1 responds with "6. Node Alive Response" to the CDF.
602
+ - The CDF sends "7. Send Data Record Packet: pot.dupl., empty" to CGF1.
603
+ - CGF1 responds with "8.a) Request Accepted" to the CDF.
604
+ - CGF1 sends "2.b) CDRs" to the post-processing System.
605
+ - The post-processing System sends "11.a) CDRs" to CGF2.
606
+
607
+ A note at the top left indicates "8.b) Req. rel. to poss. dupl. packet already fulfilled", referring to the interaction between the CDF and CGF1.
608
+
609
+ Sequence diagram of the General CGF redundancy messaging scheme showing interactions between CDF, CGF1, CGF2, and a post-processing System.
610
+
611
+ **Figure 5.6: General CGF redundancy messaging scheme**
612
+
613
+ ##### **A more detailed description of the CGF redundancy mechanism:**
614
+
615
+ Due to a network failure/network congestion or a temporary node failure, a CGF might not be able to send a response within the configured timeout period to a request it got from a CDF. As a first attempt, retries of requests are to be used as defined in TS 29.060 [200], if the response is not received in the configured time.
616
+
617
+ If a CDF loses its connection to the CGF unexpectedly, it may send the CDRs to the next CGF in the priority list. If the CGF changes, the CDF can continue sending CDRs to different CGF nodes, depending on which CGF has been configured as the receiver of CDRs for a particular service.
618
+
619
+ **Sequence number buffers:** The CDF might lose its connection to its primary CGF due to a link failure or CGF going down. In this kind of redundancy condition the CDF attempts to redirect the CDR traffic to a secondary CGF (after possible retries have failed). The CDF maintains an internal buffer for Sequence Numbers of requests not yet successfully responded to by the primary CGF, for the case that it may become capable of communicating to the primary CGF at a later date. The CDF will send the not responded Data Record Packets (DRPs) to the secondary CGF, and the CDF maintains also a buffer for the Sequence Numbers related to those DRPs that have been temporarily stored to this secondary CGF. (If the communication towards the secondary CGF would not work, the transfer of possibly duplicated DRPs and Sequence Number bookkeeping would be done for a tertiary CGF etc.) Also the CGFs maintain Sequence Number buffers for each of their CDF links. The Sequence Numbers may in future be needed in relation to the possibly duplicated CDRs that the CGFs have got from the CDF(s). The Sequence Numbers are stored to wait for a final decision to release them towards the BS (if the primary CGF had not received successfully the packets originally sent by a CDF) or to cancel them (if the primary CGF had received and processed successfully the originally by CDF sent packets).
620
+
621
+ The CDF is able to instruct CGF2 to cancel (or instruct CGF2 to transfer towards the BS), the CDR packets sent to a secondary CGF if the primary CGF becomes available for service. To make the right decision the CDF first sends an empty test packet with the 'Send possibly duplicated Data Record Packet' Packet Transfer Command to the primary CGF, using a previously not responded Sequence Number.
622
+
623
+ In case that the empty test packet to the primary CGF (which was temporarily down (or to which the link was down)) is responded with the **Cause** value "Request Accepted", the CDF will release the corresponding CDRs waiting for final decision in the secondary CGF, towards the BD with the Packet Transfer Command "Release Data Record Packet".
624
+
625
+ If the primary CGF responses this test message with the **Cause** value "Request related to possibly duplicated packets already fulfilled", the CDF will cancel the corresponding CDRs waiting for final decision in the secondary CGF, using the Packet Transfer Command "Cancel Data Record Packet".
626
+
627
+ To enable that a CDF failure (destroying its Sequence Number buffers per each CGF link for non-responded requests or possibly duplicated packets) would not cause CDR packets to stay forever in the temporary decision waiting buffers of CGFs, there should also be O&M means of emptying those CGF buffers.
628
+
629
+ There shall also be a configurable parameter in the CGF for making the final decision, as to whether or not it is able to send the CDRs to the BS for the case where the backup buffering mechanism in the CDF could not be used until the end of the messaging sequence related to a certain CDR packet has been completed. This way the operator can:
630
+
631
+ - A) Select that the CDFs and CGFs take care of duplicate prevention and the BS is not required to do duplicate checking due to possible duplicates caused by Network Element or CGF redundancy mechanisms.
632
+ - B) Select that the BS performs the duplicate prevention. To do this in the most effective way, the CGF may include an additional flag linked to possibly duplicated CDRs sent to the BS, indicating that they have not been released by a CDF for BS use (or use special kind of file name if a file protocol is used between CGF and BS). This means that the BS has somewhat more processing work to do, but the BS would anyway get a duplicate free end result. CGF is in this case always authorised to forward CDRs towards the BS, also when they contain possibly duplicated data. For this case the CGFs may also have a configurable flag that *Data Record Packet Cancel/Release* operations are not needed.
633
+
634
+ # --- 6 Data description for the transfer
635
+
636
+ ## 6.1 The GTP' charging protocol
637
+
638
+ This clause describes the features of GTP'. The message types described in subclause 6.2.2 ("Reused GTP message types") are also described in the related clauses of TS 29.060 [200].
639
+
640
+ ### 6.1.1 Usage of GTP Header in charging
641
+
642
+ In GTP' messaging only the signalling plane of GTP is partly reused. The GTP' header is shown in Figure 6.1.
643
+
644
+ Bit 5 of octet 1 of the GTP header is the Protocol Type (PT) flag: it is '0' if the message is GTP'.
645
+
646
+ The *Version* bits indicate the GTP' protocol version when the Protocol Type flag is '0'.
647
+
648
+ Bit 1 of octet 1 is not used in GTP' (except in v0), and it is marked '0' in the GTP' header. It is in use in GTP' v0 and distinguishes the used header-length. In the case of GTP' v0, this bit being marked one (1) indicates the usage of the 6 octets header. If the bit is set to '0' (usually the case) the 20-octet header is used. For all other versions of GTP', this bit is not used and is set to '0'. However, this does not suggest the use of the 20-octet header, rather a shorter 6-octet header.
649
+
650
+ The *Length* indicates the length of payload (number of octets after the GTP' header). The *Sequence Number* of the packet is part of the GTP' header.
651
+
652
+ ![](e636d7ccca0ad14c6b95201404324823_img.jpg)
653
+
654
+ | Octets | Bits | | | | | | | |
655
+ |--------|-----------------|---|----|-----------------|---|---|---------|---|
656
+ | | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 |
657
+ | 1 | Version | | PT | Spare ' 1 1 1 ' | | | ' 0/1 ' | |
658
+ | 2 | Message Type | | | | | | | |
659
+ | 3 - 4 | Length | | | | | | | |
660
+ | 5 - 6 | Sequence Number | | | | | | | |
661
+
662
+ Figure 6.1: GTP' header
663
+
664
+ ### 6.1.2 Information Elements (IEs)
665
+
666
+ The messages may contain several Information Elements (IEs). The TLV (Type, Length, Value) or TV (Type, Value) encoding formats shall be used for the GTP' IEs. The GTP' messages shall have the IEs sorted with the *Type* fields in ascending order. The *Length* field shall contain the IE length excluding the Type and Length fields.
667
+
668
+ Within the *Type* field the most significant bit will be set to 0 when the TV format is used and set to 1 when the TLV format is used. This is illustrated in Figures 6.2 and b, respectively.
669
+
670
+ ![](cd141897aa368dbbaa398ace230cdd85_img.jpg)
671
+
672
+ | | | Bits | | | | | | | |
673
+ |-------------------|---|------|-----------------|---|---|---|---|---|---|
674
+ | <del>Octets</del> | | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 |
675
+ | (a) | 1 | 0 | Type->TV format | | | | | | |
676
+
677
+
678
+
679
+ | | | Bits | | | | | | | |
680
+ |-------------------|---|------|------------------|---|---|---|---|---|---|
681
+ | <del>Octets</del> | | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 |
682
+ | (b) | 1 | 1 | Type->TLV format | | | | | | |
683
+
684
+ Figure 6.2: Type field for (a) TV and (b) TLV format
685
+
686
+ ## 6.2 GTP' Message Types
687
+
688
+ ### 6.2.1 List of all GTP' message types
689
+
690
+ GTP' defines a set of messages between two associated nodes. The GTP' messages defined are shown in Table 6.1. The messages introduced by GTP' are in **boldface** letters. The other messages are inherited from the GTP protocol.
691
+
692
+ The GTP' introduced signalling message types
693
+
694
+ - Node Alive Request,
695
+ - Node Alive Response,
696
+ - Redirection Request and
697
+ - Redirection Response
698
+
699
+ belong to the "Path Management messages", while
700
+
701
+ - Data Record Transfer Request and
702
+ - Data Record Transfer Response
703
+
704
+ are from the message type group "Record Transmission messages".
705
+
706
+ The reserved fields in the signalling messages shall be filled with ones, and are intended for future use.
707
+
708
+ GTP' reuses the GTP **Cause** values. The message type numbers required for the newly introduced GTP' messages have been derived from the unallocated message type number space specified in the GTP message table defined in TS 29.060 [200].
709
+
710
+ The number ranges allocated for GTP' are as follows:
711
+
712
+ For Information Elements: 117-127 (TV type fields) and 239-254 (for TLV type fields).
713
+
714
+ TLV Information Element types introduced in the present document:
715
+
716
+ | | |
717
+ |-----|---------------------------------------------------------------------------|
718
+ | 254 | <i>Address of Recommended Node</i> |
719
+ | 253 | <i>Requests Responded</i> |
720
+ | 252 | <i>Data Record Packet</i> |
721
+ | 251 | <i>Charging Gateway Address</i> (this IE is also used in TS 29.060 [200]) |
722
+ | 250 | <i>Sequence Numbers of Cancelled Packets</i> |
723
+ | 249 | <i>Sequence Numbers of Released Packets</i> |
724
+
725
+ TV Information Element types introduced in the present document:
726
+
727
+ | | |
728
+ |-----|--------------------------------|
729
+ | 127 | <i>Charging ID</i> |
730
+ | 126 | <i>Packet Transfer Command</i> |
731
+
732
+ For **Cause** Codes: **Cause** values used in requests: 49 to 63, **Cause** values used in responses indicating acceptance: 177 to 191, **Cause** values used in responses indicating rejection: 241 to 255.
733
+
734
+ Charging related **Cause** values introduced for the present document:
735
+
736
+ In requests:
737
+
738
+ | | |
739
+ |----|-----------------------------------------------|
740
+ | 63 | <i>This node is about to go down</i> |
741
+ | 62 | <i>Another node is about to go down</i> |
742
+ | 61 | <i>The receive buffers are becoming full</i> |
743
+ | 60 | <i>The transmit buffers are becoming full</i> |
744
+ | 59 | <i>System failure</i> |
745
+
746
+ In responses indicating acceptance:
747
+
748
+ | | |
749
+ |-----|---------------------------|
750
+ | 177 | <i>CDR decoding error</i> |
751
+ |-----|---------------------------|
752
+
753
+ In responses indicating rejection:
754
+
755
+ | | |
756
+ |-----|-------------------------------------------------------------------------|
757
+ | 255 | <i>Request not fulfilled</i> |
758
+ | 254 | <i>Sequence numbers of released/cancelled packets IE incorrect</i> |
759
+ | 253 | <i>Request already fulfilled</i> |
760
+ | 252 | <i>Request related to possibly duplicated packets already fulfilled</i> |
761
+
762
+ The charging related message types are listed in Table 6.1. Brief descriptions of the GTP messages reused in GTP' are provided in subclause 6.2.2 ("Reused GTP message types") below. Further details are provided in TS 29.060 [200], the GTP specification.
763
+
764
+ | Message Type value (Decimal) | GTP' message |
765
+ |------------------------------|-------------------------------|
766
+ | 1 | Echo Request |
767
+ | 2 | Echo Response |
768
+ | 3 | Version Not Supported |
769
+ | 4 | Node Alive Request |
770
+ | 5 | Node Alive Response |
771
+ | 6 | Redirection Request |
772
+ | 7 | Redirection Response |
773
+ | | |
774
+ | 240 | Data Record Transfer Request |
775
+ | 241 | Data Record Transfer Response |
776
+ | others | reserved for future use |
777
+
778
+ Table 6.1: GTP' messages
779
+
780
+ ### 6.2.2 Reused GTP message types
781
+
782
+ The existing *Echo Request* and *Echo Response* messages defined in TS 29.060 [200] are also used in PS domain charging. They may be used by the CDF or by the CGF for checking if another CDF or CGF is alive. If the present document and TS 29.060 [200] differ in their description, then the TS 29.060 [200] is to be taken as the latest specification status of the related Information Elements. If the path protocol is TCP, *Echo Request* and *Echo Response* messages are not required.
783
+
784
+ The *Version Not Supported* message in the GTP' is similar to the corresponding GTP message. It indicates the latest GTP' version that the GTP' entity can support. If a receiving node receives a GTP' message of an unsupported version, then this node shall return a GTP' *Version Not Supported* message, indicating in the Version field of the GTP' header the latest GTP' version, this node supports. The received payload data of the GTP' packet shall then be discarded.
785
+
786
+ The *Version* bits in the GTP' header have currently the following possible values:
787
+
788
+ - GTP' version 0 (binary '000') identifies the following Message Type values:
789
+ - 3 = Version Not Supported,
790
+ - 4 = Node Alive Request,
791
+ - 5 = Node Alive Response,
792
+ - 6 = Redirection Request,
793
+ - 7 = Redirection Response.
794
+
795
+ In clause 7.3.4.6 the Requests Responded information element has Length field in place of the Number of Requests Responded field, to make that TLV IE to be handled like normal TLV IEs.
796
+
797
+ If GTP' v0 is used in parallel with GTP' v2 or a later version, then, a 6-octet header length (with no trailing dummy octets) is used also with v0 (like in GTP' v2).
798
+
799
+ The mark of the usage of GTP' v0 with 6 octet header (instead of the original 20 octet long header) is then the version bits being 0 and the bit 1 of octet 1 being '1' (instead of '0').
800
+
801
+ - GTP' version 1 (binary '001') is the same as version 0 but has, in addendum, the duplicate CDR prevention mechanism, introduced in GSM 12.15 version 7.2.1 (1999-07) of the GPRS charging specification.
802
+ - GTP' version 2 (binary '010') is the same as version 1, but the header is just 6 octets long (no unused trailing octets). IPv6 address type is also supported (for Address of Recommended Node information element of the Redirection Request).
803
+
804
+ ### 6.2.3 GTP message type modifications, implied by GTP'
805
+
806
+ The general principle is that the CDRs are always sent to a CGF residing in the same network as the CDF. In the case of roaming it is conceivable that some CDRs relating to the same service (e.g. in PS domain for the same IP-CAN bearer) will be sent to different networks' CGFs. The cost balancing of the roaming traffic is to be agreed between the UMTS Operators.
807
+
808
+ ### 6.2.4 GTP' message types
809
+
810
+ #### 6.2.4.1 Node Alive Request
811
+
812
+ The *Node Alive Request* message may be used to inform that a node in the network has started its service (e.g. after a service break due to software or hardware maintenance or data service interruption after an error condition). A node may send a different Node Address than its own in the Information Element, e.g. informing the "next node in the chain" that the "previous node in the chain" (which is located on the other side of the sender of this message) is now ready for service. This message type is optional if the Path Protocol is TCP.
813
+
814
+ The *Node Alive Request* message allows a quicker reconnect capability than the *Echo Request* message based polling can provide, and its usage will have a reduced load effect on the network, particularly when the number of network nodes using GTP' is high. It may also be used to inform when a new network node has become available for service. If the *Echo Request* message is also used, then the usage of the *Node Alive Request* message allows the interval of *Echo Requests* to be longer, thus reducing network load by reducing number of *Echo Requests*.
815
+
816
+ The Information elements in a Node Alive Request message are shown in Table 6.2.
817
+
818
+ | Information Element | Presence requirement |
819
+ |--------------------------|----------------------|
820
+ | Node Address | Mandatory |
821
+ | Alternative Node Address | Optional |
822
+ | Private Extension | Optional |
823
+
824
+ **Table 6.2: Information Elements in a Node Alive Request**
825
+
826
+ The Node Address format is the same as for the Charging Gateway Address format described in TS 29.060 [200]).
827
+
828
+ The format definition for the Node Address information element is the same as the format of the source and destination address of the IP packet that transports the GTP' messages. The optional Alternative Node Address IE can be used in the *Node Alive Request* if the message sender wants to advertise an IP address that is different from the node address format. This way both the IPv4 and IPv6 node address formats can be supported simultaneously in the messaging, regardless of whether IPv4 or IPv6 is used in the underlying transport.
829
+
830
+ The optional Private Extension IE contains vendor- or operator-specific information.
831
+
832
+ #### 6.2.4.2 Node Alive Response
833
+
834
+ The *Node Alive Response* message, shown in Table 6.3, shall be sent as a response to a received *Node Alive Request*.
835
+
836
+ | Information Element | Presence requirement |
837
+ |---------------------|----------------------|
838
+ | Private Extension | Optional |
839
+
840
+ **Table 6.3: Information Elements in a Node Alive Response**
841
+
842
+ The optional Private Extension IE contains vendor- or operator-specific information.
843
+
844
+ #### 6.2.4.3 Redirection Request
845
+
846
+ There are two use cases for the *Redirection Request* message:
847
+
848
+ - One is to advise that received CDR traffic is to be redirected to another CGF due to the sending CGF node is about to stop service (due to an outage for maintenance or an error condition).
849
+ - The second purpose is to inform a CDF which is currently sending data to this node (e.g. CGF), that the next node in the chain (e.g. a mediator device or Billing Computer) has lost connection to this node (e.g. CGF).
850
+
851
+ The Information Elements in a *Redirection Request* Message are listed in Table 6.4.
852
+
853
+ An *Address of Recommended Node* may be given if, for example, a CGF maintenance outage is handled by first introducing another CGF ready to take incoming CDRs. This way, the network performance can be maintained. The *Address of Recommended Node* shall only describe an intra-PLMN node containing a CGF, and not a node in any other PLMN.
854
+
855
+ | Information Element | Presence requirement |
856
+ |-----------------------------------------|----------------------|
857
+ | Cause | Mandatory |
858
+ | Address of Recommended Node | Optional |
859
+ | Alternative Address of Recommended Node | Optional |
860
+ | Private Extension | Optional |
861
+
862
+ **Table 6.4: Information Elements in a Redirection Request**
863
+
864
+ Possible **Cause** values are:
865
+
866
+ - "This node is about to go down";
867
+ - "Another node is about to go down";
868
+ - "System failure";
869
+ - "Receive buffers becoming full";
870
+ - "Send buffers becoming full".
871
+
872
+ The *Address of Recommended Node* information element, shown in Figure 6.3, defines the IPv4 or IPv6 format address that the node is identified by in the UMTS network.
873
+
874
+ ![Figure 6.3: Address of Recommended Node information elements. The diagram shows two tables representing the structure of the information element for IPv4 and IPv6. The IPv4 table has 3 rows: Octet 1 contains Type = 254 (Decimal); Octets 2-3 contain Length = 4 (Decimal); Octets 4-7 contain IPv4 Address. The IPv6 table has 3 rows: Octet 1 contains Type = 254 (Decimal); Octets 2-3 contain Length = 16 (Decimal); Octets 4-19 contain IPv6 Address. Both tables include a header row for Bits 8 through 1.](19a5f0db57a21a0e82a7f326083e96fd_img.jpg)
875
+
876
+ **IPv4 Address of Recommended Node**
877
+
878
+ | Octets | Bits | | | | | | | |
879
+ |--------|----------------------|---|---|---|---|---|---|---|
880
+ | | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 |
881
+ | 1 | Type = 254 (Decimal) | | | | | | | |
882
+ | 2-3 | Length = 4 (Decimal) | | | | | | | |
883
+ | 4-7 | IPv4 Address | | | | | | | |
884
+
885
+ **IPv6 Address of Recommended Node**
886
+
887
+ | Octets | Bits | | | | | | | |
888
+ |--------|-----------------------|---|---|---|---|---|---|---|
889
+ | | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 |
890
+ | 1 | Type = 254 (Decimal) | | | | | | | |
891
+ | 2-3 | Length = 16 (Decimal) | | | | | | | |
892
+ | 4-19 | IPv6 Address | | | | | | | |
893
+
894
+ Figure 6.3: Address of Recommended Node information elements. The diagram shows two tables representing the structure of the information element for IPv4 and IPv6. The IPv4 table has 3 rows: Octet 1 contains Type = 254 (Decimal); Octets 2-3 contain Length = 4 (Decimal); Octets 4-7 contain IPv4 Address. The IPv6 table has 3 rows: Octet 1 contains Type = 254 (Decimal); Octets 2-3 contain Length = 16 (Decimal); Octets 4-19 contain IPv6 Address. Both tables include a header row for Bits 8 through 1.
895
+
896
+ **Figure 6.3: Address of Recommended Node information elements**
897
+
898
+ The format definition for the *Address of Recommended Node* information element is the same as the format of the source and destination address of the IP packet that transports the GTP' messages. The optional *Alternative Address of Recommended Node* IE can be used in the *Node Alive Request* if the message sender wants to advertise an IP address that is different from the node address format. This way both the IPv4 and IPv6 node address formats can be supported simultaneously in the messaging, regardless of whether IPv4 or IPv6 is used in the underlying transport.
899
+
900
+ The optional Private Extension contains vendor- or operator- specific information.
901
+
902
+ #### 6.2.4.4 Redirection Response
903
+
904
+ A *Redirection Response* message shall be sent as a response of a received *Redirection Request*. The information elements of this message are listed in Table 6.5.
905
+
906
+ | Information Element | Presence requirement |
907
+ |---------------------|----------------------|
908
+ | Cause | Mandatory |
909
+ | Private Extension | Optional |
910
+
911
+ **Table 6.5: Information Elements in a Redirection Response**
912
+
913
+ Possible **Cause** values are:
914
+
915
+ - "Request Accepted";
916
+
917
+ - "No resources available";
918
+ - "Service not supported";
919
+ - "System failure";
920
+ - "Mandatory IE incorrect";
921
+ - "Mandatory IE missing";
922
+ - "Optional IE incorrect";
923
+ - "Invalid message format";
924
+ - "Version not supported".
925
+
926
+ The optional Private Extension contains vendor- or operator-specific information.
927
+
928
+ #### 6.2.4.5 Data Record Transfer Request
929
+
930
+ This message is used to transmit the CDR(s) to the CGF.
931
+
932
+ The CDRs are placed in the *Data Record Packet* information element.
933
+
934
+ ##### 6.2.4.5.1 Information Elements in Data Record Transfer Request
935
+
936
+ The Information Elements in *Data Record Transfer Request* message is specified in Table 6.6.
937
+
938
+ | Information Element | Presence requirement |
939
+ |---------------------------------------|----------------------|
940
+ | Packet Transfer Command | Mandatory |
941
+ | Data Record Packet | Conditional |
942
+ | Sequence Numbers of Released Packets | Conditional |
943
+ | Sequence Numbers of Cancelled Packets | Conditional |
944
+ | Private Extension | Optional |
945
+
946
+ **Table 6.6: Information Elements in a Data Record Transfer Request**
947
+
948
+ ##### 6.2.4.5.2 Packet Transfer Command IE
949
+
950
+ The value of the Packet Transfer Command in its Information Element tells the nature of the message:
951
+
952
+ - 1 = 'Send Data Record Packet';
953
+ - 2 = 'Send possibly duplicated Data Record Packet';
954
+ - 3 = 'Cancel Data Record Packet';
955
+ - 4 = 'Release Data Record Packet'.
956
+
957
+ The following describes the usage of each Packet Transfer Command. The first command is for normal CDR transfer while the other values are only used as part of the redundancy mechanism.
958
+
959
+ - 1) **Send Data Record Packet.** This is the usual command used for sending CDRs under normal conditions when no error recovery is needed or the redirection mechanism is not involved. It is shown in Figure 6.5. The other three commands are being used only in error recovery cases. Out of the three conditional IEs shown in Table 6.6, only the "Data Record Packet" is present in this message.
960
+ - 2) **Send possibly duplicated Data Record Packet.** When the CDR packet is redirected to a secondary CGF (by a CDF) because the currently used CGF is not working or the CDR transfer is not working properly, or if there is an error in the link between the CDF and the CGF, then this Packet Transfer Command is used instead of the normal 'Send Data Record Packet'. Of the conditional IEs, the "Data Record Packet" is present in the message, when sending the message to a CGF acting as temporary storage, when the original primary CGF could not be contacted. This Packet Transfer Command is used also when sending "empty" test packets with older (but not yet acknowledged) sequence numbers after a peer node or link recovery, to check if the CGF had received some Data Record Packets (whose acknowledgement did not come to the *Data Record Packet* sending node) before the link to the recipient node became inoperable.
961
+ - 3) **Cancel Data Record Packet.** Of the conditional IEs, the "Sequence Numbers of Cancelled Packets" is present in the message.
962
+ - 4) **Release Data Record Packet.** Of the conditional IEs, the "Sequence Numbers of Released Packets" is present in the message.
963
+
964
+ | Octets | Bits | | | | | | | |
965
+ |--------|-------------------------|---|---|---|---|---|---|---|
966
+ | | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 |
967
+ | 1 | Type = 126 (Decimal) | | | | | | | |
968
+ | 2 | Packet Transfer Command | | | | | | | |
969
+
970
+ **Figure 6.5: Packet Transfer Command information element**
971
+
972
+ After the CGF has received the *Packet Transfer Command* 'Release Data Record Packet' with the Sequence Number(s) for earlier sent 'Send possibly duplicated Data Record Packet' command(s), it can consider itself authorised to send the *Data Record Packets* previously marked as possibly duplicated towards the BD as normal (not duplicated) CDRs.
973
+
974
+ ##### 6.2.4.5.3 Data Record Packet IE
975
+
976
+ The *Data Record Packet* element, which is present conditionally if the Packet Transfer Command is 'Send Data Record Packet' or 'Send possibly duplicated Data Record Packet', may contain one or more CDRs. This IE is illustrated in Figure 6.6. If an "empty packet" is to be sent, then the *Data Record Packet* IE contains only the *Type* (with value 252 in decimal) and the *Length* (with value 0) fields.
977
+
978
+ As shown in Figure 6.6, there are two fields identifying the CDR format:
979
+
980
+ *Data Record Format* and *Data Record Format Version*.
981
+
982
+ The format of the CDRs is ASN.1 or some other format, as identified by the value of *Data Record Format*.
983
+
984
+ The *Data Record Format Version* identifies the TS release and version numbers that were used for the CDR encoding.
985
+
986
+ The formats of these two fields are described in detail in sections 6.3 and 6.4.
987
+
988
+ | Octets | Bits | | | | | | | |
989
+ |---------|----------------------------|---|---|---|---|---|---|---|
990
+ | | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 |
991
+ | 1 | Type = 252 (Decimal) | | | | | | | |
992
+ | 2...3 | Length | | | | | | | |
993
+ | 4 | Number of Data Records | | | | | | | |
994
+ | 5 | Data Record Format | | | | | | | |
995
+ | 6...7 | Data Record Format Version | | | | | | | |
996
+ | 8...9 | Length of Data Record 1 | | | | | | | |
997
+ | 10...n | Data Record 1 | | | | | | | |
998
+ | | ⋮ | | | | | | | |
999
+ | x...x+1 | Length of Data Record N | | | | | | | |
1000
+ | x+2...y | Data Record N | | | | | | | |
1001
+
1002
+ **Figure 6.6: Data Record Packet information element**
1003
+
1004
+ ##### 6.2.4.5.4 Sequence Numbers of Released Packets IE
1005
+
1006
+ The *Sequence Numbers of Released Packets* is present if the *Packet Transfer Command* is 'Release Data Record Packet'. The format of the Information Element is described in Figure 6.7 below:
1007
+
1008
+ ![](2ae3eae1bd80a90f192f568ae246a9a6_img.jpg)
1009
+
1010
+ | Octets | Bits | | | | | | | |
1011
+ |---------|-------------------|---|---|---|---|---|---|---|
1012
+ | | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 |
1013
+ | 1 | Type = 249 | | | | | | | |
1014
+ | 2...3 | Length | | | | | | | |
1015
+ | 4...5 | Sequence Number 1 | | | | | | | |
1016
+ | ... | ... | | | | | | | |
1017
+ | n...n+1 | Sequence Number N | | | | | | | |
1018
+
1019
+ **Figure 6.7: Sequence Numbers of Released Packets information element**
1020
+
1021
+ ##### 6.2.4.5.5 Sequence Numbers of Cancelled Packets IE
1022
+
1023
+ The *Sequence Numbers of Cancelled Packets* information element is shown in Figure 6.8 and contains the IE *Type*, *Length* and the *Sequence Number(s)* (each 2 octets) of the cancelled *Data Record Transfer Request(s)*. It is present if the *Packet Transfer Command* is "Cancel Data Record Packet".
1024
+
1025
+ ![](e29665b8abcea967ef289c6aff07ae4c_img.jpg)
1026
+
1027
+ | Octets | Bits | | | | | | | |
1028
+ |---------|-------------------|---|---|---|---|---|---|---|
1029
+ | | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 |
1030
+ | 1 | Type = 250 | | | | | | | |
1031
+ | 2...3 | Length | | | | | | | |
1032
+ | 4...5 | Sequence Number 1 | | | | | | | |
1033
+ | ... | ... | | | | | | | |
1034
+ | n...n+1 | Sequence Number N | | | | | | | |
1035
+
1036
+ **Figure 6.8: Sequence Numbers of Cancelled Packets information element**
1037
+
1038
+ ##### 6.2.4.5.6 Private Extension IE
1039
+
1040
+ The optional *Private Extension* contains vendor or operator specific information.
1041
+
1042
+ #### 6.2.4.6 Data Record Transfer Response
1043
+
1044
+ The message shall be sent as a response of a received *Data Record Transfer Request*. Also, several *Data Record Transfer Requests* can be responded by a single *Data Record Transfer Response*.
1045
+
1046
+ | Information Element | Presence requirement |
1047
+ |---------------------|----------------------|
1048
+ | Cause | Mandatory |
1049
+ | Requests Responded | Mandatory |
1050
+ | Private Extension | Optional |
1051
+
1052
+ **Table 6.7: Information Elements in a Data Record Transfer Response**
1053
+
1054
+ The **Cause** (whatever the value may be) applies for all those *Data Record Transfer Requests*, responded by that particular *Data Record Transfer Response*.
1055
+
1056
+ Possible **Cause** values are:
1057
+
1058
+ - "Request Accepted";
1059
+ - "No resources available";
1060
+ - "Service not supported";
1061
+
1062
+ - "System failure";
1063
+ - "Mandatory IE incorrect";
1064
+ - "Mandatory IE missing";
1065
+ - "Optional IE incorrect";
1066
+ - "Invalid message format";
1067
+ - "Version not supported";
1068
+ - "Request not fulfilled";
1069
+ - "CDR decoding error";
1070
+ - "Request already fulfilled";
1071
+ - "Request related to possibly duplicated packet already fulfilled";
1072
+ - "Sequence numbers of released/cancelled packets IE incorrect".
1073
+
1074
+ The **cause** value "CDR decoding error" is optional, primarily intended to inform the CDF that the receiving node cannot decode the CDR. Thus, special features in the receiving node that are based on information within the CDR, would not be operable. This message could alert the operator of a remote generating node of incompatible CDR encoding. It is optional and no action or response is required.
1075
+
1076
+ The **Requests Responded** information element contains the IE *Type*, *Length* and the *Sequence Numbers* (each 2 octets) of the *Data Record Transfer Requests*. It is shown in Figure 6.9.
1077
+
1078
+ ![](705ee99c3c44fd2a1ea6a3348ce8878f_img.jpg)
1079
+
1080
+ | Octets | Bits | | | | | | | |
1081
+ |---------|-------------------|---|---|---|---|---|---|---|
1082
+ | | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 |
1083
+ | 1 | Type = 253 | | | | | | | |
1084
+ | 2..3 | Length | | | | | | | |
1085
+ | 4..5 | Sequence Number 1 | | | | | | | |
1086
+ | ... | | | | | | | | |
1087
+ | n...n+1 | Sequence Number 2 | | | | | | | |
1088
+
1089
+ **Figure 6.9: Requests Responded information element**
1090
+
1091
+ The optional *Private Extension* contains vendor or operator specific information.
1092
+
1093
+ Depending on the **Cause** value severity and general occurrence frequency, the node that sent the corresponding *Data Record Transfer Request*, may start to direct its CDRs to another CGF.
1094
+
1095
+ ## 6.3 Data Record Format in GTP'
1096
+
1097
+ The format of the PS domain CDRs, sent from CDF to CGF, is defined by the *Data Record Format*, which is the 5<sup>th</sup> octet of *Data Record Packet* information element, shown in Figure 6.6.
1098
+
1099
+ The following rules govern the *Data Record Format*:
1100
+
1101
+ - This field consists of one octet (#5).
1102
+ - The value range is 1-255 in decimal. The value '0' should not be used.
1103
+ - Only the values 1-10 and 51-255 can be used for standards purposes.
1104
+ - Values in the range of 11-50 are to be configured only by operators, and are not subject to standardization.
1105
+ - The value '1' identifies ASN.1 Basic Encoding Rules (BER) encoding, which must be supported in PS domain charging.
1106
+ Other values for optional encodings are specified in subclause 6.3.1.
1107
+
1108
+ ### 6.3.1 Standard Data Record Format
1109
+
1110
+ For the PS domain CDR transfer, defined by the present document, only an ASN.1 BER encoding is mandatory. For this encoding, the *Data Record Format* value is '1'.
1111
+
1112
+ Other ASN.1 encodings may be supported optionally, with *Data Record Format* values as indicated below:
1113
+
1114
+ - "1" signifies the use of Basic Encoding Rules (BER)
1115
+ - "2" signifies the use of unaligned basic Packed Encoding Rules (PER)
1116
+ - "3" signifies the use of aligned basic Packed Encoding Rules (PER)
1117
+
1118
+ ### 6.3.2 Private Data Record Formats
1119
+
1120
+ The *Data Record Format* values 11...50 (decimal) are reserved for private (implementation specific) format use.
1121
+
1122
+ ## 6.4 Data Record Format Version for CDRs
1123
+
1124
+ The CDR release and versions numbers are defined by the '*Data Record Format Version*', in octet 6 and 7 of the *Data Record Packet IE*, shown in Figure 6.6. The format of this field is depicted in Figure 6.10.
1125
+
1126
+ The first octet (#6 in *Data Record Packet IE*) is divided into two fields each with 4 bits :
1127
+
1128
+ The first field (bits 8-5 of octet 6, see figure 6.10) identifies the application. For charging purposes, the *Application Identifier* has a value of '1' (decimal).
1129
+
1130
+ Other possible applications of GTP may use different numbers.
1131
+
1132
+ The second field (bits 4-1 of octet 6, see figure 6.10) identifies the release.
1133
+
1134
+ The *Release Identifier* indicates the TS release, used to encode the CDR, i.e. its value corresponds to the first digit of the version number of the document [51], as shown on the cover sheet.
1135
+
1136
+ The second octet (#7 in *Data Record Packet IE*) identifies the version of the TS used to encode the CDR, i.e. its value corresponds to the second digit of the version number of the document [51] (as shown on the cover sheet), plus '1'.
1137
+
1138
+ E.g. for version 3.4.0, the *Version Identifier* would be "5".
1139
+
1140
+ In circumstances where the second digit is an alphabetical character, (e.g. 3.b.0), the corresponding ASCII value shall be taken, e.g. the *Version Identifier* would be "66" (ASCII(b)).
1141
+
1142
+ ![](6a5c8326029e6290e69a5f43d6ed4548_img.jpg)
1143
+
1144
+ | Data Record Packet IE | | Bits | | | | | | | |
1145
+ |-----------------------|--|------------------------|---|---|---|--------------------|---|---|---|
1146
+ | | | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 |
1147
+ | 6 | | Application Identifier | | | | Release Identifier | | | |
1148
+ | 7 | | Version Identifier | | | | | | | |
1149
+
1150
+ Figure 6.10: The Format of the *Data Record Format Version* Field
1151
+
1152
+ # --- Annex A (informative): Bibliography
1153
+
1154
+ ## a) The 3GPP charging specifications
1155
+
1156
+ - 3GPP TS 32.252: "Telecommunication management; Charging management; Wireless Local Area Network (WLAN) charging".
1157
+ - 3GPP TS 32.260: "Telecommunication management; Charging management; IP Multimedia Subsystem (IMS) charging".
1158
+ - 3GPP TS 32.271: "Telecommunication management; Charging management; Location Services (LCS) charging".
1159
+ - 3GPP TS 32.296: "Telecommunication management; Charging management; Online Charging System (OCS) applications and interfaces".
1160
+
1161
+ ## b) Common 3GPP specifications
1162
+
1163
+ - TS 22.101: "Service aspects; Service Principles".
1164
+ - TS 22.115: "Service aspects; Charging and billing".
1165
+ - TS 23.002: "Network Architecture".
1166
+ - TS 23.003: "Numbering, addressing and identification".
1167
+ - TS 27.001: "General on Terminal Adaptation Functions (TAF) for Mobile Stations (MS)".
1168
+
1169
+ ## c) other Domain and Service specific 3GPP / ETSI specifications
1170
+
1171
+ -
1172
+
1173
+ ## d) Relevant ITU Recommendations
1174
+
1175
+ - ITU-T Recommendation D.93: "Charging and accounting in the international land mobile telephone service (provided via cellular radio systems)".
1176
+ - ITU-T Recommendation E.164: "The international public telecommunication numbering plan".
1177
+ - ITU-T Recommendation Q.767: "Application of the ISDN user part of CCITT signalling System No.7 for international ISDN interconnections".
1178
+ - ITU-T Recommendation X.25: "Interface between Data Terminal Equipment (DTE) and Data Circuit-terminating Equipment (DCE) for terminals operating in the packet mode and connected to public data networks by dedicated circuit".
1179
+ - ITU-T Recommendation X.121: "International numbering plan for public data networks".
1180
+
1181
+ ## e) Relevant IETF RFCs
1182
+
1183
+ - IETF RFC 959 (1985): "File Transfer Protocol".
1184
+ - IETF RFC 3588 (2003): "Diameter base protocol"
1185
+ - IETF Internet-Draft "Diameter Credit Control Application"
1186
+ - IETF RFC 1350: "The TFT Protocol (Revision 2)"
1187
+
1188
+ # Annex B (informative): Change history
1189
+
1190
+ | Change history | | | | | | | |
1191
+ |----------------|-------|-----------|------|-----|-----------------------------------------------------------------------------------|-------|--------|
1192
+ | Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New |
1193
+ | Sep 2004 | SA 25 | SP-040553 | -- | -- | Submitted to TSG SA#25 for Approval | 1.0.0 | 6.0.0 |
1194
+ | Jun 2005 | SA 28 | SP-050275 | 0001 | -- | Correction to scope | 6.0.0 | 6.1.0 |
1195
+ | Jun 2005 | SA 28 | SP-050275 | 0002 | -- | Correction to references | 6.0.0 | 6.1.0 |
1196
+ | Jun 2005 | SA_28 | SP-050275 | 0003 | -- | Correction on the use of 'reference point' and 'interface' – Align with TR 21.905 | 6.0.0 | 6.1.0 |
1197
+ | Jun 2007 | SA 36 | -- | -- | -- | Automatic upgrade to Rel-7 (no CR) at freeze of Rel-7. | 6.1.0 | 7.0.0 |
1198
+ | Jun 2008 | SA 40 | SP-080274 | 0004 | -- | Implication on CDR transfer for EPC Charging | 7.0.0 | 8.0.0 |
1199
+ | Sep 2009 | SA 45 | SP-090536 | 0005 | -- | UDP Port number differentiation between GTPv2 and GTPv2 | 8.0.0 | 8.1.0 |
1200
+ | Dec 2009 | - | - | - | - | Update to Rel-9 version (MCC) | 8.1.0 | 9.0.0 |
1201
+ | Mar 2011 | - | - | - | - | Update to Rel-10 version (MCC) | 9.0.0 | 10.0.0 |
marked/Rel-10/32_series/32296/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
marked/Rel-10/32_series/32297/raw.md ADDED
@@ -0,0 +1,893 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+ # Keywords UMTS, E-UTRAN, GPRS, EPS, charging management 3GPP TS 32.297 V10.2.0 (2011-12)
4
+
5
+ *Technical Specification*
6
+
7
+ ## **3GPP** **3rd Generation Partnership Project;** Postal address **Technical Specification Group Services and System Aspects;** **Telecommunication management;** 3GPP support office address 650 Route des Lucioles - Sophia Antipolis Valbonne - FRANCE Tel.: +33 4 92 93 16 00 Fax: +33 4 93 17 15 27 Charging Data Record (CDR) file forr
8
+
9
+ ![LTE logo with '4 ADVANCED' text above the 't'](64662465bba247703fdec49c8f3309f9_img.jpg)
10
+
11
+ LTE logo with '4 ADVANCED' text above the 't'
12
+
13
+ Internet
14
+ <http://www.3gpp.org>
15
+
16
+ ![3GPP logo with a signal icon](390120de4fe440c42fea8154fcaad334_img.jpg)
17
+
18
+ 3GPP logo with a signal icon
19
+
20
+ # **Copyright Notification**
21
+
22
+ No part may be reproduced except as authorized by written permission.
23
+ The copyright and the foregoing restriction extend to reproduction in all media.
24
+
25
+ © 2011, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TTA, TTC).
26
+ All rights reserved.
27
+
28
+ UMTS™ is a Trade Mark of ETSI registered for the benefit of its members
29
+
30
+ 3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
31
+
32
+ LTE™ is a Trade Mark of ETSI currently being registered for the benefit of its Members and of the 3GPP Organizational Partners
33
+
34
+ GSM® and the GSM logo are registered and owned by the GSM Association
35
+
36
+ The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP.
37
+
38
+ The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented.
39
+
40
+ This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices.
41
+
42
+ # --- Contents
43
+
44
+ | | |
45
+ |------------------------------------------------------------------|----|
46
+ | Foreword ..... | 5 |
47
+ | 1 Scope..... | 6 |
48
+ | 2 References..... | 6 |
49
+ | 3 Definitions, symbols and abbreviations ..... | 9 |
50
+ | 3.1 Definitions..... | 9 |
51
+ | 3.2 Symbols..... | 10 |
52
+ | 3.3 Abbreviations ..... | 10 |
53
+ | 4 Architecture considerations..... | 11 |
54
+ | 5 CDR File Transfer Principles and Scenarios ..... | 12 |
55
+ | 5.1 Local CDR and CDR file handling ..... | 12 |
56
+ | 5.1.1 CDR processing..... | 12 |
57
+ | 5.1.2 CDR routeing..... | 13 |
58
+ | 5.1.3 Local CDR file management..... | 13 |
59
+ | 5.2 File format principles ..... | 15 |
60
+ | 5.3 File Transport and protocol ..... | 16 |
61
+ | 5.3.1 Basic file transport mechanism ..... | 16 |
62
+ | 5.3.2 Use of File Transfer IRP..... | 16 |
63
+ | 5.3.3 Use of IPDR ..... | 16 |
64
+ | 5.4 File transfer modes and session management ..... | 17 |
65
+ | 5.4.1 Basic file transfer mechanism..... | 17 |
66
+ | 5.4.1.1 Push mode..... | 17 |
67
+ | 5.4.1.2 Pull mode ..... | 17 |
68
+ | 5.4.2 Use of File Transfer IRP..... | 17 |
69
+ | 5.4.3 Use of IPDR ..... | 17 |
70
+ | 6 CDR file format specification..... | 18 |
71
+ | 6.1 File format conventions..... | 18 |
72
+ | 6.1.1 CDR file header format ..... | 19 |
73
+ | 6.1.1.1 File length ..... | 19 |
74
+ | 6.1.1.2 Header length..... | 19 |
75
+ | 6.1.1.3 High release / version identifier..... | 19 |
76
+ | 6.1.1.4 Low release / version identifier ..... | 19 |
77
+ | 6.1.1.5 File opening timestamp..... | 20 |
78
+ | 6.1.1.6 Last CDR append timestamp ..... | 20 |
79
+ | 6.1.1.7 Number of CDRs in file..... | 20 |
80
+ | 6.1.1.8 File sequence number ..... | 20 |
81
+ | 6.1.1.9 File Closure Trigger Reason..... | 20 |
82
+ | 6.1.1.10 Node IP address ..... | 21 |
83
+ | 6.1.1.11 Lost CDR indicator..... | 21 |
84
+ | 6.1.1.12 Length of CDR routeing filter ..... | 21 |
85
+ | 6.1.1.13 CDR routeing filter ..... | 21 |
86
+ | 6.1.1.14 Length of private extension ..... | 22 |
87
+ | 6.1.1.15 Private extension..... | 22 |
88
+ | 6.1.1.16 High release identifier extension ..... | 22 |
89
+ | 6.1.1.17 Low release identifier extension ..... | 22 |
90
+ | 6.1.2 CDR header format..... | 22 |
91
+ | 6.1.2.1 CDR length ..... | 22 |
92
+ | 6.1.2.2 Release Identifier ..... | 23 |
93
+ | 6.1.2.3 Version Identifier..... | 23 |
94
+ | 6.1.2.4 Data Record Format..... | 23 |
95
+ | 6.1.2.5 TS number..... | 23 |
96
+ | 6.1.2.6 Release Identifier extension..... | 24 |
97
+ | 6.2 CDR file naming convention..... | 24 |
98
+ | 6.3 Detailed FTP transfer and session management procedures..... | 25 |
99
+ | 6.4 Error handling ..... | 25 |
100
+
101
+ | | | |
102
+ |-------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|-----------|
103
+ | <b>Annex A (informative):</b> | <b>Bibliography ...................................................................................................................</b> | <b>27</b> |
104
+ | Annex B (informative): | Change history................................................................................................................... | 28 |
105
+
106
+ # --- Foreword
107
+
108
+ This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP).
109
+
110
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
111
+
112
+ Version x.y.z
113
+
114
+ where:
115
+
116
+ - x the first digit:
117
+ - 1 presented to TSG for information;
118
+ - 2 presented to TSG for approval;
119
+ - 3 or greater indicates TSG approved document under change control.
120
+ - y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
121
+ - z the third digit is incremented when editorial only changes have been incorporated in the document.
122
+
123
+ # --- 1 Scope
124
+
125
+ The present document is part of a series of documents that specify charging functionality and charging management in 3GPP networks(GSM/UMTS/EPS). The 3GPP core network charging architecture and principles are specified in 3GPP TS 32.240 [1], which provides an umbrella for other charging management TSs that specify:
126
+
127
+ - the content of the CDRs per domain / subsystem / service (offline charging),
128
+ - the content of real-time charging messages per domain / subsystem / service (online charging);
129
+ - the functionality of online and offline charging for those domains / subsystems / services;
130
+ - the interfaces that are used in the charging framework to transfer the charging information (i.e. CDRs or charging events)
131
+
132
+ The complete document structure for these TSs is defined in TS 32.240 [1].
133
+
134
+ The present document specifies the transaction based mechanism for the near real time transfer of CDRs within the network.
135
+
136
+ The present document is related to other 3GPP charging TSs as follows:
137
+
138
+ - The common 3GPP charging architecture is specified in TS 32.240 [1];
139
+ - The parameters, abstract syntax and encoding rules for the CDRs are specified in TS 32.298 [51];
140
+ - The file based mechanism used to transfer the CDRs from the network to the operator's billing domain (e.g. the post-processing system or a mediation device) is specified in TS 32.297 [52];
141
+
142
+ The 3GPP Diameter application that is used for offline and online charging is specified in TS 32.299 [50].
143
+
144
+ All terms, definitions and abbreviations used in the present document, that are common across 3GPP TSs, are defined in the 3GPP Vocabulary, TR 21.905 [100]. Those that are common across charging management in 3GPP domains services, or subsystems are provided in the umbrella document TS 32.240 [1] and are copied into clause 3 of the present document for ease of reading. Finally, those items that are specific to the present document are defined exclusively in the present document.
145
+
146
+ Furthermore, requirements that govern the charging work are specified in 3GPP TS 22.115 [101].
147
+
148
+ # --- 2 References
149
+
150
+ The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
151
+
152
+ - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
153
+ - For a specific reference, subsequent revisions do not apply.
154
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
155
+
156
+ - [1] 3GPP TS 32.240: "Telecommunication management; Charging management; Charging architecture and principles".
157
+ - [2]-[9] Void.
158
+ - [10] 3GPP TS 32.250: "Telecommunication management; Charging management; Circuit Switched (CS) domain charging".
159
+ - [11] 3GPP TS 32.251: "Telecommunication management; Charging management; Packet Switched (PS) domain charging".
160
+
161
+ - [12] 3GPP TS 32.252: "Telecommunication management; Charging management; Wireless Local Area Network (WLAN) charging".
162
+ - [13]-[19] Void
163
+ - [20] 3GPP TS 32.260: "Telecommunication management; Charging management; IP Multimedia Subsystem (IMS) charging".
164
+ - [21]-[29] Void.
165
+ - [30] 3GPP TS 32.270: "Telecommunication management; Charging management; Multimedia Messaging Service (MMS) charging".
166
+ - [31] 3GPP TS 32.271: "Telecommunication management; Charging management; Location Services (LCS) charging".
167
+ - [32] 3GPP TS 32.272: "Telecommunication management; Charging management; Push-to-talk over Cellular (PoC) charging".
168
+ - [33] 3GPP TS 32.273: "Telecommunication management; Charging management; Multimedia Broadcast and Multicast Service (MBMS) charging".
169
+ - [34] 3GPP TS 32.275: "Telecommunication management; Charging management; Multimedia Telephony (MMTel) charging".
170
+ - [35]-[49] Void.
171
+ - [50] 3GPP TS 32.299: "Telecommunication management; Charging management; Diameter charging application".
172
+ - [51] 3GPP TS 32.298: "Telecommunication management; Charging management; Charging Data Record (CDR) encoding rules description".
173
+ - [52] Void.
174
+ - [53] 3GPP TS 32.296: "Telecommunication management; Charging management; Online Charging System (OCS) applications and interfaces".
175
+ - [54] 3GPP TS 32.295: "Telecommunication management; Charging management; Charging Data Record (CDR) transfer".
176
+ - [55]-[99] Void.
177
+ - [100] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications".
178
+ - [101] 3GPP TS 22.115 "Service aspects; Charging and billing".
179
+ - [102]-[199] Void.
180
+ - [200] 3GPP TS 23.078: "Customized Applications for Mobile network Enhanced Logic (CAMEL); Stage 2".
181
+ - [201]-[399] Void
182
+ - [400] IETF RFC 959 (1985): "File Transfer Protocol".
183
+ - [401] ATIS-PP-0300075.1.200X "Usage Data Management for Packet-Based Services - Service Neutral Protocol Specification for Billing Applications"
184
+ - [402] IPDR "IPDR/File Transfer Protocol"
185
+ - [403] IPDR "IPDR/SP Protocol Specification"
186
+ - [404]-[499] Void.
187
+ - [500] 3GPP TS 32.341: "Telecommunication management; File Transfer (FT) Integration Reference Point (IRP): Requirements".
188
+
189
+ - [501] 3GPP TS 32.342: "Telecommunication management; File Transfer (FT) Integration Reference Point (IRP): Information Service (IS)".
190
+ - [502] 3GPP TS 32.343: "Telecommunication management; File Transfer (FT) Integration Reference Point (IRP): Common Object Request Broker Architecture (CORBA) Solution Set (SS)".
191
+ - [503] 3GPP TS 32.344: "Telecommunication management; File Transfer (FT) Integration Reference Point (IRP): Common Management Information Protocol (CMIP) Solution Set (SS)".
192
+
193
+ # --- 3 Definitions, symbols and abbreviations
194
+
195
+ ## 3.1 Definitions
196
+
197
+ For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [100], 3GPP TS 32.240 [1] and the following apply:
198
+
199
+ **Billing Domain:** part of the operator network, which is outside the telecommunication network that receives and processes charging information from the core network charging functions. It includes functions that can provide billing mediation and billing or other (e.g. statistical) end applications. It is only applicable to offline charging (see "Online Charging System" for equivalent functionality in online charging).
200
+
201
+ **CDR field Categories:** defined in the middle tier charging TSs. CDR fields may be operator provisionable and are divided into the following categories:
202
+
203
+ - **Mandatory (M):** field that shall always be present in the CDR.
204
+ - **Conditional (C):** field that shall be present in a CDR if certain conditions are met.
205
+ - **Operator Provisionable: Mandatory (O<sub>M</sub>):** field that, if provisioned by the operator, shall always be present in the CDR.
206
+ - **Operator Provisionable: Conditional (O<sub>C</sub>):** field that, if provisioned by the operator, shall be present in a CDR if certain conditions are met.
207
+
208
+ **charging:** function within the telecommunications network and the associated OCS/BD components whereby information related to a chargeable event is collected, formatted, transferred and evaluated in order to make it possible to determine usage for which the charged party may be billed (offline charging) or the subscriber's account balance may be debited / credited (online charging).
209
+
210
+ **Charging Data Record (CDR):** formatted collection of information about one or more chargeable event(s) (e.g. time of call set-up, duration of the call, amount of data transferred, etc) for use in billing and accounting. For each party to be charged for parts of or all charges of the chargeable event(s) a separate CDR shall be generated, i.e. more than one CDR may be generated for a single chargeable event, e.g. because of its long duration, or because more than one charged party is to be charged.
211
+
212
+ **charging function:** entity inside the core network domain, subsystem or service that is involved in charging for that domain, subsystem or service.
213
+
214
+ **circuit switched domain:** domain within GSM / UMTS in which information is transferred in circuit switched mode.
215
+
216
+ **domain:** part of the 3GPP telecommunication network that provides network resources using a certain bearer technology.
217
+
218
+ **GPRS:** packet switched bearer and radio services for GSM and UMTS systems.
219
+
220
+ **middle tier (charging) TS:** term used for the 3GPP charging TSs that specify the domain / subsystem / service specific, online and offline, charging functionality. These are all the TSs in the numbering range from 3GPP TS 32.250 to 3GPP TS 32.279, e.g. 3GPP TS 32.250 [10] for the CS domain, or 3GPP TS 32.270 [30] for the MMS service. Currently, there is only one "tier 1" charging TS in 3GPP, which is TS 32.240 [1] that specifies the charging architecture and principles. Finally, there are a number of top tier charging TSs in the 32.29x numbering range ([50] ff) that specify common charging aspects such as parameter definitions, encoding rules, the common billing domain interface or common charging applications.
221
+
222
+ **near real-time:** near real-time charging and billing information is to be generated, processed, and transported to a desired conclusion in less than 1 minute.
223
+
224
+ **offline charging:** charging mechanism where charging information **does not** affect, in real-time, the service rendered
225
+
226
+ **online charging:** charging mechanism where charging information **can** affect, in real-time, the service rendered and therefore a direct interaction of the charging mechanism with session/service control is required.
227
+
228
+ **packet switched domain:** domain in which data is transferred between core network elements.
229
+
230
+ **real-time:** real-time charging and billing information is to be generated, processed, and transported to a desired conclusion in less than 1 second.
231
+
232
+ ## 3.2 Symbols
233
+
234
+ For the purposes of the present document, the following symbols apply:
235
+
236
+ | | |
237
+ |-----|-------------------------------------------------------------------------------------------------------------|
238
+ | Bc | Reference point for the CDR file transfer from the Circuit Switched CGF to the BD. |
239
+ | Bi | Reference point for the CDR file transfer from the IMS CGF to the BD. |
240
+ | Bl | Reference point for the CDR file transfer from the GMLC CGF to the BD. |
241
+ | Bm | Reference point for the CDR file transfer from the MMS CGF to the BD. |
242
+ | Bmb | Reference point for the CDR file transfer from the MBMS CGF to the BD. |
243
+ | Bo | Reference point for the CDR file transfer from the OCF CGF to the BD. |
244
+ | Bp | Reference point for the CDR file transfer from the Packet Switched CGF to the BD. |
245
+ | Bs | Reference point for the CDR file transfer for CAMEL services to the BD, i.e. from the SCF CGF to the BD. |
246
+ | Bt | Reference point for the CDR file transfer from the PoC CGF to the BD. |
247
+ | Bw | Reference point for the CDR file transfer from the I-WLAN CGF to the BD. |
248
+ | Bx | Reference point for CDR file transfer between any (generic) 3G domain, subsystem or service CGF and the BD. |
249
+ | Ga | Reference point for CDR transfer between a CDF and the CGF. |
250
+ | Rf | Offline Charging Reference Point between the CTF within a 3G network entity and the CDF. |
251
+
252
+ ## 3.3 Abbreviations
253
+
254
+ For the purposes of the present document, the following abbreviations apply:
255
+
256
+ | | |
257
+ |---------|-----------------------------------------------------------|
258
+ | bcd | binary coded decimal |
259
+ | BD | Billing Domain |
260
+ | CAMEL | Customised Applications for Mobile network Enhanced Logic |
261
+ | CDF | Charging Data Function |
262
+ | CDR | Charging Data Record |
263
+ | CGF | Charging Gateway Function |
264
+ | CS | Circuit Switched |
265
+ | CTF | Charging Trigger Function |
266
+ | EPS | Evolved Packet System |
267
+ | E-UTRAN | Evolved Universal Terrestrial Radio Access Network |
268
+ | FTP | File Transfer Protocol |
269
+ | GMLC | Gateway MLC |
270
+ | GPRS | General Packet Radio Service |
271
+ | IMS | IP Multimedia Subsystem |
272
+ | IP | Internet Protocol |
273
+ | IPDR | Internet Protocol Detail Record |
274
+ | I-WLAN | Interworking WLAN |
275
+ | LAN | Local Area Network |
276
+ | MBMS | Multimedia Broadcast/Multicast Service |
277
+ | MLC | Mobile Location Center |
278
+ | MMS | Multimedia Messaging Service |
279
+ | OAM&P | Operation, Administration, Maintenance and Provisioning |
280
+ | OCF | Online Charging Function |
281
+ | OCS | Online Charging System |
282
+ | PoC | Push-to-talk over Cellular |
283
+ | PS | Packet Switched |
284
+ | SCF | Service Control Function |
285
+ | UTC | Universal Time Coordinated |
286
+ | WLAN | Wireless LAN |
287
+
288
+ # 4 Architecture considerations
289
+
290
+ "Bx" is a common designator for the reference points from the network to the billing domain (BD) that are intended for the transport of CDR files. The letter "x" indicates the different 3GPP network domain, subsystem or service, where
291
+
292
+ - c represents Circuit Switched (CS) in TS 32.250 [10],
293
+ - p represents Packet Switched (PS) in TS 32.251 [11],
294
+ - i represents IP Multimedia Subsystem (IMS) in TS 32.260 [20],
295
+ - l represents Location Service (LCS) in TS 32.271 [31],
296
+ - m represents Multimedia Messaging Service (MMS) in TS 32.270 [30],
297
+ - mb represents Multimedia Broadcast/Multicast Service (MBMS) in TS 32.273 [33],
298
+ - o represents the Online Charging System (OCS) in TS 32.296 [53],
299
+ - t represents the PoC service (PoC) in TS 32.272 [32],
300
+ - s represents the CAMEL SCF in TS 23.078 [200], and
301
+ - w represents interworking Wireless LAN (I-WLAN) in TS 32.252[12].
302
+
303
+ By definition, dealing with CDR files only implies that Bx is solely related to offline charging. The following figure depicts the position of the Bx reference point within the overall 3GPP offline charging architecture.
304
+
305
+ ![Figure 4.1: Logical ubiquitous offline charging architecture diagram. The diagram shows the 3GPP network (grey box) containing three domains: CN Domain (yellow), Service nodes (orange), and Sub-system (magenta). Each domain contains a Charging Trigger Function (CTF, pink), a Charging Data Function (CDF, green), and a Charging Gateway Function (CGF, orange). The CGF in each domain is connected to the Billing Domain (blue box) via the Bx reference point. The Bx reference point is shown as a line with a break and a label 'Bx'.](daa4a6fa7e2ba1954258f86b4928eb32_img.jpg)
306
+
307
+ The diagram illustrates the logical ubiquitous offline charging architecture. A large grey box labeled "3GPP network" contains three stacked colored areas: a yellow "CN Domain", an orange "Service nodes" area, and a magenta "Sub-system" area. Within each area, there are vertical bars representing functions: a pink bar for CTF (Charging Trigger Function), a green bar for CDF (Charging Data Function), and an orange bar for CGF (Charging Gateway Function). Lines labeled "Rf" connect the CTF to the CDF. Lines labeled "Ga" connect the CDF to the CGF. All three CGFs (one in each domain) are connected to a single blue box on the right labeled "Billing Domain" via a common line labeled "Bx".
308
+
309
+ Figure 4.1: Logical ubiquitous offline charging architecture diagram. The diagram shows the 3GPP network (grey box) containing three domains: CN Domain (yellow), Service nodes (orange), and Sub-system (magenta). Each domain contains a Charging Trigger Function (CTF, pink), a Charging Data Function (CDF, green), and a Charging Gateway Function (CGF, orange). The CGF in each domain is connected to the Billing Domain (blue box) via the Bx reference point. The Bx reference point is shown as a line with a break and a label 'Bx'.
310
+
311
+ **CTF:** Charging Trigger Function
312
+ **CDF:** Charging Data Function
313
+ **CGF:** Charging Gateway Function
314
+ **BD:** Billing Domain. This may also be a billing system/ billing mediation device.
315
+
316
+ **Figure 4.1: Logical ubiquitous offline charging architecture**
317
+
318
+ As illustrated in figure 4.1, the CGF in each network domain, service or subsystem is relevant for the network side of the Bx reference point and is connected with the BD that forms the receiving end of the Bx reference point. Further details of the Billing Domain, i.e. beyond terminating Bx, are outside the scope of 3GPP standardization. Refer to 3GPP TS 32.240 [1] for the complete description of the 3GPP charging architecture.
319
+
320
+ Note that the OCS can also generate CDRs and transfer them to the BD across the Bo reference point (not depicted in figure 4.1). Refer to 3GPP TS 32.296 [53] for further information on the OCS.
321
+
322
+ Furthermore the GSM SCF, defined in CAMEL, can also generate CDRs and transfer them to the BD across the Bs reference point (not depicted in figure 4.1). Refer to 3GPP TS 23.078 [200] for further information on CAMEL.
323
+
324
+ # 5 CDR File Transfer Principles and Scenarios
325
+
326
+ This clause contains specifications for the principles and scenarios covering the CDR file transfer interface from the network to the Billing Domain. These specifications apply to all domains, subsystems and services that are listed in clause 4, including the OCS Bo and the GSM SCF's Bs interface. Alternatively, in the CS domain (i.e. for Bc), the file transfer mechanism specified in 3GPP TS 32.250 [10] may be used. Consequently, for Bc it is up to implementation choice to provide either the legacy interface, the interface specified in the present document, or both.
327
+
328
+ The scenarios in this clause are divided into the following categories:
329
+
330
+ - Local CDR and CDR file handling;
331
+ - File format principles;
332
+ - File Transport and protocol;
333
+ - File transfer modes and session management.
334
+
335
+ Other interface principles such as security and performance are dependent on vendor implementation and operator's network design and are not covered by the present document.
336
+
337
+ ## 5.1 Local CDR and CDR file handling
338
+
339
+ ### 5.1.1 CDR processing
340
+
341
+ As depicted in figure 4.1. above, the CGF collects CDRs from the CDF. If the CDF and the CGF are separate entities, then the standard Ga interface as specified in 3GPP TS 32.295 [54] is used to transfer the CDRs from the CDF to the CGF. If CDF and CGF are integrated, then a proprietary, internal mechanism is used. The possibilities of separate or integrated CDF and CGF are specified per domain, subsystem and service in the respective "middle tier" charging TS, i.e. those in the [10] through [49] reference number range, and in TS 32.296 [53] for the OCS.
342
+
343
+ In any case, CDRs are transferred, in near real time, from the CDF to the CGF as soon as they have been closed by the CDF. Refer to 3GPP TS 32.295 [54] for further details. Once received by the CGF, the CDRs may undergo semantical and/or syntactical sanity checks, however, these checks are not specified further within the present document.
344
+
345
+ If the CGF determines that a CDR is not well formatted, or otherwise incorrect, then the defective CDR parameter(s) shall be filled with an appropriate "replacement" indicator within the limits of the syntax allowed for the parameter. If the error renders the complete CDR unusable (i.e. the above replacement of erroneous parameters is not possible), then no further action of the CGF can be performed regarding this CDR. An example of a case where the erroneous parameter cannot be replaced is when the "CDR type" attribute of a CDR received by the CGF is corrupted. Details of this function are implementation specific.
346
+
347
+ CDRs that have been processed by the CGF without error, or where errors have been corrected by the CGF as described above, are considered "acceptable" by the CGF. CDRs that have non-recoverable errors are not considered "acceptable" by the CGF. The "acceptable" CDRs are immediately placed into a CDR file by the CGF. The CDRs that are not "acceptable" should be properly reflected in an error log and appropriate alarms should be generated, after which they may be destroyed. Furthermore, to the extent possible, the number of lost CDRs and the fact that CDRs were lost, shall be indicated in the CDR file.
348
+
349
+ It is acknowledged that the processing of a CDR between being received until it is placed on the CDR file, will take a small amount of time. Hence, where the present document mandates the "immediate" treatment of CDRs received by the CGF, it is to be interpreted such that it is not allowed to postpone the processing of any received CDRs for any reason. In technical terms, "immediate" shall be interpreted as
350
+
351
+ - The system shall be capable of complying with near real time requirements as specified in subclause 3.1.
352
+ - The system should be capable of complying, as closely as possible, with real time requirements as specified in subclause 3.1.
353
+
354
+ Once a CDR has been stored on the appropriate file, the CGF may destroy any other reference to that CDR.
355
+
356
+ ### 5.1.2 CDR routeing
357
+
358
+ In the default mode of operation, the CGF manages a single ("default") file for the storage of all "acceptable" CDRs. However, the CGF may also route CDRs to different files that are kept open concurrently, i.e. additional files may be configured by OAM&P commands together with associated CDR routeing filters. While the CGF will store only those CDRs matching the associated routeing filter on each of the additional files, the default file is used to store all CDRs that do not match any of the routeing filters configured for the additional files.
359
+
360
+ The CDR routeing function shall apply CDR parameters and CDR origin to decide into which file to place the CDR. The file name shall, within the limits of the file naming conventions, contain an indication of the CDR routeing filter applied.
361
+
362
+ As a minimum, each CGF implementation shall support the CDR type and the sending CDF as selection criteria for CDR routeing. It shall then be possible to include in a file only the following CDRs:
363
+
364
+ - CDRs of a single type;
365
+ - CDRs of a set of specified types (e.g. only IMS CDR types);
366
+ - CDRs originated by a single CDF;
367
+ - CDRs originated by a set of CDFs;
368
+ - Any combination of the above.
369
+
370
+ Further details of the CDR routeing function, such as
371
+
372
+ - the maximum number of simultaneously open CDR files;
373
+ - the order in which the routeing filters are evaluated;
374
+ - the way CDR filters can be configured by OAM&P;
375
+
376
+ are implementation specific. In order to avoid arbitrary routeing of CDRs, operators should assure that the routeing filters assigned per file, do not overlap with each other.
377
+
378
+ The term "matching CDR" is used in the present document to denote a CDR that matches the routeing filter of a given CDR file.
379
+
380
+ ### 5.1.3 Local CDR file management
381
+
382
+ For the default case, plus each of the additional CDR routeing filters that may be set up on the CGF (cf. subclause 5.1.2 above), the CGF provides a non-interrupted chain of CDR files. As described above, each CDR is immediately stored in the appropriate file after being received and determined "acceptable" by the CGF.
383
+
384
+ Several conditions may govern the closure of a CDR file by the CGF:
385
+
386
+ - A configurable file size limit;
387
+ - A configurable file closure time;
388
+ - A configurable file lifetime ("interval");
389
+ - A configurable number of CDRs within the file;
390
+ - CDR release, version or encoding change;
391
+ - Manual OAM&P actions;
392
+ - System defined reasons (e.g. file system full).
393
+
394
+ When a CDR file is closed, the next matching CDR shall be placed in the next file in the chain. The exact time when this next CDR file is physically generated, i.e.:
395
+
396
+ - immediately after the previous file has been closed (i.e. the earliest possible time),
397
+
398
+ - when the next matching CDR arrives (i.e. the latest possible time),
399
+ - anytime in between,
400
+
401
+ is implementation specific. However, each CDR file must contain all "acceptable" matching CDRs received and processed by the CGF between the closure of the previous file and the configured file closure trigger of the current file, as specified above. In any case, a file must be generated and closed upon the occurrence of the file closure trigger, i.e. an empty file (containing no CDRs) if no matching CDRs arrived since the closure of the last file in the chain. Upon file closure, the CDR file is immediately available for transfer to the BD.
402
+
403
+ CDR files may be removed from the CGF in one of the following ways:
404
+
405
+ - By the BD issuing corresponding commands provided by the file transfer protocol;
406
+ - By the CGF application once the file has been transferred;
407
+ - Due to CGF file system storage limitation or configurable file age limits;
408
+ - OAM&P action.
409
+
410
+ In order to avoid loss of CDRs, Operators should manage the system in a way that the "system defined" file closure triggers mentioned above do not occur.
411
+
412
+ ## 5.2 File format principles
413
+
414
+ The CDR file format is depicted below.
415
+
416
+ ![Diagram of CDR File Format showing a header followed by concatenated CDRs.](4ee27dbf5ef12e7b58b0ef0937bc5a5e_img.jpg)
417
+
418
+ The diagram illustrates the structure of a CDR file. At the top is a yellow rectangular block labeled **Header with Specified Length**. Below this header is a vertical stack of light blue rectangular blocks representing concatenated CDRs. The first five blocks are labeled **CDR 1**, **CDR 2**, **CDR 3**, **CDR 4**, and **CDR 5** respectively. A vertical ellipsis (three dots) is shown between the fifth and the final block, indicating that there can be any number of CDRs. The final block is labeled **CDR n**. To the left of the stack of CDR blocks, a large curly brace groups them together and is labeled **Concatenated CDRs**.
419
+
420
+ Diagram of CDR File Format showing a header followed by concatenated CDRs.
421
+
422
+ **Figure 5.2.1: CDR File Format**
423
+
424
+ The CDR files contain a variable length header section followed by a variable sized CDR data section. The CDR data section contains zero or more concatenated CDRs. Each CDR in a file includes a header indicating the CDR length, data record format, release, version and encoding scheme.
425
+
426
+ The BD should use a decoder with a version number which is equal or greater of this version to be able to decode all the CDRs in the file.
427
+
428
+ Clause 6 of the present document specifies the file format applying the above principles at bit level detail.
429
+
430
+ ## 5.3 File Transport and protocol
431
+
432
+ Two mechanisms are defined for the transport of CDR files from the CGF to the BD:
433
+
434
+ - A basic transport mechanism is defined in subclause 5.3.1 and must be supported by all CGF implementations;
435
+ - The use of the File Transfer IRP as described in subclause 5.3.2 may additionally be supported by the CGF as an implementation option.
436
+
437
+ The use of IPDR as described in subclause 5.3.3 may optionally be supported on the Bx reference point.
438
+
439
+ ### 5.3.1 Basic file transport mechanism
440
+
441
+ The following stipulations govern the choice and usage of file transport protocol for this transport mechanism.
442
+
443
+ - a) The default protocol for CDR file transport is FTP (RFC 959 [400]).
444
+ - b) The use of other protocols is optional, however FTP must always be supported.
445
+ - c) The CDR files may be transferred in either push or pull mode on the Bx interface. Further specifications of these transfer modes are provided in subclause 5.4.1 and subclause 5.4.2, respectively.
446
+ - d) All standard FTP commands specified in RFC 959 [400] shall be supported by the CGF.
447
+
448
+ All further requirements specified within the present document with reference to the operation of the file transfer protocol in this mechanism (cf. clause 6), are solely related to FTP as the transfer protocol, as no assumptions can be made as to the ways of working of optional other protocols. However, additional protocols shall be implemented such that, to the extent possible, the same logic is applied as described in the present document for FTP.
449
+
450
+ ### 5.3.2 Use of File Transfer IRP
451
+
452
+ The File Transfer IRP is specified in 3GPP TSs 32.341 [500], 32.342 [501], 32.343 [502] and 32.344 [503]. The support of the solution sets (CORBA, CMIP or both) is left to implementation choice. Otherwise, the CGF implementation of the IRP shall comply with the above TSs, i.e. there are no further additions or limitations with regard to the use of the IRP in charging.
453
+
454
+ ### 5.3.3 Use of IPDR
455
+
456
+ As depicted in ATIS-PP-0300075.1.200X [401] IPDR file transfer or streaming protocol can be used for the Bx reference point.
457
+
458
+ The IPDR file transfer is specified in IPDR/File Transfer Protocol [402]. The IPDR streaming protocol is specified in IPDR/SP [403].
459
+
460
+ ## 5.4 File transfer modes and session management
461
+
462
+ ### 5.4.1 Basic file transfer mechanism
463
+
464
+ Files can be transferred to the BD in one, or both, of the following modes. Detailed FTP file transfer and session management procedures are specified in clause 6.
465
+
466
+ #### 5.4.1.1 Push mode
467
+
468
+ In this transfer mode the CDR files are written from the CGF to the BD filestore at a time and/or frequency controlled by the CGF. I.e. the CGF *pushes* the files to the BD. This implies that the CGF operates in client mode and the BD in server mode. If the CGF generates concurrent CDR files based on the CDR routeing function specified in subclause 5.1.2, then it shall be able to send the different files to different BD systems, i.e. the BD address is part of the CDR file routeing filter.
469
+
470
+ As a minimum, the following events shall be capable of triggering a file push in the CGF:
471
+
472
+ - A (configured number of) new CDR file(s) has become available for transmission;
473
+ - The CDR file / files has / have exceeded a configurable (total) size limit;
474
+ - A configurable, regular time interval has elapsed;
475
+ - The CGF filestore utilization has exceeded a configurable level.
476
+
477
+ If the file transfer fails, the CGF should properly reflect this in an error log and generate appropriate alarms. Possible measures to handle file transfer failures are discussed in clause 6.
478
+
479
+ Security measures, e.g. the mutual identification / verification of the peer systems, are outside the scope of the present document.
480
+
481
+ #### 5.4.1.2 Pull mode
482
+
483
+ In this transfer mode the BD reads the CDR files that are available in the appropriate CGF directories. The time and/or frequency of the file transfer is controlled by the BD. I.e. the BD *pulls* the files from the CGF. This implies that the CGF operates in server mode and the BD in client mode.
484
+
485
+ In this mode, the BD may request the files from the CGF at any point in time at the discretion of the BD, i.e. the CGF cannot make any assumptions of the time or frequency of the file pull to occur. If the file transfer fails, any further action is up to the BD, however, the CGF should properly reflect this in an error log and generate appropriate alarms. Possible measures to handle file transfer failures are discussed in clause 6.
486
+
487
+ Security measures, e.g. the mutual identification / verification of the peer systems, are outside the scope of the present document.
488
+
489
+ ### 5.4.2 Use of File Transfer IRP
490
+
491
+ File transfer modes and session management using the optional File Transfer IRP are governed by 3GPP TSs 32.341 [500], 32.342 [501], 32.343 [502] and 32.344 [503].
492
+
493
+ ### 5.4.3 Use of IPDR
494
+
495
+ File transfer mode and session management using the optional IPDR protocols are governed by IPDR File Transfer [402] or streaming protocol [403].
496
+
497
+ # --- 6 CDR file format specification
498
+
499
+ This clause provides detail specifications for the CDR file format. These specifications apply to all domains, subsystems and services listed in clause 4. Alternatively, in the CS domain (i.e. for Bc), the file transfer mechanism specified in 3GPP TS 32.250 [10] may be used. Consequently, for Bc it is up to implementation choice to provide either the legacy interface, the interface specified in the present document, or both.
500
+
501
+ The file format specification in this clause is divided into the following categories:
502
+
503
+ - File format conventions;
504
+ - File naming and directory conventions;
505
+ - Detailed file transfer and session management procedures.
506
+ - Error handling
507
+
508
+ Only the basic file transfer mechanism is covered in the present document. Refer to 3GPP TSs 32.341 [500], 32.342 [501], 32.343 [502] and 32.344 [503] for the corresponding details when using the optional File Transfer IRP and [402], [403] when using the optional IPDR protocols.
509
+
510
+ ## 6.1 File format conventions
511
+
512
+ The file format shall apply the following conventions.
513
+
514
+ - a) The CDR files contain a variable length file header immediately followed by a variable number (zero or more) of concatenated CDRs which are structured according to the CDR format specified in the middle tier charging TSs.
515
+ - b) The syntax and encoding rules for the CDRs are specified in 3GPP TS 32.298 [51].
516
+ - c) Each CDR is immediately preceded by a fixed length plain text header.
517
+ - d) The file header fields and CDR header fields are in Network byte order (Big Endian).
518
+ - e) The file header contains fields specified in subclause 6.1.1.
519
+ - f) The CDR header contains fields specified in subclause 6.1.2.
520
+ - g) File header fields that are not known at the time the file is opened are populated after all the CDRs are included and the file is ready to be closed.
521
+
522
+ The CDR file is named based on the naming convention specified in clause 6.2.
523
+
524
+ ### 6.1.1 CDR file header format
525
+
526
+ The exact format of the CDR file header is given in table 6.1.1.
527
+
528
+ **Table 6.1.1: Format of CDR File Header**
529
+
530
+ | Octets | Bits | | | | | | | | | | | |
531
+ |------------|----------------------------------------------|---|---|---|-------------------------|---|---|---|--|--|--|--|
532
+ | | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | |
533
+ | 1..4 | File length | | | | | | | | | | | |
534
+ | 5..8 | Header length | | | | | | | | | | | |
535
+ | 9 | High Release Identifier | | | | High Version Identifier | | | | | | | |
536
+ | 10 | Low Release Identifier | | | | Low Version Identifier | | | | | | | |
537
+ | 11..14 | File opening timestamp | | | | | | | | | | | |
538
+ | 15..18 | Timestamp when last CDR was appended to file | | | | | | | | | | | |
539
+ | 19..22 | Number of CDRs in file | | | | | | | | | | | |
540
+ | 23..26 | File sequence number | | | | | | | | | | | |
541
+ | 27 | File Closure Trigger Reason | | | | | | | | | | | |
542
+ | 28..47 | IP Address of Node that generated file | | | | | | | | | | | |
543
+ | 48 | Lost CDR indicator | | | | | | | | | | | |
544
+ | 49..50 | Length of CDR routing filter | | | | | | | | | | | |
545
+ | 51..xy | CDR routing filter | | | | | | | | | | | |
546
+ | xy+1..xy+2 | Length of Private Extension | | | | | | | | | | | |
547
+ | xy+3..n | Private Extension | | | | | | | | | | | |
548
+ | n+1 | High Release Identifier extension | | | | | | | | | | | |
549
+ | n+2 | Low Release Identifier extension | | | | | | | | | | | |
550
+
551
+ The following subclauses specify the contents and encoding of the CDR file header fields. Unless otherwise specified in the subclauses below, all parameters are mandatory and shall always be included in a CDR file header.
552
+
553
+ #### 6.1.1.1 File length
554
+
555
+ The "file length" parameter contains a binary value that identifies the total length of the CDR file in octets, including the file header and the total CDR payload length.
556
+
557
+ The value with all bits set to "1" is reserved for future extensions (e.g. for CDR files longer than that value) and shall therefore not be used.
558
+
559
+ #### 6.1.1.2 Header length
560
+
561
+ The "header length" parameter contains a binary value that identifies the total length of the CDR file header in octets.
562
+
563
+ The value with all bits set to "1" is reserved for future extensions (e.g. for CDR file headers longer than that value) and shall therefore not be used.
564
+
565
+ #### 6.1.1.3 High release / version identifier
566
+
567
+ This field is a copy of octet 3 of the CDR header. It is copied from the CDR where the equation:
568
+
569
+ $$\text{Release Identifier} * 100 + \text{Version Identifier}$$
570
+
571
+ For Rel-10 and higher this equation shall be used:
572
+
573
+ $$(\text{Release Identifier} + \text{Release Identifier Extension} + 1) * 100 + \text{Version Identifier}$$
574
+
575
+ yields the highest result of all CDRs in the file. The representation of Release Identifier and Version Identifier in this field is the same as in octet 3 of the CDR header. For Rel-10 and higher, i.e with High Release Identifier field set to value "7", the release identifier is included in "High Release Identifier extension" field.
576
+
577
+ #### 6.1.1.4 Low release / version identifier
578
+
579
+ This field is a copy of octet 3 of the CDR header. It is copied from the CDR where the equation:
580
+
581
+ $$\text{Release Identifier} * 100 + \text{Version Identifier}$$
582
+
583
+ For Rel-10 and higher this equation shall be used:
584
+
585
+ $$(\text{Release Identifier} + \text{Release Identifier Extension} + 1) * 100 + \text{Version Identifier}$$
586
+
587
+ yields the lowest result of all CDRs in the file. The representation of Release Identifier and Version Identifier in this field is the same as in octet 3 of the CDR header. For Rel-10 and higher, i.e with Low Release Identifier field set to value "7", the release identifier is included in "Low Release Identifier extension" field.
588
+
589
+ #### 6.1.1.5 File opening timestamp
590
+
591
+ These parameters indicate the time when the file was opened, according to the following binary format:
592
+
593
+ - The first four binary bits indicate the month (1 .. 12), according to the CGF's local time zone;
594
+ - The next five binary bits contain the date (1 :: 31), according to the CGF's local time zone;
595
+ - The next five binary bits contain the hour (0 .. 23), according to the CGF's local time zone;
596
+ - The next six binary bits contain the minute (0 .. 59), according to the CGF's local time zone;
597
+ - The next bit indicates the sign of the local time differential from UTC (bit set to "1" expresses "+" or bit set to "0" expresses "-" time deviation), in case the time differential to UTC is 0 then the sign may be arbitrarily set to "+" or "-";
598
+ - The next five binary bits contain the hour (0 .. 23) deviation of the local time towards UTC, according to the CGF's local time zone;
599
+ - The next six binary bits contain the minute (0 .. 59) deviation of the local time towards UTC, according to the CGF's local time zone;
600
+
601
+ Note that the CDR file name contains detailed date and time information related to file closure (cf. clause 6.2)
602
+
603
+ #### 6.1.1.6 Last CDR append timestamp
604
+
605
+ This parameter is formatted the same as in 6.1.1.5, and indicates the time when the last CDR was appended to the file in UTC format. In case of an empty file (i.e. no CDRs included), the value of the parameter is "0".
606
+
607
+ #### 6.1.1.7 Number of CDRs in file
608
+
609
+ This parameter contains a binary value that specifies the total number of CDRs that are included in the file.
610
+
611
+ The value with all bits set to "1" is reserved for future extensions (e.g. for CDR files containing more CDRs than represented by that value) and shall therefore not be used.
612
+
613
+ #### 6.1.1.8 File sequence number
614
+
615
+ This parameter is a value in binary that contains a running number of the CDR file generated by the same CGF. The first file of a CGF is indicated by the value "0". When the maximum number of file is reached (all bits set to "1"), the sequence shall be restarted with "0".
616
+
617
+ #### 6.1.1.9 File Closure Trigger Reason
618
+
619
+ The file closure reason provides a means to determine the reason that the file was closed by the CGF. It is encoded as a single octet as follows.
620
+
621
+ Normal closure reasons (Binary values 0 to 127):
622
+
623
+ - 0 = Normal closure (Undefined normal closure reason).
624
+ - 1 = File size limit reached (OA&M configured).
625
+ - 2 = File open-time limit reached (OA&M configured).
626
+ - 3 = Maximum number of CDRs in file reached (OA&M configured).
627
+ - 4 = File closed by manual intervention.
628
+ - 5 = CDR release, version or encoding change.
629
+ - 6 to 127 are reserved for future use.
630
+
631
+ Abnormal closure reasons (Binary values 128 to 255):
632
+
633
+ - 128 = Abnormal file closure (Undefined error closure reason).
634
+ - 129 = File system error.
635
+ - 130 = File system storage exhausted.
636
+ - 131 = File integrity error.
637
+ - 132 to 255 are reserved for future use.
638
+
639
+ #### 6.1.1.10 Node IP address
640
+
641
+ This parameter indicates the IP address of the CGF generating the file. For both IPv4 and IPv6 CGF addresses, the parameter is encoded in IPv6 representation. The first four bytes of the parameter, which are preceding this IPv6 address, are insignificant, e.g. filled with 'FF'.
642
+
643
+ #### 6.1.1.11 Lost CDR indicator
644
+
645
+ This parameter indicates if and how many CDRs were lost during their processing in the CGF (cf. clause 5.1.1). The term "lost" implies that the CDR(s) could not be placed into the destination file due to irrecoverable errors.
646
+
647
+ Due to the possibility that the irrecoverable CDR errors may have impacted CDR parameters that are relevant for CDR routing, it is possible that the CGF cannot determine for a particular file whether CDRs have been lost. Appropriate indication shall be given according to the following encoding of the "lost CDR indicator".
648
+
649
+ - MSB bit "0", all other bits "0": no CDRs have been lost;
650
+
651
+ - MSB bit "0", all other bits set to a value corresponding to decimal 1 to decimal 126: CGF has identified that a number of CDRs corresponding to the value of the lower 7 bits were lost, while it is unknown whether more CDRs were lost;
652
+ - MSB bit "0", all other bits set to "1": CGF has identified that 127 or more CDRs were lost, while it is unknown whether more CDRs were lost;
653
+ - MSB bit "1", all other bits "0": CDRs have been lost but CGF cannot determine the number of lost CDRs;
654
+ - MSB bit "1", all other bits set to a value corresponding to decimal 1 to decimal 126: CGF has calculated the number of lost CDRs as indicated in the value of the lower 7 bits;
655
+ - MSB bit "1", all other bits set to "1": CGF has calculated the number of lost CDRs to be 127 or more.
656
+
657
+ #### 6.1.1.12 Length of CDR routeing filter
658
+
659
+ This parameter contains a binary value that specifies the length of the subsequent CDR routeing filter in octets. The value excludes the two octets of the "length" parameter itself.
660
+
661
+ The value of "65535" (all bits set to "1") is reserved for future extensions (e.g. for CDR routeing filters longer than 65534 octets) and shall therefore not be used.
662
+
663
+ #### 6.1.1.13 CDR routeing filter
664
+
665
+ This parameter indicates the filter that determined the routeing of CDRs into this file. Its encoding is vendor specific.
666
+
667
+ #### 6.1.1.14 Length of private extension
668
+
669
+ This parameter contains a binary value that specifies the length of the subsequent "private extension" field in octets. It is present only if a private extension field is included in the CDR file header. Its value excludes the two octets of the "length" parameter itself.
670
+
671
+ The value of "65535" (all bits set to "1") is reserved for future extensions (e.g. for private extensions longer than 65534 octets) and shall therefore not be used.
672
+
673
+ #### 6.1.1.15 Private extension
674
+
675
+ This optional field contains a vendor specific private extension to the CDR file header, if any. Its encoding, if present, is vendor specific.
676
+
677
+ #### 6.1.1.16 High release identifier extension
678
+
679
+ This eight bit field contains a binary value that identifies the 3GPP Release of the TS 32.298 [51] for High Release Identifier beyond Rel-9: the representation of High Release Identifier in this field is the same as in Octet 5 of CDR header.
680
+
681
+ This field shall be present only when "High Release Identifier" field is set with value "7" (all bits set to "1").
682
+
683
+ #### 6.1.1.17 Low release identifier extension
684
+
685
+ This eight bit field contains a binary value that identifies the 3GPP Release of the TS 32.298 [51] for Low Release Identifier beyond Rel-9: the representation of Low Release Identifier in this field is the same as in Octet 5 of CDR header.
686
+
687
+ This field shall be present only when "Low Release Identifier" field is set with value "7" (all bits set to "1").
688
+
689
+ ### 6.1.2 CDR header format
690
+
691
+ The exact format of the CDR header is given in table 6.1.2.
692
+
693
+ **Table 6.1.2: Format of CDR Header**
694
+
695
+ | Octets | Bits | | | | | | | |
696
+ |--------|------------------------------|---|---|---|--------------------|---|---|---|
697
+ | | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 |
698
+ | 1..2 | CDR length | | | | | | | |
699
+ | 3 | Release Identifier | | | | Version Identifier | | | |
700
+ | 4 | Data Record Format | | | | TS number | | | |
701
+ | 5 | Release Identifier extension | | | | | | | |
702
+
703
+ The following subclauses specify the contents and encoding of the CDR header fields.
704
+
705
+ The CDR header is 4 octets or 5 octets length: presence the Release Identifier extension octet depends on Release Identifier value.
706
+
707
+ #### 6.1.2.1 CDR length
708
+
709
+ This two octet field contains a binary value that specifies the length of the subsequent CDR, excluding the header octets. The value of "65535" (all bits set to "1") in the CDR length field implies that it is reserved for future extensions and shall therefore not be used.
710
+
711
+ #### 6.1.2.2 Release Identifier
712
+
713
+ This three bit field contains a binary value that identifies the 3GPP Release of the Technical Specification indicated in "TS number" (see clause 6.1.2.5). Its value is set / used according to the following rules:
714
+
715
+ **Table 6.1.2.2: Release Identifier**
716
+
717
+ | Release Identifier (3 bits) | 3GPP Release | Indicates 3GPP "TS number" for the release | Comment |
718
+ |-----------------------------|--------------|--------------------------------------------------------------------------------------|----------------------------------------|
719
+ | "0" | Rel-99 | 32.005 or 32.015 | this parameter shall be ignored |
720
+ | "1" | Rel-4 | 32.205, 32.215 or 32.235 | |
721
+ | "2" | Rel-5 | 32.205, 32.215, 32.225 or 32.235 | |
722
+ | "3" | Rel-6 | 32.250, 32.251, 32.252, 32.260, 32.270, 32.271, 32.272 or 32.273 | |
723
+ | "4" | Rel-7 | 32.250, 32.251, 32.252, 32.260, 32.270, 32.271, 32.272 or 32.273 | |
724
+ | "5" | Rel-8 | 32.250, 32.251, 32.252, 32.260, 32.270, 32.271, 32.272 , 32.273 or 32.275 | |
725
+ | "6" | Rel-9 | 32.250, 32.251, 32.252, 32.260, 32.270, 32.271, 32.272 , 32.273, 32.274 or 32.275 | |
726
+ | "7" | Beyond Rel-9 | The 3GPP Release for "TS number" is included in "Release Identifier extension" field | this parameter is used as an indicator |
727
+
728
+ #### 6.1.2.3 Version Identifier
729
+
730
+ This five bit field contains a binary value that identifies the version of the TS 32.298 [51]. Its value corresponds to the middle digit of the version number of that TS, as indicated on the TS cover sheet.
731
+
732
+ #### 6.1.2.4 Data Record Format
733
+
734
+ This three bit field contains a binary value that identifies the CDR encoding according to the following table:
735
+
736
+ - "1" signifies the use of Basic Encoding Rules (BER);
737
+ - "2" signifies the use of unaligned basic Packed Encoding Rules (PER);
738
+ - "3" signifies the use of aligned basic Packed Encoding Rules (PER);
739
+ - "4" signifies the use of XML Encoding Rules (XER).
740
+
741
+ #### 6.1.2.5 TS number
742
+
743
+ This five bit field contains a binary value that identifies the number of the TS associated to the domain CDRs encoding according to table 6.1.2.5:
744
+
745
+ **Table 6.1.2.5: "TS number" Identifier**
746
+
747
+ | "TS number" Identifier (5 bits) | TS number |
748
+ |---------------------------------|-----------|
749
+ | 0 | 32.005 |
750
+ | 1 | 32.015 |
751
+ | 2 | 32.205 |
752
+ | 3 | 32.215 |
753
+ | 4 | 32.225 |
754
+ | 5 | 32.235 |
755
+ | 6 | 32.250 |
756
+ | 7 | 32.251 |
757
+ | 8 | 32.252 |
758
+ | 9 | 32.260 |
759
+ | 10 | 32.270 |
760
+ | 11 | 32.271 |
761
+ | 12 | 32.272 |
762
+ | 13 | 32.273 |
763
+ | 14 | 32.275 |
764
+ | 15 | 32.274 |
765
+ | NOTE: 16-31 are for future use. | |
766
+
767
+ #### 6.1.2.6 Release Identifier extension
768
+
769
+ This eight bit field contains a binary value that identifies the 3GPP Release of the TS 32.298 [51], for Releases beyond Rel-9. Its value is set / used according to the following rules:
770
+
771
+ **Table 6.1.2.6: Release Identifier extension**
772
+
773
+ | Release Identifier (8 bits) | 3GPP Release | Comment |
774
+ |--------------------------------------------------------------------------------------------------------|--------------|---------|
775
+ | "0" | Rel-10 | |
776
+ | "1" | Rel-11 | |
777
+ | NOTE: Additional "Release Identifier extension" value incremented by "1" indicates subsequent releases | | |
778
+
779
+ This field shall be present only when "release identifier" field is set with value "7" (all bits set to "1").
780
+
781
+ ## 6.2 CDR file naming convention
782
+
783
+ The file naming convention ensures that CDR file names are unique among a large number of CGF nodes over an extended period of time (at least several months). In order to accomplish this requirement, the file name includes the following information:
784
+
785
+ <NodeID> \_ - <RC>.<date> \_ - <time>[.<PI>][.<FE>]
786
+
787
+ - 1) NodeID. This is the name of the CGF that generated the file. When the CGF is integrated in another node (see 3GPP TS 32.240 [1]), then this parameter contains the NodeID of the node that the CGF is integrated in.
788
+ - 2) The RC parameter is a running count, starting with the value of "1". Note that the delimiter preceding this field is made up of an underscore character (\_), followed by a minus character (-), followed by another underscore character (-).
789
+ - 3) The "date" field indicates in ASCII, the date when the CDR file was closed. It is of the form YYYYMMDD, where:
790
+ - YYYY is the year in four-digit notation;
791
+ - MM is the month in two digit notation (01 - 12);
792
+ - DD is the day in two-digit notation (01 - 31).
793
+
794
+ Note that this field is preceded by a point (.) character as delimiter.
795
+
796
+ - 4) The "time" field indicates in ASCII, the time when the CDR file was closed. It is of the form HHMMshhmm, where:
797
+ - HH is the two-digit hour of the day (local time), based on 24-hour clock (00 - 23);
798
+ - MM is the two digit minute of the hour (local time);
799
+ - s is in ASCII, the sign of the local time differential from UTC (+ or -), in case the time differential to UTC is 0 then the sign may be arbitrarily set to "+" or "-";
800
+ - hh is the two-digit number of hours of the local time differential from UTC (00-23);
801
+ - mm is the two digit number of minutes of the local time differential from UTC (00-59).
802
+
803
+ Note that the delimiter preceding this field is made up of an underscore character (\_), followed by a minus character (-), followed by another underscore character (-).
804
+ - 5) Optional private information. The content of this field is implementation specific. This field, if present, is preceded by a point (.) character delimiter.
805
+ - 6) Optional file extension. The content of this field is implementation specific. This field, if present, is preceded by a point (.) character delimiter.
806
+
807
+ Some examples describing file-naming convention (note that the quotation marks do not form part of the file name):
808
+
809
+ - 1) file name: "CGFNodeId\_-\_1234.20050401\_-\_2315+0200",
810
+ meaning: file #1234 produced by CGF <CGFNodeId> on April 1, 2005 at 23:15 local time, with a time differential of +2 hours against UTC.
811
+ - 2) file name: "CGFNodeId\_-\_44.20051224\_-\_1700-1130.thankgoditschristmas.abc",
812
+ meaning: file #44 produced by CGF <CGFNodeId> on December 24, 2005 at 17:00 local time, with a time differential of -11:30 hours against UTC, private information "thankgoditschristmas" and extension "abc".
813
+ - 3) file name: "CGFNodeId\_-\_44.20051224\_-\_1700-1130..abc",
814
+ meaning: same file as 2) above but this time without private extension. Note that there are two point characters (.) preceding the file extension due to the missing (=empty) private extension.
815
+
816
+ There shall be a configurable base directory on the CGF which contains one or more subdirectories that contain all CDR files that are ready for transfer to the BD. Further details of the directory structure on the CGF for the storage of CDR files are implementation specific.
817
+
818
+ ## 6.3 Detailed FTP transfer and session management procedures
819
+
820
+ The detailed FTP transfer and session management procedures are out of scope of the current 3GPP release. However the following items should be considered in actual implementations.
821
+
822
+ - FTP client behaviour;
823
+ - FTP server role;
824
+ - File transfer triggers;
825
+ - Each of the above in relation to push and pull modes.
826
+
827
+ ## 6.4 Error handling
828
+
829
+ The detailed error handling on the CGF is out of scope of the current 3GPP release. However the following items should be considered in actual implementations.
830
+
831
+ - Replacement of invalid CDR parameters;
832
+ - Handling of irrecoverable CDRs;
833
+ - System dependent failures (file system full, etc.);
834
+
835
+ - File transfer failure in relation to
836
+ - Pull mode;
837
+ - Push mode.
838
+
839
+ # --- Annex A (informative): Bibliography
840
+
841
+ ## **a) The 3GPP charging specifications**
842
+
843
+ - 3GPP TS 32.274: "Telecommunication management; Charging management; Short Message Service (SMS) charging".
844
+ - 3GPP TS 32.275: "Telecommunication management; Charging management; MultiMedia Telephony (MMTel) charging".
845
+ - 3GPP TS 32.280: "Telecommunication management; Charging management; Advice of Charge (AoC) service".
846
+
847
+ ## **b) Common 3GPP specifications**
848
+
849
+ - TS 22.101: "Service aspects; Service Principles".
850
+ - TS 22.115: "Service aspects; Charging and billing".
851
+ - TS 23.002: "Network Architecture".
852
+ - TS 23.003: "Numbering, addressing and identification".
853
+ - TS 27.001: "General on Terminal Adaptation Functions (TAF) for Mobile Stations (MS)".
854
+
855
+ ## **c) other Domain and Service specific 3GPP / ETSI specifications**
856
+
857
+ -
858
+
859
+ ## **d) Relevant ITU Recommendations**
860
+
861
+ - ITU-T Recommendation D.93: "Charging and accounting in the international land mobile telephone service (provided via cellular radio systems)".
862
+ - ITU-T Recommendation E.164: "The international public telecommunication numbering plan".
863
+ - ITU-T Recommendation Q.767: "Application of the ISDN user part of CCITT signalling System No.7 for international ISDN interconnections".
864
+ - ITU-T Recommendation X.25: "Interface between Data Terminal Equipment (DTE) and Data Circuit-terminating Equipment (DCE) for terminals operating in the packet mode and connected to public data networks by dedicated circuit".
865
+ - ITU-T Recommendation X.121: "International numbering plan for public data networks".
866
+
867
+ ## **e) Relevant IETF RFCs**
868
+
869
+ - IETF RFC 3588 (2003): "Diameter base protocol"
870
+ - IETF Internet-Draft "Diameter Credit Control Application"
871
+ - IETF RFC 1350: "The TFT Protocol (Revision 2)"
872
+
873
+ # Annex B (informative): Change history
874
+
875
+ | Change history | | | | | | | | |
876
+ |----------------|-------|-----------|------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|------|--------|--------|
877
+ | Date | TSG # | TSG Doc. | CR | R ev | Subject/Comment | Ca t | Old | New |
878
+ | Jun 2003 | SP-20 | SP-030273 | -- | -- | Submitted to TSG SA#20 for Information | -- | 1.0.0 | -- |
879
+ | Mar 2004 | SP-23 | SP-040142 | -- | -- | Submitted to TSG SA#23 for Approval | -- | 2.0.0 | 6.0.0 |
880
+ | Jun 2005 | SP-28 | SP-050272 | 0001 | 1 | Corrections, alignments and additions to complete remaining technical gaps | C | 6.0.0 | 6.1.0 |
881
+ | Sep 2006 | SP-33 | SP-060526 | 0003 | -- | Correct field descriptions to the appropriate formats that represent binary | F | 6.1.0 | 6.2.0 |
882
+ | Sep 2006 | SP-33 | SP-060544 | 0004 | -- | Add optional solution set for the Bx reference point to fulfil the ITU-T requirement on CDR file transfer with IPDR in context of NGN Accounting (FBI-TISP2-CH) | B | 6.2.0 | 7.0.0 |
883
+ | Mar 2008 | SP-39 | SP-080190 | 0005 | 2 | Correction of errors and inconsistencies - Align with 32.240 | F | 7.0.0 | 7.1.0 |
884
+ | Sep 2008 | SP-41 | SP-080466 | 0006 | - | Clarification on EPC Charging | B | 7.1.0 | 8.0.0 |
885
+ | Sep 2008 | SP-41 | SP-080462 | 0007 | - | Alignment on Bx interface | D | 7.1.0 | 8.0.0 |
886
+ | Dec 2008 | SP-42 | SP-080706 | 0008 | - | TS 32.297 evolution for Rel-8 | B | 8.0.0 | 8.1.0 |
887
+ | Jun 2009 | SP-44 | SP-090293 | 0009 | - | Correction on length of Node IP Address | F | 8.1.0 | 8.2.0 |
888
+ | Dec 2009 | - | - | - | - | Update to Rel-9 version (MCC) | - | 8.2.0 | 9.0.0 |
889
+ | Mar 2011 | SP-51 | SP-110109 | 0010 | 1 | Release considerations beyond Release 9 for CDR headers | C | 9.0.0 | 10.0.0 |
890
+ | Sep 2011 | SP-53 | SP-110530 | 0011 | 1 | Correction of the release/version identifier in CDR file header format | F | 10.0.0 | 10.1.0 |
891
+ | Dec 2011 | SP-54 | SP-110710 | 0012 | - | Correction of the high/low release identifier in CDR file header format | F | 10.1.0 | 10.2.0 |
892
+ | Dec 2011 | SP-54 | SP-110710 | 0013 | - | Correction on CDR header format | F | 10.1.0 | 10.2.0 |
893
+
marked/Rel-10/32_series/32300/raw.md ADDED
@@ -0,0 +1,929 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+ # **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; Configuration Management (CM); Name convention for Managed Objects (Release 10)** ---
4
+
5
+ ![3GPP logo with TM symbol](935eed7aa61f7777f62cfc032e11bee9_img.jpg)
6
+
7
+ The 3GPP logo, featuring the letters '3GPP' in a stylized font. The '3' is bold and black, the 'G' is black, the 'P' is black, and the 'P' is black. A small red signal icon is positioned below the 'G'. A 'TM' symbol is located to the upper right of the 'P'.
8
+
9
+ 3GPP logo with TM symbol
10
+
11
+ Keywords
12
+ UMTS, Management
13
+
14
+ **3GPP**
15
+
16
+ Postal address
17
+
18
+ ---
19
+
20
+ 3GPP support office address
21
+
22
+ ---
23
+
24
+ 650 Route des Lucioles - Sophia Antipolis
25
+ Valbonne - FRANCE
26
+ Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
27
+
28
+ Internet
29
+
30
+ ---
31
+
32
+ <http://www.3gpp.org>
33
+
34
+ ![LTE logo with 'ADVANCED' text above the 'e' and a signal icon above the 'l'.](1211e36d120f0d2912a745437f4c8f19_img.jpg)
35
+
36
+ The logo for LTE (Long Term Evolution) is displayed. It features the letters 'lte' in a bold, lowercase font. Above the 'e' is the word 'ADVANCED' in a smaller, uppercase font. Above the 'l' is a red signal icon consisting of four curved lines of increasing height. A small 'TM' trademark symbol is located to the right of the 'e'.
37
+
38
+ LTE logo with 'ADVANCED' text above the 'e' and a signal icon above the 'l'.
39
+
40
+ # **Copyright Notification**
41
+
42
+ No part may be reproduced except as authorized by written permission.
43
+ The copyright and the foregoing restriction extend to reproduction in all media.
44
+
45
+ © 2011, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TTA, TTC).
46
+ All rights reserved.
47
+
48
+ UMTS™ is a Trade Mark of ETSI registered for the benefit of its members
49
+ 3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
50
+ LTE™ is a Trade Mark of ETSI currently being registered for the benefit of its Members and of the 3GPP Organizational Partners
51
+ GSM® and the GSM logo are registered and owned by the GSM Association
52
+
53
+ **3GPP**
54
+
55
+ # Contents
56
+
57
+ | | |
58
+ |------------------------------------------------------------------------------------------------|-----------|
59
+ | Foreword ..... | 4 |
60
+ | Introduction ..... | 4 |
61
+ | 1 Scope..... | 6 |
62
+ | 2 References..... | 6 |
63
+ | 3 Definitions and abbreviations ..... | 7 |
64
+ | 3.1 Definitions..... | 7 |
65
+ | 3.1.1 Void ..... | 7 |
66
+ | 3.1.2 Void ..... | 7 |
67
+ | 3.1.3 Managed Object and Network Resource ..... | 7 |
68
+ | 3.1.4 Name..... | 7 |
69
+ | 3.1.5 Name space..... | 7 |
70
+ | 3.1.6 Global Root and Local Root..... | 8 |
71
+ | 3.1.7 Distinguished Name and Relative Distinguished Name ..... | 8 |
72
+ | 3.2 Abbreviations ..... | 8 |
73
+ | 4 System overview ..... | 9 |
74
+ | 4.1 System context ..... | 9 |
75
+ | 5 Name Convention for Managed Objects..... | 9 |
76
+ | 6 Representations of Distinguished Name (DN)..... | 10 |
77
+ | 7 String Representation of DN..... | 11 |
78
+ | 7.A Overview ..... | 11 |
79
+ | 7.B Allowed character sets ..... | 11 |
80
+ | 7.1 Converting DN from ASN.1 to String ..... | 11 |
81
+ | 7.1.1 Rule for one-string DN..... | 11 |
82
+ | 7.1.1.1 Converting RDNSequence ..... | 11 |
83
+ | 7.1.1.2 Converting RelativeDistinguishedName ..... | 12 |
84
+ | 7.1.1.3 Converting AttributeTypeAndValue ..... | 12 |
85
+ | 7.1.2 Rule for multi-string DN ..... | 12 |
86
+ | 7.1.2.1 Converting RDNSequence ..... | 12 |
87
+ | 7.1.2.2 Converting RelativeDistinguishedName ..... | 12 |
88
+ | 7.1.2.3 Converting AttributeTypeAndValue ..... | 12 |
89
+ | 7.2 Character syntax..... | 13 |
90
+ | 7.3 EBNF of DN String Representation..... | 13 |
91
+ | 7.4 Maximum size of DN string..... | 16 |
92
+ | 8 Examples of DN in string representation..... | 17 |
93
+ | 9 Usage Scenario..... | 18 |
94
+ | 9.1 DN prefix usage ..... | 18 |
95
+ | <b>Annex A (normative): Mapping of RDN AttributeType to Strings.....</b> | <b>19</b> |
96
+ | <b>Annex B (normative): Rule for MO Designers regarding AttributeType interpretation .....</b> | <b>20</b> |
97
+ | <b>Annex C (informative): DN Prefix and Local Distinguished Name (LDN) .....</b> | <b>22</b> |
98
+ | <b>Annex D (informative): Interpreting EBNF [13] .....</b> | <b>24</b> |
99
+ | <b>Annex E (informative): IOC/MOC name recommendation .....</b> | <b>26</b> |
100
+ | <b>Annex F (informative): Change history.....</b> | <b>27</b> |
101
+
102
+ # --- Foreword
103
+
104
+ This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP).
105
+
106
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
107
+
108
+ Version x.y.z
109
+
110
+ where:
111
+
112
+ - x the first digit:
113
+ - 1 presented to TSG for information;
114
+ - 2 presented to TSG for approval;
115
+ - 3 or greater indicates TSG approved document under change control.
116
+ - y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
117
+ - z the third digit is incremented when editorial only changes have been incorporated in the document.
118
+
119
+ ## --- Introduction
120
+
121
+ Configuration Management (CM), in general, provides the operator with the ability to assure correct and effective operation of the 3G network as it evolves. CM actions have the objective to control and monitor the actual configuration on the Network Elements (NEs) and Network Resources (NRs), and they may be initiated by the operator or by functions in the Operations Systems (OSs) or NEs.
122
+
123
+ CM actions may be requested as part of an implementation programme (e.g. additions and deletions), as part of an optimisation programme (e.g. modifications), and to maintain the overall Quality of Service (QoS). The CM actions are initiated either as single actions on single NEs of the 3G network, or as part of a complex procedure involving actions on many resources/objects in one or several NEs.
124
+
125
+ ## Background
126
+
127
+ Traditionally, multiple name conventions have been used by different vendors' NEs, or even within the same vendor, to name network resources. The following problems have thus arisen:
128
+
129
+ - Different classes of NE have used different name conventions. Network Management applications, when interfacing with these NEs, have been required to understand multiple name conventions to manage the NEs.
130
+ - Network management applications (e.g. Fault Management application), when interfacing with other applications (e.g. Configuration Management application, trouble ticket system) have been required to understand multiple name conventions.
131
+ - When a customer purchased multiple classes of NEs from the same or different vendors, the customer was confronted with multiple name conventions.
132
+ - Without a name convention, it is difficult to integrate IRP conformant vendors' resource name space (see subclause 3.1.5 for definition of name space) into the customer's Enterprise name space.
133
+
134
+ ## Benefits
135
+
136
+ The benefits of using the subject name convention to name 3G network resources for network management purposes are as follows:
137
+
138
+ - A resource name is guaranteed to be unambiguous in that it refers to, at most, one network resource. Unambiguous naming of managed network resources is necessary for interoperability among managing applications and systems.
139
+
140
+ - The resource name syntax is specified such that management applications can be designed with assurance that its name-parsing algorithm needs not be modified in the future. We can derive this benefit only if the subject name convention is widely accepted.
141
+
142
+ The root and upper portions of the name hierarchy are based on name infrastructure of Domain Name System (DNS) (see IETF RFC 2247 [5]). The subject name convention can naturally fit in DNS and can integrate well with other hierarchical naming systems, such as ITU-T Recommendation X.500 [2].
143
+
144
+ # --- 1 Scope
145
+
146
+ A more detailed background and introduction of the IRP concept is given in 3GPP TS 32.150 [16].
147
+
148
+ To perform network management tasks, co-operating applications require identical interpretation of names assigned to network resources under management. Such names are required to be unambiguous as well. The present document recommends one name convention for network resources under management in the IRP context.
149
+
150
+ To facilitate integration of network management information obtained via multiple IRPs based on different IRP Solution Set technologies, identical network resource name semantics shall be conveyed in all IRPs. The present document specifies one such name convention.
151
+
152
+ The present document also specifies an IOC/MOC name recommendation (see annex E) in order to avoid potential problems with valid characters in some programming languages.
153
+
154
+ # --- 2 References
155
+
156
+ The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
157
+
158
+ - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
159
+ - For a specific reference, subsequent revisions do not apply.
160
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
161
+
162
+ - [1] Void.
163
+ - [2] ITU-T Recommendation X.500 (1993): "Information technology - Open Systems Interconnection - The Directory: Overview of concepts, models and services".
164
+ - [3] T. Howes, ISBN 1-57870-070-1: "Understanding and Deploying LDAP Directory Services".
165
+ - [4] IETF RFC 1737 (1994): "Functional Requirements for Uniform Resource Names".
166
+ - [5] IETF RFC 2247 (1998): "Using Domains in LDAP/X.500 Distinguished Names".
167
+ - [6] IETF RFC 1035 (1987): "Domain names - implementation and specification".
168
+ - [7] IETF RFC 2253 (1997): "Lightweight Directory Access Protocol (v3): UTF-8 String Representation of Distinguished Names".
169
+ - [8] 3GPP TS 32.111-2: "Telecommunication management; Fault Management; Part 2: Alarm Integration Reference Point (IRP): Information Service (IS)".
170
+ - [9] 3GPP TS 32.622: " Telecommunication management; Configuration Management (CM); Generic network resources Integration Reference Point (IRP): Network Resource Model (NRM)".
171
+ - [10] Void.
172
+ - [11] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements".
173
+ - [12] 3GPP TS 32.102: "Telecommunication management; Architecture".
174
+ - [13] ISO/IEC 14977: "Information technology – Syntactic metalanguage – Extended BNF".
175
+ - [14] ISO/IEC 646: "Information technology – ISO 7-bit coded character set for information interchange".
176
+ - [15] ISO/IEC 10646: "Information technology – Universal multiple-octet Coded Character Set (UCS)".
177
+
178
+ - [16] 3GPP TS 32.150: "Integration Reference Point (IRP) Concept and definitions".
179
+ - [17] 3GPP2 S.S0028-E "OAM&P for cdma2000 (Overview, 3GPP R7 Delta Specification, 3GPP2 Network Resource Model IRP)"
180
+ - [18] MEF Technical Specification MEF 7.1, Phase 2 EMS-NMS Information Model, October 2009
181
+ - [19] ATM Forum, Technical Committee, Network Management, M4 Network View CMIP MIB Specification
182
+
183
+ # 3 Definitions and abbreviations
184
+
185
+ ## 3.1 Definitions
186
+
187
+ For the purposes of the present document, the terms and definitions given in 3GPP TS 32.101 [11], 3GPP TS 32.102 [12] and 3GPP TS 32.150 [16] apply. This subclause defines terms essential for understanding of name convention in the IRP context.
188
+
189
+ ### 3.1.1 Void
190
+
191
+ ### 3.1.2 Void
192
+
193
+ ### 3.1.3 Managed Object and Network Resource
194
+
195
+ In the context of the present document, a Managed Object (MO) is a software object that encapsulates the manageable characteristics and behaviour of a particular network resource. Examples of network resource are switch, scanner for monitoring performance data, cell, site, transmission links, satellite, operator profile, etc. In the present document, MO sometimes is referred to as MO instance.
196
+
197
+ ### 3.1.4 Name
198
+
199
+ In the context of the present document, a name is restricted to the identification of a MO, that is, a software object representing a real network resource.
200
+
201
+ ### 3.1.5 Name space
202
+
203
+ A name space is a collection of names. This name convention uses a hierarchical containment structure, including its simplest form - the one-level, flat name space. This name convention does not support an arbitrarily connected name space, or graph structure, in which a named object can be both child and parent of another named object. Figure 1 shows some examples of supported and unsupported name spaces (this figure is from T. Howes, ISBN 1-57870-070-1 [3] and it provides useful information on name space design).
204
+
205
+ ![Figure 1: Examples of supported and unsupported name spaces. The diagram shows four examples: 'Supported' (a tree structure and a vertical chain), and 'Unsupported' (a triangle and a circle with a self-loop).](06da11ab76cacc38bbcd714e437797ea_img.jpg)
206
+
207
+ The diagram illustrates four examples of name space structures:
208
+
209
+ - Supported:**
210
+ - A tree structure with a root node and three child nodes.
211
+ - A vertical chain of four nodes connected in a single path.
212
+ - Unsupported:**
213
+ - A triangle structure where three nodes are all interconnected, forming a cycle.
214
+ - A circle with two nodes, where each node has a self-loop, representing a more complex cycle.
215
+
216
+ Figure 1: Examples of supported and unsupported name spaces. The diagram shows four examples: 'Supported' (a tree structure and a vertical chain), and 'Unsupported' (a triangle and a circle with a self-loop).
217
+
218
+ Figure 1: Examples of supported and unsupported name spaces
219
+
220
+ ### 3.1.6 Global Root and Local Root
221
+
222
+ Names in name space are organised in hierarchy. An MO instance that contains another one is referred to as the superior (parent), whereas the contained MO instance is referred to as the subordinate (child).
223
+
224
+ In modern network management, it is expected that the Enterprise name space be partitioned for implementations in multiple managed system (see annex C for reasons of name space partitioning). The parent of all MO instances in a single managed system is called the Local Root. The ultimate parent of all MO instances of all managed systems is called the Global Root.
225
+
226
+ ### 3.1.7 Distinguished Name and Relative Distinguished Name
227
+
228
+ A Distinguished Name (DN) is used to uniquely identify a MO within a name space. A DN is built from a series of "name components", referred to as Relative Distinguished Names (RDNs). ITU-T Recommendation X.500 [2] defines the concepts of DN and RDN in detail, using ASN.1, in the following way:
229
+
230
+ ```
231
+ DistinguishedName ::= RDNSequence
232
+ RDNSequence ::= SEQUENCE OF RelativeDistinguishedName
233
+ RelativeDistinguishedName ::= SET SIZE (1..MAX) OF AttributeTypeAndValue
234
+ AttributeTypeAndValue ::= SEQUENCE {type AttributeType, value AttributeValue}
235
+ ```
236
+
237
+ The present document references this ASN.1 structure but it only uses single-valued (not multi-valued) RDN.
238
+
239
+ From a DN of a MO, one can derive the DN of its containing MO, if any. This containment relation is the only relation carried by the DN. No other relation can be carried or implied by the DN.
240
+
241
+ See annex B for a rule for MO designers to avoid ambiguity concerning the `AttributeType` of a DN string.
242
+
243
+ See annex C for discussion of DN prefix.
244
+
245
+ ## 3.2 Abbreviations
246
+
247
+ For the purposes of the present document, the following abbreviations apply:
248
+
249
+ | | |
250
+ |-------|---------------------------------------|
251
+ | ASN.1 | Abstract Syntax Notation One |
252
+ | BER | Basic Encoding Rules |
253
+ | CM | Configuration Management |
254
+ | DC | Domain Component |
255
+ | DN | Distinguished Name |
256
+ | DNS | Domain Name Service |
257
+ | EBNF | Extended Backus-Naur Form |
258
+ | FM | Fault Management |
259
+ | IETF | Internet Engineering Task Force |
260
+ | IOC | Information Object Class |
261
+ | IRP | Integration Reference Point |
262
+ | IS | Information Service |
263
+ | LDN | Local Distinguished Name |
264
+ | MO | Managed Object |
265
+ | MOC | Managed Object Class |
266
+ | MOI | Managed Object Instance |
267
+ | NE | Network Element |
268
+ | NR | Network Resource |
269
+ | NRM | Network Resource Model |
270
+ | PM | Performance Management |
271
+ | QoS | Quality of Service |
272
+ | RDN | Relative Distinguished Name |
273
+ | SS | Solution Set |
274
+ | TMN | Telecommunications Management Network |
275
+
276
+ # --- 4 System overview
277
+
278
+ ## 4.1 System context
279
+
280
+ Situations under which MO (representing network resource) names are used are as follows:
281
+
282
+ - a) MO names cross various Integration Reference Points (IRPs).
283
+
284
+ EXAMPLE 1: In the context of Alarm IRP 3GPP TS 32.111-2 [8], IRP Agent notifies IRP Manager of the alarm condition of a network resource. The DN of the MO, representing alarmed network resource, encoded as specified in the present document, is carried in the `Managed Object Instance` parameter of the notification.
285
+
286
+ EXAMPLE 2: In the context of Generic Network Resources IRP: NRM, 3GPP TS 32.622 [9], IRP Agent notifies IRP Manager of the creation of new object. The DN of the newly created object, encoded as specified in the present document, is carried in the notification.
287
+
288
+ EXAMPLE 3: In the context of Generic Network Resources IRP: NRM, 3GPP TS 32.622 [9], IRP Manager requests IRP Agent to search for a particular object by specifying the start point of the search. The DN of the base object, upon which the search begins downward hierarchically, is carried in the request.
289
+
290
+ - b) Co-operating management applications need to exchange information that includes MO (representing network resource) names.
291
+
292
+ EXAMPLE 4: A Fault Management (FM) application may request a trouble ticket system to open a new trouble ticket reporting the alarmed condition of a network resource by specifying, among other things, the MO name representing the alarmed network resource. The DN of the MO, encoded as specified in the present document, is included in the request.
293
+
294
+ EXAMPLE 5: A Performance Management (PM) system that produces reports on performance of network resources. The DNs of the MOs, representing the reported network resources, encoded as specified in the present document, are printed on the report.
295
+
296
+ # --- 5 Name Convention for Managed Objects
297
+
298
+ Network resources shall be named using the naming conventions in ITU-T Recommendation X.500 [2] with one restriction listed below. Central to the X.500 naming convention is the concept of the Distinguished Name (DN) (see subclause 3.1.7).
299
+
300
+ The restriction is that this IRP name convention does not support multi-value RDN. Only single-value RDN is supported.
301
+
302
+ # --- 6 Representations of Distinguished Name (DN)
303
+
304
+ A DN can be encoded and represented in many ways. The present document specifies one representation. Future work on IRP specifications may require the definition(s) of other representation(s)..
305
+
306
+ The DN is encoded using the string representation.
307
+
308
+ The DN string representation encoding scheme:
309
+
310
+ - shall be used for DNs exchanged through all IRP SS technologies,
311
+ - is in itself IRP SS technology neutral, and
312
+ - is subject to IRP SS technology specific handling, such as escaping, if required by such a technology.
313
+
314
+ # 7 String Representation of DN
315
+
316
+ ## 7.A Overview
317
+
318
+ This clause specifies the string representation of DN. This work is based on IETF RFC 2253 [7]. A DN string representation, using the string-encoding scheme specified in the present document, is also a valid DN string according to IETF RFC 2253 [7].
319
+
320
+ The string-encoding scheme specified in the present document imposes further restrictions as compared to IETF RFC 2253 [7]. The most important restrictions are:
321
+
322
+ - Multi-valued RDN is not supported in the subject name convention.
323
+ - Character asterisk is used to denote wildcard in the subject name convention.
324
+
325
+ ## 7.B Allowed character sets
326
+
327
+ Subject to further restrictions described in the following subclauses, the allowed characters for the string representation of DN are:
328
+
329
+ - Characters of ISO/IEC 646 [14] International Reference Version (IRV) coded character set, and
330
+ - Characters of standard coded character sets supporting and extending ISO/IEC 646 [14] IRV coded character set, e.g. ISO/IEC 10646 [15] coded character set.
331
+
332
+ NOTE 1: ISO/IEC 646 [14] IRV coded character set is the international equivalent to the ANSI X3.4 ASCII coded character set.
333
+
334
+ NOTE 2: The character set of ISO/IEC 646 [14] IRV corresponds to the subset of characters that range from U+0000 to U+007F in the character set of ISO/IEC 10646 [15].
335
+
336
+ NOTE 3: The ISO/IEC 646 [14] IRV characters specifically referenced in this specification are further identified using ISO/IEC 10646 [15] character short identifier notation form "U+XXXX".
337
+
338
+ ## 7.1 Converting DN from ASN.1 to String
339
+
340
+ Subclause 7.1.1 defines the algorithm to convert an ASN.1 structured representation to one-string DN representation. Subclause 7.1.2 defines the algorithm to convert an ASN.1 structured representation to multi-string DN representation.
341
+
342
+ CORBA SS uses one-string DN representation. XML SS uses both one-string and multi-string DN representations.
343
+
344
+ ### 7.1.1 Rule for one-string DN
345
+
346
+ #### 7.1.1.1 Converting RDNSequence
347
+
348
+ If the RDNSequence is an empty sequence, the result is the empty or zero length string.
349
+
350
+ Otherwise, the output consists of the string encoding of each RDN in the RDNSequence (according to subclause 7.1.1.2), starting with the first element of the sequence and moving forward toward the last element.
351
+
352
+ The encoding of adjacent RDNs are separated by a comma character (',', U+002C), to be consistent with IETF RFC 2253 [7].
353
+
354
+ White spaces adjacent to the comma character shall be ignored.
355
+
356
+ #### 7.1.1.2 Converting RelativeDistinguishedName
357
+
358
+ When converting from an RDN to a string, the output consists of the string encoding of the singleton `AttributeTypeAndValue` (according to subclause 7.1, i.e. “Multi-valued RDN is not supported in the subject name convention.”).
359
+
360
+ Although ITU-T Recommendation X.500 DN supports multi-valued RDN, this specification supports single-valued RDN only.
361
+
362
+ #### 7.1.1.3 Converting AttributeTypeAndValue
363
+
364
+ The `AttributeTypeAndValue` is encoded as the string representation of the `AttributeType`, followed by an equals sign character ('=', U+003D), followed by the string representation of the `AttributeValue`.
365
+
366
+ Although ITU-T Recommendation X.500 ASN.1 `AttributeValue` and `AttributeType` support wide range of character representation, this specification supports a restrictive set of characters according to subclause 7.2.
367
+
368
+ String representation of `AttributeValue` allows character escape mechanism such as the use of a reverse solidus character ('\, U+005C) followed by two hexadecimal digits to replace a character in a string. String representation of `AttributeType` does not allow character escape mechanism.
369
+
370
+ EXAMPLE: "CN=Before\0DAfter,O=Test,C=GB". In this example, the reverse solidus character and the two hexadecimal digits form a single byte in the code of the escaped character. The reverse solidus character followed by "0D" indicates a carriage return character. See annex B for a rule for MO designers to avoid ambiguity concerning the `AttributeType` of a DN string.
371
+
372
+ ### 7.1.2 Rule for multi-string DN
373
+
374
+ #### 7.1.2.1 Converting RDNSequence
375
+
376
+ If the `RDNSequence` is an empty sequence, there is no equivalent multi-string DN output, i.e. there is no multi-string DN representation for empty `RDNSequence` sequence.
377
+
378
+ Otherwise, the output consists of the string encoding of all RDNs in the `RDNSequence` (according to subclause 7.1.2.2).
379
+
380
+ One RDN encoding is within an NRM class associated XML element. A multiple `RDNSequence` would be converted into multiple RDN encodings, using multiple NRM class associated XML elements. They are arranged in a hierarchy in the XML document. The outer NRM class associated XML element represents the first RDN in the `RDNSequence`.
381
+
382
+ #### 7.1.2.2 Converting RelativeDistinguishedName
383
+
384
+ When converting from an RDN to a string, the output consists of the encoding of the singleton `AttributeTypeAndValue` (according to subclause 7.1, i.e. “Multi-valued RDN is not supported in the subject name convention.”).
385
+
386
+ Although ITU-T Recommendation X.500 DN supports multi-valued RDN, this specification supports single-valued RDN only.
387
+
388
+ #### 7.1.2.3 Converting AttributeTypeAndValue
389
+
390
+ Within an NRM class XML element, there is an element such as `<element name="ManagedElement">` and there is another element `<attribute name="id" type="string" use="required"/>` which is inherited by using `<extension base="xn:NrmClass">`.
391
+
392
+ The `AttributeType` and `AttributeValue` are mapped to the former and latter XML elements. The `AttributeType` carries the IOC name while the `AttributeValue` carries the value of the IOC naming-attribute.
393
+
394
+ Although ITU-T Recommendation X.500 ASN.1 `AttributeValue` and `AttributeType` support wide range of character representation, this specification supports a restrictive set of characters according to subclause 7.2.
395
+
396
+ String representation of `AttributeValue` allows character escape mechanism (see 7.1.1.3).
397
+
398
+ ## 7.2 Character syntax
399
+
400
+ This subclause specifies the character syntax for `AttributeType` and `AttributeValue`.
401
+
402
+ They are:
403
+
404
+ 1. Any character except:
405
+ - comma character (',', U+002C),
406
+ - equals sign character ('=', U+003D),
407
+ - carriage return character (U+000D),
408
+ - line feed character (U+000A),
409
+ - plus sign character ('+', U+002B),
410
+ - less-than sign character ('<', U+003C),
411
+ - greater-than sign character ('>', U+003E),
412
+ - number sign character ('#', U+0023),
413
+ - semicolon character (';', U+003B),
414
+ - reverse solidus character ('\', U+005C),
415
+ - quotation mark character ('"', U+0022).
416
+ 2. The full stop character ('.', U+002E). This character may be used in the `AttributeValue` whose `AttributeType` is "DC". An example is "DC=marketing.CompanyXYZ.com". This full stop character shall not be used in `AttributeType`.
417
+ 3. The asterisk character ('\*', U+002A) is reserved to denote wildcard. Wildcard character(s) can appear in `AttributeType` and `AttributeValue`. The wildcard character can be used to represent one or more characters which are legal in that field (i.e., `attributeType`, `attributeValue`).
418
+
419
+ ## 7.3 EBNF of DN String Representation
420
+
421
+ The formal definitions provided within this subclause consolidate several rules and concepts (null distinguished name, DN prefix, local DN, domain component type, class names starting with upper case characters, attribute names starting with lower case characters, classes with or without an "Id" naming attribute, attribute type and attribute value allowed characters, wildcard character). The definition is more detailed to clarify these naming rules, and will not introduce compliancy issues for implementations compliant with Rel-5 version of this specification.
422
+
423
+ The following is the EBNF for DN in string representation (Extended Backus-Naur Form; see ISO/IEC 14977 [13] for more information):
424
+
425
+ ```
426
+
427
+ DistinguishedName = NullDN (* Distinguished Names shall not exceed *)
428
+ | RegularDN ; (* 400 octets as specified in section 7.4 *)
429
+
430
+ NullDN = ; (* empty string; null DN is specified in subclause 7.1.1 *)
431
+
432
+ RegularDN = DNPrefixPlusRDNSeparator (* DN prefix and local DN *)
433
+ , LocalDN ; (* are defined in annex C *)
434
+
435
+ DNPrefixPlusRDNSeparator = ( NullDNPrefix , NullRDNSeparator )
436
+ | ( DNPrefixWithDomainComponent , RDNSeparator )
437
+ | ( DNPrefixWithoutDomainComponent , RDNSeparator ) ;
438
+
439
+ NullDNPrefix = ; (* empty string *)
440
+
441
+ NullRDNSeparator = ; (* empty string *)
442
+
443
+ DNPrefixWithDomainComponent = DomainComponentRDN
444
+ , { RDNSeparator , DomainComponentRDN }
445
+ , { RDNSeparator , RegularRDN } ;
446
+
447
+ ```
448
+
449
+ ```
450
+
451
+ DNPrefixWithoutDomainComponent = RegularRDN
452
+ , { RDNSeparator , RegularRDN } ;
453
+
454
+ LocalDN = LocalRDN
455
+ , { RDNSeparator , LocalRDN } ;
456
+
457
+ RDNSeparator = [ RDNSeparatorWhiteSpace ] (* use of optional white space *)
458
+ , CommaChar (* is recommended to be avoided *)
459
+ , [ RDNSeparatorWhiteSpace ] ;
460
+
461
+ RDNSeparatorWhiteSpace = [ CarriageReturnChar ]
462
+ , [ SpaceChar ] ;
463
+
464
+ DomainComponentRDN = DCAttributeTypeAndValue ;
465
+
466
+ RegularRDN = RegularAttributeTypeAndValue ;
467
+
468
+ LocalRDN = LocalDNAttributeTypeAndValue ;
469
+
470
+ DCAttributeTypeAndValue = DCAttributeType
471
+ , AttributeTypeAndValueSeparator
472
+ , ( DCAttributeValue | WildcardDCAttributeValue ) ;
473
+
474
+ RegularAttributeTypeAndValue = ( RegularAttributeType | WildcardRegularAttributeType )
475
+ , AttributeTypeAndValueSeparator
476
+ , ( RegularAttributeValue | WildcardRegularAttributeValue ) ;
477
+
478
+ LocalDNAttributeTypeAndValue = ( LocalDNAttributeType | WildcardLocalDNAttributeType )
479
+ , AttributeTypeAndValueSeparator
480
+ , ( RegularAttributeValue | WildcardRegularAttributeValue ) ;
481
+
482
+ AttributeTypeAndValueSeparator = EqualsSignChar ;
483
+
484
+ DCAttributeType = "DC" ; (* ISO/IEC 646 IRV U+0044/0043 Latin capital letters D&C *)
485
+
486
+ DCAttributeValue = DCLabel (* this is specified *)
487
+ , { DCLabelSeparator , DCLabel } ; (* in IETF RFC 1035 *)
488
+
489
+ WildcardDCAttributeValue = ( ( DCLabel | WildcardDCLabel )
490
+ , { DCLabelSeparator , ( DCLabel | WildcardDCLabel ) } )
491
+ - DCAttributeValue ;
492
+
493
+ DCLabelSeparator = FullStopChar ; (* this is specified in IETF RFC 1035 *)
494
+
495
+ DCLabel = LetterChar (* this is specified *)
496
+ , [ { LetterDigitHypenMinusChar } (* in IETF RFC 1035 *)
497
+ , LetterDigitChar ] ;
498
+
499
+ WildcardDCLabel = ( ( LetterChar | WildcardChar )
500
+ , [ { LetterDigitHypenMinusChar | WildcardChar }
501
+ , ( LetterDigitChar | WildcardChar ) ] )
502
+ - DCLabel ;
503
+
504
+ RegularAttributeType = LetterChar (* this is specified *)
505
+ , { LetterDigitHypenMinusChar } ; (* in IETF RFC 2253 *)
506
+
507
+ WildcardRegularAttributeType = ( ( LetterChar | WildcardChar )
508
+ , { LetterDigitHypenMinusChar | WildcardChar } )
509
+ - RegularAttributeType ;
510
+
511
+ LocalDNAttributeType = NameOfClassWithIdAttribute (* definition selected shall *)
512
+ | NamesOfClassAndNamingAttribute ; (* be in accordance with the *)
513
+ (* rules defined in annex B *)
514
+
515
+ WildcardLocalDNAttributeType = WildcardNameOfClassWithIdAttr
516
+ | WildcardNamesOfClassAndNamAttr ;
517
+
518
+ NameOfClassWithIdAttribute = ClassName ; (* see rules defined in annex B *)
519
+
520
+ WildcardNameOfClassWithIdAttr = WildcardClassName ;
521
+
522
+ NamesOfClassAndNamingAttribute = ClassName (* see rules defined in annex B *)
523
+ , ClassNamingAttributeSeparator
524
+ , NamingAttributeName ;
525
+
526
+ WildcardNamesOfClassAndNamAttr = ( ( ClassName | WildcardClassName )
527
+ , ClassNamingAttributeSeparator
528
+
529
+ ```
530
+
531
+ ```
532
+
533
+ , ( NamingAttributeName | WildcardNamingAttributeName ) )
534
+ - NamesOfClassAndNamingAttribute ;
535
+
536
+ ClassNamingAttributeSeparator = FullStopChar ; (* see rules defined in annex B *)
537
+
538
+ ClassName = CapitalLetterChar (* see recommendation on *)
539
+ , { LocalDNAttributeTypeChar } ; (* characters for class names *)
540
+ (* in annex E *)
541
+ WildcardClassName = ( ( CapitalLetterChar | WildcardChar )
542
+ , { LocalDNAttributeTypeChar | WildcardChar } )
543
+ - ClassName ;
544
+
545
+ NamingAttributeName = SmallLetterChar
546
+ , { LocalDNAttributeTypeChar } ;
547
+
548
+ WildcardNamingAttributeName = ( ( SmallLetterChar | WildcardChar )
549
+ , { LocalDNAttributeTypeChar | WildcardChar } )
550
+ - NamingAttributeName ;
551
+
552
+ RegularAttributeValue = ( ( AttributeValueChar - SpaceChar ) (* this is *)
553
+ , [ { AttributeValueChar } (* specified in *)
554
+ , ( AttributeValueChar - SpaceChar ) ] ; (* IETF RFC 2253 *)
555
+
556
+ WildcardRegularAttributeValue = ( ( ( AttributeValueChar - SpaceChar ) | WildcardChar )
557
+ , [ { AttributeValueChar | WildcardChar }
558
+ , ( ( AttributeValueChar - SpaceChar ) | WildcardChar ) ] )
559
+ - RegularAttributeValue ;
560
+
561
+ LocalDNAttributeTypeChar = DNChar - FullStopChar ;
562
+
563
+ AttributeValueChar = DNChar | EscapedCharSequence ;
564
+
565
+ WildcardChar = AsteriskChar ; (* this is specified in subclause 7.2 *)
566
+
567
+ DNChar = DNCharUnrestricted - ReservedChar ;
568
+
569
+ DNCharUnrestricted = ? Character of ISO/IEC 646 IRV ?
570
+ | ? Character of standard coded character set
571
+ supporting and extending ISO/IEC 646 IRV ? ;
572
+
573
+ EscapedCharSequence = ReverseSolidusChar (* this is specified *)
574
+ , 2 * HexadecimalDigitChar ; (* in subclause 7.1.3 *)
575
+
576
+ ReservedChar = Rfc2253ReservedChar | CarriageReturnChar | LineFeedChar
577
+ | AsteriskChar ;
578
+
579
+ Rfc2253ReservedChar = CommaChar | EqualsSignChar | PlusSignChar | LessThanSignChar
580
+ | GreaterThanSignChar | NumberSignChar | SemiColonChar
581
+ | ReverseSolidusChar | QuotationMarkChar ;
582
+
583
+ LetterChar = CapitalLetterChar | SmallLetterChar ;
584
+
585
+ LetterDigitChar = LetterChar | DigitChar ;
586
+
587
+ LetterDigitHyphenMinusChar = LetterDigitChar | HyphenMinusChar ;
588
+
589
+ HexadecimalDigitChar = DigitChar | CapitalLetterAtoFChar | SmallLetterAtoFChar ;
590
+
591
+ LineFeedChar = ? ISO/IEC 646 IRV U+000A character line feed ? ;
592
+
593
+ CarriageReturnChar = ? ISO/IEC 646 IRV U+000D character carriage return ? ;
594
+
595
+ SpaceChar = ' ' ; (* ISO/IEC 646 IRV U+0020 character space *)
596
+
597
+ QuotationMarkChar = '"' ; (* ISO/IEC 646 IRV U+0022 character quotation mark *)
598
+
599
+ NumberSignChar = '#' ; (* ISO/IEC 646 IRV U+0023 character number sign *)
600
+
601
+ AsteriskChar = '*' ; (* ISO/IEC 646 IRV U+002A character asterisk *)
602
+
603
+ PlusSignChar = '+' ; (* ISO/IEC 646 IRV U+002B character plus sign *)
604
+
605
+ CommaChar = ',' ; (* ISO/IEC 646 IRV U+002C character comma *)
606
+
607
+ HyphenMinusChar = '-' ; (* ISO/IEC 646 IRV U+002D character hyphen-minus *)
608
+
609
+ FullStopChar = '.' ; (* ISO/IEC 646 IRV U+002E character full stop *)
610
+
611
+ ```
612
+
613
+ ```
614
+
615
+ DigitChar = '0' | '1' | '2' | '3' | '4' (* ISO/IEC 646 IRV U+0030-0039 *)
616
+ | '5' | '6' | '7' | '8' | '9' ; (* digits 0 to 9 *)
617
+
618
+ SemiColonChar = ';' ; (* ISO/IEC 646 IRV U+003B character semicolon *)
619
+
620
+ LessThanSignChar = '<' ; (* ISO/IEC 646 IRV U+003C character less-than sign *)
621
+
622
+ EqualsSignChar = '=' ; (* ISO/IEC 646 IRV U+003D character equals sign *)
623
+
624
+ GreaterThanSignChar = '>' ; (* ISO/IEC 646 IRV U+003E character greater-than sign *)
625
+
626
+ CapitalLetterAtoFChar = 'A' | 'B' | 'C' (* ISO/IEC 646 IRV U+0041-0046 *)
627
+ | 'D' | 'E' | 'F' ; (* Latin capital letters A to F *)
628
+
629
+ CapitalLetterChar = CapitalLetterAtoFChar | 'G' | 'H' (* ISO/IEC 646 IRV *)
630
+ | 'I' | 'J' | 'K' | 'L' | 'M' | 'N' (* U+0041-005A *)
631
+ | 'O' | 'P' | 'Q' | 'R' | 'S' | 'T' (* Latin capital *)
632
+ | 'U' | 'V' | 'W' | 'X' | 'Y' | 'Z' ; (* letters A to Z *)
633
+
634
+ ReverseSolidusChar = '\'; ; (* ISO/IEC 646 IRV U+005C character reverse solidus *)
635
+
636
+ SmallLetterAtoFChar = 'a' | 'b' | 'c' (* ISO/IEC 646 IRV U+0061-0066 *)
637
+ | 'd' | 'e' | 'f' ; (* Latin small letters a to f *)
638
+
639
+ SmallLetterChar = SmallLetterAtoFChar | 'g' | 'h' (* ISO/IEC 646 IRV *)
640
+ | 'i' | 'j' | 'k' | 'l' | 'm' | 'n' (* U+0061-007A *)
641
+ | 'o' | 'p' | 'q' | 'r' | 's' | 't' (* Latin small *)
642
+ | 'u' | 'v' | 'w' | 'x' | 'y' | 'z' ; (* letters a to z *)
643
+
644
+ ```
645
+
646
+ ## 7.4 Maximum size of DN string
647
+
648
+ The maximum length of a DN string, including RDN separators and including white spaces, shall not exceed 400 bytes (8-bit).
649
+
650
+ # --- 8 Examples of DN in string representation
651
+
652
+ This subclause gives a few examples of DN written in the string representation specified in the present document.
653
+
654
+ - EXAMPLE 1: "DC=com, DC=CompanyXYZ, DC=marketing, IRPAgent=ATMPVCBilling, Log=19990101131000, AccountingRecord=100098". In this example, the name space aligns with DNS. The AttributeType of the top three RDN are "DC". Concatenation of the corresponding AttributeValues produces the DNS registered name, i.e. "marketing.CompanyXYZ.com". The top RDN is the Global Root because DNS defines "DC=com" as the root of its name space. That top RDN is the Local Root as well.
655
+ - EXAMPLE 2: "DC=marketing.CompanyXYZ.com, IRPAgent=ATMPVCBilling, Log=19990101131000, AccountingRecord=100098". In this example, the name space aligns with DNS as well. Instead of using three RDNs to represent the DNS registered name, this example chooses to use one RDN. The top RDN is the Global Root (and Local Root as well).
656
+ - EXAMPLE 3: "SubNetwork=ABCNetwork, SubNetwork=TN2, MSCFunction=B5C0100". In this example, the name space designer chooses not to name its objects under the DNS nor X.500 scheme. The name space designer chooses to use "SubNetwork=ABCNetwork" as the Local Root of its name space (by looking at the DN string, it is not possible to say if the Local Root is the Global Root). DNs in this name space will start with that string as their Local Root.
657
+ - EXAMPLE 4: The following example illustrates the use of the comma character as separator for RDNs. It also illustrates the use of space and full stop characters as part of the legal character syntax for RDNs: "CN=John T. Mills, O=Cyber System Consulting"
658
+
659
+ # 9 Usage Scenario
660
+
661
+ ## 9.1 DN prefix usage
662
+
663
+ This subclause presents recommended steps designer uses to partition the Enterprise name space while building an Alarm IRP compliant NE (the Alarm IRP Agent).
664
+
665
+ 1. The NE designer specifies the NRM (e.g. 3GPP TS 32.622 [9]) for the NE. Suppose the NRM is a two level hierarchy with 3 classes like:
666
+
667
+ ```
668
+ Node
669
+ |----- Port
670
+ |----- CrossConnect
671
+ ```
672
+
673
+ 2. The NE designer, based on the NRM and other design choices, decides that there are 7 instances within the NE that can report alarms, such as
674
+
675
+ ```
676
+ Port=1, Port=2, Port=3, Port=4, Port=5, CrossConnect=1, Node=1.
677
+ ```
678
+
679
+ 3. The NE designer decides on the DN prefix (see annex C) and configures its system accordingly. Since NE designer will not know the customer's name space in advance, he would normally configure the DN prefix to reflect his test environment. The DN prefix can be configured to "Network=test". The Global Root is "Network=test". The Local Root is "Node=1". It should be noted that the NE should not hard code the DN prefix but should treat DN prefix as a system configuration parameter, settable.
680
+
681
+ EXAMPLE 1: At system start-up time.
682
+
683
+ 4. When constructing the alarm record (in coding phase), NE designer shall concatenate the name of the alarmed instance with the DN prefix to form the DN of his test environment. The resultant DN (e.g. "Network=test, Node=1, Port=3") will be placed in the Managed Object Instance (MOI) field of the alarm record.
684
+ 5. The NE is sold to a customer. The customer administrator knows his Enterprise name space, the topology of his network and where the NE will be deployed. Based on the information, he configures the DN prefix of the NE.
685
+
686
+ EXAMPLE 2: The customer administrator can configure it to:
687
+
688
+ ```
689
+ "DC=marketing.CompanyXYZ.com, Net=DS3BackBone, Station=TMR"
690
+ ```
691
+
692
+ The Global Root in this case is "DC=marketing.CompanyXYZ.com".
693
+
694
+ 6. At run time, whenever NE is reporting an alarm on Port=3 via the IRP, the following string will be in the MOI field of the alarm record:
695
+
696
+ ```
697
+ "DC=marketing.CompanyXYZ.com, Net=DS3BackBone, Station=TMR, Node=1, Port=3"
698
+ ```
699
+
700
+ # Annex A (normative): Mapping of RDN AttributeType to Strings
701
+
702
+ NOTE: This annex is normative for users of string representation.
703
+
704
+ AttributeType of RDN is mapped into string for use in the DN string representation. This annex specifies the mapping.
705
+
706
+ The AttributeType shall include all MO classes defined in the 3GPP Network Resource Model (NRM) IRP specifications such as the 3GPP TS 32.622 [9].
707
+
708
+ It can also include classes defined by other domain specific NRMs such as [17], [18] and [19]. Such inclusion is necessary where 3GPP-defined mobile access network is part of a Fixed Mobile Convergence network management environment.
709
+
710
+ There is one AttributeType that is not defined in NRM of 3GPP TS 32.622 [9] or other domain specific NRMs as listed in the Introduction clause. This special AttributeType is used to denote the domain component of the DNS. The following partial DN string representations are examples to illustrate the valid use of "DC" strings for the three DNS domain components of "marketing.CompanyXYZ.com":
711
+
712
+ - "DC=com.CompanyXYZ.marketing,..."
713
+ - "DC=com, DC=CompanyXYZ, DC=marketing,..."
714
+ - "DC=com, DC=CompanyXYZ.marketing,..."
715
+ - "DC=com.CompanyXYZ, DC=marketing,..."
716
+
717
+ **Table A.1: Example of RDN AttributeType Strings**
718
+
719
+ | String | AttributeType |
720
+ |------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
721
+ | DC | Domain component of DNS |
722
+ | SubNetwork | MO class name SubNetwork defined in NRM of 3GPP TS 32.622 [9]. |
723
+ | etc. | See note. |
724
+ | NOTE: | For each MO class name found in 3GPP set of specifications, its corresponding AttributeType String shall be identical to the class name with the leading character capitalised. |
725
+
726
+ # Annex B (normative): Rule for MO Designers regarding `AttributeType` interpretation
727
+
728
+ NOTE: This annex is normative for users of one string representation.
729
+
730
+ This annex discusses the two possible interpretations for the `AttributeType` of the DN string and establishes a rule for MO designers to avoid ambiguity concerning their usage. It also gives a rule for designing MO classes such that one DN string, regardless of the IRP SS technology used, will result in a unique reference to the corresponding network resource.
731
+
732
+ ## First interpretation
733
+
734
+ ITU-T Recommendation X.500 [2] uses the `AttributeType` (defined for use as the first component of the `AttributeTypeAndValue` of a RDN, see subclause 3.1.6) to identify one attribute of the subject MO for naming purpose. This `AttributeType` is called the *naming attribute* to distinguish itself from other attributes that may be present in the MO.
735
+
736
+ Suppose the following is the MO class definition in pseudo notation and this MO class is inherited from root.
737
+
738
+ ```
739
+ Class Bsc {
740
+ Attribute id;
741
+ Attribute ..}
742
+ ```
743
+
744
+ Suppose further that the naming attribute is `id`.
745
+
746
+ If this (first) interpretation is used for constructing the DN string, then the DN will be "..., id=123". MO class name cannot be derived from the DN string. The value of the `AttributeValue` contains the value of the naming attribute.
747
+
748
+ ## Second interpretation
749
+
750
+ Generally, this interpretation shall be preferred to the first interpretation.
751
+
752
+ The `AttributeType` (defined for use as the first component of the `AttributeTypeAndValue` of a RDN) is used to identify the MO class. Using this interpretation for constructing the DN string the DN will be "..., Bsc=123". The name of the naming attribute cannot be derived from the DN string. The value of the `AttributeValue` contains the value of the naming attribute.
753
+
754
+ ## Rule
755
+
756
+ Given the two interpretations, a DN reader cannot know how to interpret the `AttributeType`, i.e. if the `AttributeType` identifies class or naming attribute. To avoid ambiguity, the following rules shall apply:
757
+
758
+ - If the IS name of the IOC naming attribute is "id", ignoring case of "id", then the DN shall use "..., Yyy=123, ..." where "Yyy" is the IS name of the IOC, preserving case of "Yyy".
759
+
760
+ EXAMPLE 1: If "Bsc" is the IS name of the IOC and if the IS name of its naming attribute is "id" then the DN shall be "..., Bsc=123, ...".
761
+
762
+ - If the IS name of the IOC naming attribute is not the concatenation of the IS name of the IOC and "Id", ignoring case for both, and if the IS name of the IOC naming attribute is not "id", ignoring case of "id", then the DN shall use "..., Yyy.zzz=123, ..." where "Yyy" is the IS name of the IOC and "zzz" is the IS name of the IOC naming attribute, preserving case for both.
763
+
764
+ EXAMPLE 2: If "Bsc" is the IS name of the IOC and if the IS name of its naming attribute is "serialNumber", then the DN shall be "..., Bsc.serialNumber=123, ...".
765
+
766
+ - If the IS name of the IOC naming attribute is the concatenation of the IS name of the IOC and "Id", ignoring case for both, then the DN shall use "..., Xxx=123, ..." where "Xxx" is the IS name of the IOC, preserving case.
767
+
768
+ EXAMPLE 3: If "Bsc" is the IS name of the IOC and if the IS name of its naming attribute is "bscId", then the DN shall be "..., Bsc=123, ...".
769
+
770
+ # Annex C (informative): DN Prefix and Local Distinguished Name (LDN)
771
+
772
+ A Distinguished Name (DN) is used to uniquely identify a MO within a name space. A DN is built from a series of "name components", referred to as Relative Distinguished Names (RDNs).
773
+
774
+ DNs within a name space are arranged in hierarchy similar to concepts of naming files in UNIX file system. A file name, in the context of a local subdirectory, contains the path (series of subdirectory names) of the file starting from the local subdirectory. The same file, in the global context, contains the path of the file starting from the root directory. Similar concept applies to naming MOs. From a particular (local) context, the name of a MO is the Local Distinguished Name (LDN). From a global context, the name of the same MO is the DN. LDN is a proper subset of DN. In the context of a particular local context, a DN prefix is defined such that all LDNs in that particular context, if attached behind the DN prefix of that context, will yield the DNs of the MOs.
775
+
776
+ The concepts of DN Prefix and LDN support the partitioning of large name space into smaller ones for efficient name space implementation. DN design, the subject of the present document, does not depend on these concepts. There exist other concepts that support partitioning of large name space as well. Although these concepts are independent from DN design, their use is wide spread and this annex illustrates their use in partitioning large name space.
777
+
778
+ In modern network management, it is expected that the Enterprise name space be partitioned for implementations in multiple hosts. The following are reasons for the partitioning.
779
+
780
+ - The Enterprise name space can be large (e.g. containing millions of objects). Partition of a large name space facilitates name space management.
781
+
782
+ EXAMPLE 1: It may be easier to manage two name spaces of 1 million objects each than to manage one name space with two million objects.
783
+
784
+ - Separate IRPAgents manage sub-set of the Enterprise name space relevant to their own local environment.
785
+
786
+ EXAMPLE 2: One NE manages a name space (subset of the Enterprise name space) containing names of its MOs representing its own network resources. Another NE manages another sub-set, etc.
787
+
788
+ - For reasons such as security, replication, back-up policy and performance, sub-sets of the Enterprise name space are managed by separate systems.
789
+
790
+ EXAMPLE 3: Operation and Marketing departments may want to manage their name spaces using their respective management policies. Partitioning of Enterprise name space according to departmental jurisdiction may facilitate deployment of independent management policies.
791
+
792
+ Suppose the Enterprise name space is organized hierarchically and is partitioned into 4 sub-sets as shown in figure C.1.
793
+
794
+ ![Figure C.1: Name space partitions. A hierarchical diagram showing four name space partitions (NS-A, NS-B, NS-C, NS-D) branching from a central root node. Each partition contains its own hierarchy of nodes. Labels indicate the DN prefix and RDNs for each partition.](a7835229df7a34816e1d35b5bbbc8c9e_img.jpg)
795
+
796
+ The diagram illustrates the hierarchical structure of name space partitions. At the top is a root node. Below it, four boxes represent the partitions: NS-A, NS-B, NS-C, and NS-D. Each partition contains a sub-hierarchy of nodes.
797
+
798
+ - NS-A:** The root node of this partition has an RDN of "DC=com.CompanyXYZ.marketing". It has two children with RDNs "A=7" and "A=9". The DN prefix for this partition is "".
799
+ - NS-B:** The root node of this partition has an RDN of "A=9". It has two children with RDNs "X=1" and "Y=1". The DN prefix for this partition is "DC=com.CompanyXYZ.marketing".
800
+ - NS-C:** The root node of this partition has an RDN of "H=2". It has one child with an RDN of "F=1". The DN prefix for this partition is "DC=com.CompanyXYZ.marketing, A=7, X=1".
801
+ - NS-D:** The root node of this partition has an RDN of "H=2". It has one child with an RDN of "G=1". The DN prefix for this partition is "DC=com.CompanyXYZ.marketing, A=9, F=1, G=1".
802
+
803
+ Figure C.1: Name space partitions. A hierarchical diagram showing four name space partitions (NS-A, NS-B, NS-C, NS-D) branching from a central root node. Each partition contains its own hierarchy of nodes. Labels indicate the DN prefix and RDNs for each partition.
804
+
805
+ Figure C.1: Name space partitions
806
+
807
+ NS (name space)-A contains 5 objects. DN prefix is NULL. The Global Root and Local Root of NS-A is "DC=com.CompanyXYZ.marketing" (see the Note below). DN of top object is "DC=com.CompanyXYZ.marketing". RDNs of the other four objects are, from bottom left to bottom right, "A=1", "A=7", "A=3" and "A=9". DNs of the same four objects are "DC=com.CompanyXYZ.marketing,A=1", "DC=com.CompanyXYZ.marketing,A=7", "DC=com.CompanyXYZ.marketing,A=3" and "DC=com.CompanyXYZ.marketing,A=9". The second and fourth objects are reference objects to MOs in NS-B.
808
+
809
+ NS-B contains two branches. They have the same DN prefix that is "DC=com.CompanyXYZ.marketing". The Global Root is "DC=com.CompanyXYZ.marketing".
810
+
811
+ The Local Root and RDN of top object of the right branch is "A=9". Its DN is "DC=com.CompanyXYZ.marketing,A=9". RDNs of other objects are shown in figure C.1. DN of the bottom object is "DC=com.CompanyXYZ.marketing,A=9,F=1,G=1,H=2". This object refers to object of another name space called NS-D.
812
+
813
+ The Local Root and RDN of the top object of the left branch is "A=7". Its DN is "DC=com.CompanyXYZ.marketing,A=7". RDNs of other objects are shown in figure C.1. DN of the bottom object is "DC=com.CompanyXYZ.marketing,A=7,X=1,Y=1". This object refers to object of another name space called NS-C.
814
+
815
+ NS-C contains a branch of 4 objects. Its DN prefix is "DC=com.CompanyXYZ.marketing,A=7,X=1". The Local Root and RDN of the top object is "Y=1".
816
+
817
+ NS-D contains a branch of 5 objects. Its DN prefix is "DC=com.CompanyXYZ.marketing,A=9,F=1,G=1". The Local Root and RDN of the top object is "H=2".
818
+
819
+ In figure C.1, the bottom object of NS-B right branch has the following names:
820
+
821
+ - DN is "DC=com.CompanyXYZ.marketing,A=9,F=1,G=1,H=2".
822
+ - LDN is "A=9,F=1,G=1,H=2".
823
+ - RDN is "H=2".
824
+
825
+ With this example, we can see that DN of an object is a series of RDNs spanning the global name space. LDN of an object is a series of RDNs spanning the local name space where the subject MO resides.
826
+
827
+ The concatenation of the LDN with DN prefix of that (partitioned) name space shall produce the DN of the global name space.
828
+
829
+ **NOTE:** Use of "DC" in "DC=com.CompanyXYZ.marketing" is an attempt to align the RDN with DNS name associated with the named organisation. The "DC" stands for Domain Component and is an attribute name defined by IETF for use in directory work. Annex A specifies other valid ways to align RDN with DNS as well. Equally valid, the example can choose to align the RDN with the X.500 convention. In such case, the subject string can be "O=com,O=CompanyXYZ,OU=marketing" where O and OU are X.500 standard attributes denoting organisation and organization unit respectively. The alignment choice belongs to the name space designer of each operator. The choice will be reflected in the value of the DN prefix, probably a product configuration parameter. See clause 7 for more information.
830
+
831
+ # Annex D (informative): Interpreting EBNF [13]
832
+
833
+ This annex provides a very simplified summary of EBNF, and does not modify in any way the reference text in ISO/IEC 14977: "Information technology – Syntactic metalanguage – Extended BNF" [13].
834
+
835
+ ISO/IEC 14977 [13] specification also provides far greater coverage supported by numerous examples which are not included within this annex.
836
+
837
+ The EBNF metalanguage is useful for defining rigorous syntax notations and is a notation for defining syntax rules.
838
+
839
+ The language uses sequences of formal definitions.
840
+
841
+ Definitions may have several layers of definition. The definitions which are refined are termed as "non terminal symbols".
842
+
843
+ A term which cannot be defined at a lower level of detail is known as a "terminal symbol". I.e. the "terminal symbols" cannot be further decomposed.
844
+
845
+ The language permits sentences to be constructed.
846
+
847
+ The sentences consist of a non terminal, or a terminal symbol, followed by an equality symbol, followed by a formal definition of the symbol.
848
+
849
+ Each sentence terminates with the semicolon ';' terminal symbol.
850
+
851
+ Ideally the definitions are read from the top across to the right hand side of the page and downwards.
852
+
853
+ A definition commences with an identifier (of the thing being defined) followed by an equality sign.
854
+
855
+ The thing is defined by the symbols and identifiers to the right hand side of the equality symbol, up to the next semicolon ';'.
856
+
857
+ There is a natural breaking down of definitions, by other definitions until a point is reached that a terminal symbol is reached – which cannot be further defined (e.g. the leaves of definition hierarchy).
858
+
859
+ There are terminal symbols which permit optional choice, sequence, exclusion, comments to be included in the sentence.
860
+
861
+ The set of terminal symbols as defined in table 1 of ISO/IEC 14977 [13] are below.
862
+
863
+ The normal character representing each operator of Extended BNF and its implied precedence is (highest precedence at the top):
864
+
865
+ '\*' repetition-symbol
866
+
867
+ '-' except-symbol
868
+
869
+ ';' concatenate-symbol
870
+
871
+ '|' definition-separator-symbol
872
+
873
+ '=' defining-symbol
874
+
875
+ ';' terminator-symbol
876
+
877
+ The normal precedence is over-ridden by the following pairs of terminal symbols:
878
+
879
+ | | | | |
880
+ |------|----------------------|---------------------|------|
881
+ | "'" | first-quote-symbol | first-quote-symbol | "'" |
882
+ | ''' | second-quote-symbol | second-quote-symbol | ''' |
883
+ | "(*" | start-comment-symbol | end-comment-symbol | "*)" |
884
+ | '(' | start-group-symbol | end-group-symbol | ')' |
885
+
886
+ | | | | |
887
+ |-----|-------------------------|-------------------------|-----|
888
+ | '[' | start-option-symbol | end-option-symbol | ']' |
889
+ | '{' | start-repeat-symbol | end-repeat-symbol | '}' |
890
+ | '?' | special-sequence-symbol | special-sequence-symbol | '?' |
891
+
892
+ Examples:
893
+
894
+ ```
895
+ letter = "A" | "B" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | "J" | "K" | "L"
896
+ | "M" | "N" | "O" | "P" | "Q" | "R" | "S" | "U" | "V" | "W" | "X" | "Y" | "Z" ;
897
+ vowel = "A" | "E" | "I" | "O" | "U" ; (* a subset of letters *)
898
+ consonant = letter - vowel ; (* the set of letters except vowels *)
899
+ ```
900
+
901
+ # --- Annex E (informative): IOC/MOC name recommendation
902
+
903
+ ## **Recommendation:**
904
+
905
+ 3GPP considers the use of many non-alphanumeric characters as valid characters for constructing the IOC names. The Java programming language considers the use of alphanumeric characters plus only two non-alphanumeric characters, i.e. "\$" and " \_ ", as valid characters for Java Packages and Java Class names. Because the names of the Java Packages and Java Classes generated by Java programming tools for SS implementation may include MO Class names, a Java environment would have to include a translation mechanism that replaces the invalid characters (if they are used in the IS specification to name an IOC, that is mapped to the same MOC name in a Solution Set) by valid characters. For example, replace "-" by " \_ ". This translation mechanism causes unwanted complexity and reduction in performance of the implementation. Given Java may become popular for coding IRPManager and/or IRPAgent capabilities, this note recommends the specification authors to use valid Java name characters (i.e. all alphanumeric characters plus "\$" and " \_ ") to name their IS IOCs and SS MOCs.
906
+
907
+ # Annex F (informative): Change history
908
+
909
+ | Change history | | | | | | | | | |
910
+ |----------------|-------|-----------|------|-----|-------------------------------------------------------------------------------------------------------------------------------|---------|-------|--------|--|
911
+ | Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Ca<br>t | Old | New | |
912
+ | Jun 2001 | SP-12 | SP-010283 | -- | -- | Approved at TSG SA #12 and placed under Change Control | -- | 2.0.0 | 4.0.0 | |
913
+ | Dec 2001 | SP-14 | SP-010641 | 0001 | -- | Alignment of Figure C.1 with text in annex C | -- | 4.0.0 | 4.1.0 | |
914
+ | Sep 2001 | SP-17 | SP-020481 | 0002 | -- | Upgrade to Rel-5 (Remove information in the Introduction that is only relevant to Rel-4) | F | 4.1.0 | 5.0.0 | |
915
+ | Dec 2002 | -- | -- | -- | -- | Cosmetics | F | 5.0.0 | 5.0.1 | |
916
+ | Dec 2004 | SP-26 | SP-040793 | 0003 | -- | Correct and convert formal specification from BNF syntax to EBNF with corrections | F | 5.0.1 | 6.0.0 | |
917
+ | Mar 2005 | SP-27 | SP-050049 | 0004 | -- | Re-introduce text erroneously deleted during implementation of CR 003 | F | 6.0.0 | 6.1.0 | |
918
+ | Jun 2005 | SP-28 | SP-050285 | 0005 | -- | Correct DN string representation formal definition to support wildcard character | F | 6.1.0 | 6.2.0 | |
919
+ | Dec 2005 | SP-30 | SP-050726 | 0006 | -- | Clarify DN string encoding applicability to all IRP technologies other than CMIP | F | 6.2.0 | 6.3.0 | |
920
+ | Dec 2005 | SP-30 | SP-050716 | 0007 | -- | Add Annex A from 32.622t | F | 6.2.0 | 6.3.0 | |
921
+ | Jul 2006 | -- | -- | -- | -- | Delete duplicated paragraph in the "Introduction" clause | -- | 6.3.0 | 6.3.1 | |
922
+ | Jun 2007 | SP-36 | -- | -- | -- | Automatic upgrade to Rel-7 (no CR) at freeze of Rel-7. CMIP is still mentioned in spite of discontinuation of CMIP SSs in R7. | -- | 6.3.1 | 7.0.0 | |
923
+ | Sep 2007 | SP-37 | SP-070612 | 0008 | -- | Discontinuing of CMIP Solution Sets in Release 7 | F | 7.0.0 | 7.1.0 | |
924
+ | Dec 2007 | SP-38 | SP-070731 | 0009 | -- | Discontinuation of CMIP Solution Sets in Release 7 | F | 7.1.0 | 7.2.0 | |
925
+ | Dec 2008 | SA_42 | -- | -- | -- | Upgrade to Release 8 | -- | 7.2.0 | 8.0.0 | |
926
+ | Sep 2009 | SA_45 | SP-090627 | 0010 | -- | Cleanup of old references | F | 8.0.0 | 9.0.0 | |
927
+ | Dec 2009 | SA_46 | SP-090719 | 0009 | -- | Clarify IOC instance naming rule | F | 9.0.0 | 9.1.0 | |
928
+ | Jun 2010 | SA_48 | SP-100429 | 0011 | 1 | Add missing encoding rules for Distinguished Name | F | 9.1.0 | 9.2.0 | |
929
+ | Mar 2011 | SA_51 | SP-110095 | 0012 | 1 | Clarify name space and Distinguished Name usage examples and general updates | F | 9.2.0 | 10.0.0 | |
marked/Rel-10/32_series/32301/raw.md ADDED
@@ -0,0 +1,207 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+
4
+
5
+ Keywords
6
+ management
7
+
8
+ # 3GPP TS 32.301 V10.0.0 (2011-03)
9
+
10
+ *Technical Specification*
11
+
12
+ **3rd Generation Partnership Project;**
13
+ **Technical Specification Group Services and System**
14
+ Postal address
15
+ **Aspects;**
16
+ **Telecommunication management;**
17
+ 3GPP support office address
18
+ **Configuration Management (CM);**
19
+ 050 Route des Lucioles - B.P. 106
20
+ Valbonne - FRANCE
21
+ Tel.: +33 (0) 93 639 94 4200 Fax: +33 (0) 93 639 47 47
22
+ **Notification Integration Reference**
23
+
24
+ ![LTE logo with '4ADVANCED' text above the 't'.](8c378a184b5ae4d1605cb74d7b7a7e3f_img.jpg)
25
+
26
+ LTE logo with '4ADVANCED' text above the 't'.
27
+
28
+ Internet
29
+
30
+ <http://www.3gpp.org>
31
+
32
+ ![3GPP logo with a signal icon below the 'G'.](1211e36d120f0d2912a745437f4c8f19_img.jpg)
33
+
34
+ 3GPP logo with a signal icon below the 'G'.
35
+
36
+ The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP.
37
+
38
+ The present document has not been subject to any approval process by the 3GPP Organisational Partners and shall not be implemented.
39
+
40
+ This Specification is provided for future development work within 3GPP only. The Organisational Partners accept no liability for any use of this Specification.
41
+
42
+ Specifications and reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organisational Partners' Publications Offices.
43
+
44
+ # ***Copyright Notification***
45
+
46
+ No part may be reproduced except as authorized by written permission.
47
+ The copyright and the foregoing restriction extend to reproduction in all media.
48
+
49
+ © 2011, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TTA, TTC).
50
+ All rights reserved.
51
+
52
+ UMTSTM is a Trade Mark of ETSI registered for the benefit of its members
53
+ 3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
54
+ LTETM is a Trade Mark of ETSI currently being registered for the benefit of its Members and of the 3GPP Organizational Partners
55
+ GSM® and the GSM logo are registered and owned by the GSM Association
56
+
57
+ # Contents
58
+
59
+ | | |
60
+ |----------------------------------------------------------|---|
61
+ | Foreword ..... | 4 |
62
+ | Introduction ..... | 4 |
63
+ | 1 Scope..... | 6 |
64
+ | 2 References..... | 6 |
65
+ | 3 Definitions and abbreviations ..... | 6 |
66
+ | 3.1 Definitions..... | 6 |
67
+ | 3.2 Abbreviations ..... | 7 |
68
+ | 4 Notification management functions over Itf-N..... | 7 |
69
+ | 4.1 Notification mechanism subscription functions ..... | 7 |
70
+ | 4.2 Subscription control functions ..... | 7 |
71
+ | 4.3 Notification control functions ..... | 7 |
72
+ | 4.4 Function to discover notification capabilities ..... | 7 |
73
+ | 4.5 Generic notification header ..... | 8 |
74
+ | Annex A (informative): Change history..... | 9 |
75
+
76
+ # --- Foreword
77
+
78
+ This Technical Specification (TS) has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP).
79
+
80
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
81
+
82
+ Version x.y.z
83
+
84
+ where:
85
+
86
+ - x the first digit:
87
+ - 1 presented to TSG for information;
88
+ - 2 presented to TSG for approval;
89
+ - 3 or greater indicates TSG approved document under change control.
90
+ - y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
91
+ - z the third digit is incremented when editorial only changes have been incorporated in the document.
92
+
93
+ # --- Introduction
94
+
95
+ The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below:
96
+
97
+ - 32.301: Configuration Management (CM); Notification Integration Reference Point (IRP): Requirements**
98
+ - 32.302: Configuration Management (CM); Notification Integration Reference Point (IRP): Information Service (IS)
99
+ - 32.306: Configuration Management (CM); Notification Integration Reference Point (IRP): Solution Set (SS) definitions
100
+
101
+ The Itf-N interface is built up by a number of Integration Reference Points (IRPs) and a related Name Convention, which realise the functional capabilities over this interface. The basic structure of the IRPs is defined in 3GPP TS 32.101 [1] and 3GPP TS 32.102 [2].
102
+
103
+ Network Elements (NEs) under management and element managers generate notifications of events about occurrences within the network. Different kinds of events carry different kinds of information. For instance a new alarm as specified in Alarm IRP: Information Service [3], is one possible kind of event, an object creation as specified in Basic CM IRP: Information Service [4] is another possible kind of event.
104
+
105
+ Information of an event is carried in notification. An IRP Agent (typically an EM or a NE) emits notifications. IRP Manager (typically a network management system) receives notifications. The purpose of Notification IRP is to define an interface through which an IRP Manager can subscribe to IRP Agent for receiving notifications.
106
+
107
+ This IRP bases its design on work captured in ITU-T Recommendation X.734 [5], OMG Notification Service [6]. The central design ideas are:
108
+
109
+ - Separation of notification Consumers (IRP Managers) from Producers (IRP Agents);
110
+ - Notifications are sent to IRP Managers without the need for IRP Managers to periodically check for new notifications.
111
+
112
+ Common characteristics related to notifications in all other IRPs are gathered in one IRP.
113
+
114
+ # --- 1 Scope
115
+
116
+ The purpose of Notification IRP is to define an interface through which an IRPManager can subscribe to an IRPAgent for receiving notifications. The present document is the "Requirements" of Notification IRP. It defines, for the purpose of subscribing to an IRPAgent for receiving notifications, the basic requirements that shall be fulfilled on Itf-N.
117
+
118
+ How IRPManager discovers the IRPAgent's address or reference (so that IRPManager can invoke an operation) is outside the scope of the present document.
119
+
120
+ # --- 2 References
121
+
122
+ The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
123
+
124
+ - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
125
+ - For a specific reference, subsequent revisions do not apply.
126
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
127
+ - [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements".
128
+ - [2] 3GPP TS 32.102: "Telecommunication management; Architecture".
129
+ - [3] 3GPP TS 32.111-2: "Telecommunication management; Fault Management; Part 2: Alarm Integration Reference Point (IRP): Information Service (IS)".
130
+ - [4] 3GPP TS 32.602: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP): Information Service (IS)".
131
+ - [5] ITU-T Recommendation X.734: "Information technology - Open Systems Interconnection - Systems Management: Event report management function".
132
+ - [6] OMG: "OMG Notification Service".
133
+
134
+ # --- 3 Definitions and abbreviations
135
+
136
+ ## 3.1 Definitions
137
+
138
+ For the purposes of the present document, the following terms and definitions apply:
139
+
140
+ **Element Manager (EM):** See 3GPP TS 32.101 [1].
141
+
142
+ **IRPAgent:** See 3GPP TS 32.102 [2].
143
+
144
+ **IRPManager:** See 3GPP TS 32.102 [2].
145
+
146
+ **Network Manager (NM):** See 3GPP TS 32.101 [1].
147
+
148
+ ## 3.2 Abbreviations
149
+
150
+ For the purposes of the present document, the following abbreviations apply:
151
+
152
+ | | |
153
+ |-------|-------------------------------------------|
154
+ | CM | Configuration Management |
155
+ | CORBA | Common Object Request Broker Architecture |
156
+ | EM | Element Manager |
157
+ | FM | Fault Management |
158
+
159
+ | | |
160
+ |-------|-----------------------------------------------------------|
161
+ | IRP | Integration Reference Point |
162
+ | ITU-T | International Telecommunication Union - Telecommunication |
163
+ | MIB | Management Information Base |
164
+ | NE | Network Element |
165
+ | NR | Network Resource |
166
+ | OMG | Object Management Group |
167
+ | OS | Operations System |
168
+ | TM | Telecom Management |
169
+ | UMTS | Universal Mobile Telecommunications System |
170
+
171
+ # --- 4 Notification management functions over Itf-N
172
+
173
+ ## 4.1 Notification mechanism subscription functions
174
+
175
+ The IRP Agent shall provide IRP Managers with the capabilities to subscribe and unsubscribe to the notification mechanism. An IRP Manager shall be able to specify the types of notifications IRP Agent should emit to IRP Manager during subscription, to specify filtering criteria that shall be applied by the notification mechanism. An IRP Manager shall be able to subscribe several times in order to include in a subscription different types of notifications. An IRP Manager shall also be able to request multiple subscriptions, which is equivalent, from the IRP Agent perspective, to multiple IRP Managers each providing one subscription.
176
+
177
+ ## 4.2 Subscription control functions
178
+
179
+ The IRP Agent may provide to IRP Managers capabilities to control its subscriptions. An IRP Manager may then be able to check whether its subscription is still active or not, to know the details of a particular subscription and to know the list of all subscriptions it has opened.
180
+
181
+ ## 4.3 Notification control functions
182
+
183
+ In principle, notifications are forwarded to the IRP Managers as soon as they are available. The real-time forwarding of these notifications occurs via appropriate filtering mechanisms ("discriminators" on CMIP interfaces, "subscription" on CORBA interfaces) in accordance with ITU-T Recommendation X.734 [5] or OMG event/notification service. Any IRP Manager may be able to set and change filter criteria applicable during the life-cycle of one of its subscriptions in order to ensure that only the notifications which fulfil pre-defined criteria are sent. An IRP Manager may also be able to enable and disable the emission of notifications corresponding to its subscriptions.
184
+
185
+ ## 4.4 Function to discover notification capabilities
186
+
187
+ The IRP Agent may provide IRP Managers with a capability to discover the IRPs supported by the IRP Agent that are capable of sending notifications through the notification IRP. Those IRPs shall be identified with their version.
188
+
189
+ ## 4.5 Generic notification header
190
+
191
+ Notifications are emitted by the notification IRP. Those notifications can be defined in any other IRP (e.g. a notification for a new alarm as specified in 3GPP TS 32.111-2 [3] Alarm IRP: Information Service). It is required that all notifications emitted by the notification IRP support the same header that contains enough information to identify the type of notification, the resource at the origin of the notification and the time of the notification.
192
+
193
+ # Annex A (informative): Change history
194
+
195
+ | Change history | | | | | | | |
196
+ |----------------|-------|-----------|----|-----|--------------------------------------------------------------------------------------------------------------------|-------|--------|
197
+ | Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New |
198
+ | Jun 2001 | S 12 | SP-010283 | -- | -- | Approved at TSG SA #12 and placed under Change Control | 2.0.0 | 4.0.0 |
199
+ | Mar 2002 | -- | -- | -- | -- | Cosmetics (changed styles/field codes on cover/page headings) | 4.0.0 | 4.0.1 |
200
+ | Mar 2002 | S 15 | -- | -- | -- | Automatic upgrade to Rel-5 (no CR) | 4.0.1 | 5.0.0 |
201
+ | Dec 2002 | -- | -- | -- | -- | Cosmetics | 5.0.0 | 5.0.1 |
202
+ | Mar 2004 | S 23 | SP-040105 | -- | -- | Automatic upgrade to Rel-6 (no CR) | 5.0.1 | 6.0.0 |
203
+ | Jun 2005 | -- | -- | -- | -- | Introduction update : added 32.305 new TS-family member | 6.0.0 | 6.0.1 |
204
+ | Jun 2007 | SA_36 | -- | -- | -- | Automatic upgrade to Rel-7 (no CR) at freeze of Rel-7. Deleted reference to CMIP SS, discontinued from R7 onwards. | 6.0.1 | 7.0.0 |
205
+ | Dec 2008 | SA_42 | -- | -- | -- | Upgrade to Release 8 | 7.0.0 | 8.0.0 |
206
+ | Dec 2009 | - | - | - | - | Update to Rel-9 version (MCC) | 8.0.0 | 9.0.0 |
207
+ | Mar 2011 | - | - | - | - | Update to Rel-10 version (MCC) | 9.0.0 | 10.0.0 |
marked/Rel-10/32_series/32302/raw.md ADDED
@@ -0,0 +1,933 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+ # **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; 3GPP TS 32.302 V10.0.0 (2010-09) Telecommunication Management; Configuration Management (CM); Technical Specification Notification Integration Reference Point (IRP); Information Service (IS) (Release 10)** ---
4
+
5
+ ![3GPP logo](935eed7aa61f7777f62cfc032e11bee9_img.jpg)
6
+
7
+ The 3GPP logo, featuring the letters '3GPP' in a stylized, bold font. The '3' is black, 'G' is black, 'P' is black, and 'P' is black. There is a small red signal icon below the 'G' and 'P'. A 'TM' symbol is located to the top right of the logo.
8
+
9
+ 3GPP logo
10
+
11
+ Keywords
12
+ UMTS, management
13
+
14
+ ## **3GPP**
15
+
16
+ Postal address
17
+
18
+ ---
19
+
20
+ 3GPP support office address
21
+
22
+ ---
23
+
24
+ 650 Route des Lucioles - Sophia Antipolis
25
+ Valbonne - FRANCE
26
+ Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
27
+
28
+ Internet
29
+
30
+ ---
31
+
32
+ <http://www.3gpp.org>
33
+
34
+ ## **Copyright Notification**
35
+
36
+ No part may be reproduced except as authorized by written permission.
37
+ The copyright and the foregoing restriction extend to reproduction in all media.
38
+
39
+ © 2010, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TTA, TTC).
40
+ All rights reserved.
41
+
42
+ UMTS™ is a Trade Mark of ETSI registered for the benefit of its members
43
+ 3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
44
+ LTE™ is a Trade Mark of ETSI currently being registered for the benefit of its Members and of the 3GPP Organizational Partners
45
+ GSM® and the GSM logo are registered and owned by the GSM Association
46
+
47
+ # Contents
48
+
49
+ | | |
50
+ |---------------------------------------------------------|----|
51
+ | Foreword ..... | 5 |
52
+ | Introduction ..... | 5 |
53
+ | 1 Scope..... | 7 |
54
+ | 2 References..... | 7 |
55
+ | 3 Definitions and abbreviations ..... | 8 |
56
+ | 3.1 Definitions..... | 8 |
57
+ | 3.2 Abbreviations ..... | 8 |
58
+ | 4 System overview ..... | 9 |
59
+ | 4.1 System Context ..... | 9 |
60
+ | 5 Information Object Classes..... | 9 |
61
+ | 5.1 Imported information entities and local labels..... | 9 |
62
+ | 5.2 Class Diagram ..... | 10 |
63
+ | 5.2.1 Attributes and relationships..... | 10 |
64
+ | 5.2.2 Inheritance ..... | 10 |
65
+ | 5.3 Information object classes definition ..... | 11 |
66
+ | 5.3.1 NtfSubscriber..... | 11 |
67
+ | 5.3.1.1 Definition ..... | 11 |
68
+ | 5.3.1.2 Attributes ..... | 11 |
69
+ | 5.3.2 NtfSubscription..... | 11 |
70
+ | 5.3.2.1 Definition ..... | 11 |
71
+ | 5.3.2.2 Attributes ..... | 11 |
72
+ | 5.3.2.3 State diagram ..... | 12 |
73
+ | 5.3.3 NotificationIRP ..... | 12 |
74
+ | 5.3.3.1 Definition ..... | 12 |
75
+ | 5.4 Information relationship definitions..... | 13 |
76
+ | 5.4.1 relation-ntfSubscriber-ntfSubscription (M)..... | 13 |
77
+ | 5.4.1.1 Definition ..... | 13 |
78
+ | 5.4.1.2 Roles ..... | 13 |
79
+ | 5.4.1.3 Constraints ..... | 13 |
80
+ | 5.4.2 relation-ntfIRP-ntfSubscriber (M)..... | 13 |
81
+ | 5.4.2.1 Definition ..... | 13 |
82
+ | 5.4.2.2 Roles ..... | 13 |
83
+ | 5.4.2.3 Constraints ..... | 13 |
84
+ | 5.5 Information attribute definitions ..... | 14 |
85
+ | 5.5.1 Definitions and legal values ..... | 14 |
86
+ | 5.5.2 Constraints..... | 14 |
87
+ | 6 Interface Definition ..... | 15 |
88
+ | 6.1 Class diagram representing interfaces..... | 15 |
89
+ | 6.2 Generic rules ..... | 15 |
90
+ | 6.3 notificationIRPManagement Interface (M)..... | 16 |
91
+ | 6.3.1 Operation subscribe (M)..... | 16 |
92
+ | 6.3.1.1 Definition ..... | 16 |
93
+ | 6.3.1.2 Input parameters ..... | 16 |
94
+ | 6.3.1.3 Output parameters..... | 16 |
95
+ | 6.3.1.4 Pre-condition..... | 16 |
96
+ | 6.3.1.5 Post-condition ..... | 17 |
97
+ | 6.3.1.6 Exceptions..... | 17 |
98
+ | 6.3.2 Operation unsubscribe (M)..... | 17 |
99
+ | 6.3.2.1 Definition ..... | 17 |
100
+ | 6.3.2.2 Input parameters ..... | 17 |
101
+ | 6.3.2.3 Output parameters..... | 18 |
102
+ | 6.3.2.4 Pre-condition..... | 18 |
103
+ | 6.3.2.5 Post-condition ..... | 18 |
104
+ | 6.3.2.6 Exceptions..... | 18 |
105
+
106
+ | | | |
107
+ |------------------------|---------------------------------------------------|----|
108
+ | 6.4 | subscriberManagement Interface (O)..... | 18 |
109
+ | 6.4.1 | Operation getSubscriptionIds (M) ..... | 18 |
110
+ | 6.4.1.1 | Definition ..... | 18 |
111
+ | 6.4.1.2 | Input parameters ..... | 18 |
112
+ | 6.4.1.3 | Output parameters..... | 19 |
113
+ | 6.4.1.4 | Pre-condition..... | 19 |
114
+ | 6.4.1.5 | Post-condition ..... | 19 |
115
+ | 6.4.1.6 | Exceptions..... | 19 |
116
+ | 6.5 | subscriptionStatusOperations Interface (O) ..... | 19 |
117
+ | 6.5.1 | Operation getSubscriptionStatus (M) ..... | 19 |
118
+ | 6.5.1.1 | Definition ..... | 19 |
119
+ | 6.5.1.2 | Input parameters ..... | 19 |
120
+ | 6.5.1.3 | Output parameters..... | 20 |
121
+ | 6.5.1.4 | Pre-condition..... | 20 |
122
+ | 6.5.1.5 | Post-condition ..... | 20 |
123
+ | 6.5.1.6 | Exceptions..... | 20 |
124
+ | 6.6 | subscriptionFilterOperations Interface (O) ..... | 20 |
125
+ | 6.6.1 | Operation changeSubscriptionFilter (M)..... | 20 |
126
+ | 6.6.1.1 | Definition ..... | 20 |
127
+ | 6.6.1.2 | Input parameters ..... | 20 |
128
+ | 6.6.1.3 | Output parameters..... | 21 |
129
+ | 6.6.1.4 | Pre-condition..... | 21 |
130
+ | 6.6.1.5 | Post-condition ..... | 21 |
131
+ | 6.6.1.6 | Exceptions..... | 21 |
132
+ | 6.7 | subscriptionSuspendOperations Interface (O) ..... | 21 |
133
+ | 6.7.1 | Operation suspendSubscription (M) ..... | 21 |
134
+ | 6.7.1.1 | Definition ..... | 21 |
135
+ | 6.7.1.2 | Input parameters ..... | 21 |
136
+ | 6.7.1.3 | Output parameters..... | 21 |
137
+ | 6.7.1.4 | Pre-condition..... | 22 |
138
+ | 6.7.1.5 | Post-condition ..... | 22 |
139
+ | 6.7.1.6 | Exceptions..... | 22 |
140
+ | 6.7.2 | Operation resumeSubscription (M)..... | 22 |
141
+ | 6.7.2.1 | Definition ..... | 22 |
142
+ | 6.7.2.2 | Input parameters ..... | 22 |
143
+ | 6.7.2.3 | Output parameters..... | 22 |
144
+ | 6.7.2.4 | Pre-condition..... | 22 |
145
+ | 6.7.2.5 | Post-condition ..... | 23 |
146
+ | 6.7.2.6 | Exceptions..... | 23 |
147
+ | 6.8 | IRPManagementOperations Interface (O) ..... | 24 |
148
+ | 6.8.1 | Operation getNotificationCategories (M)..... | 24 |
149
+ | 6.8.1.1 | Definition ..... | 24 |
150
+ | 6.8.1.2 | Input parameters ..... | 24 |
151
+ | 6.8.1.3 | Output parameters..... | 24 |
152
+ | 6.8.1.4 | Pre-condition..... | 24 |
153
+ | 6.8.1.5 | Post-condition ..... | 24 |
154
+ | 6.8.1.6 | Exceptions..... | 24 |
155
+ | 6.9 | NotificationIRPNotification Interface..... | 25 |
156
+ | Annex A (informative): | Change history..... | 27 |
157
+
158
+ # --- Foreword
159
+
160
+ This Technical Specification (TS) has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP).
161
+
162
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
163
+
164
+ Version x.y.z
165
+
166
+ where:
167
+
168
+ - x the first digit:
169
+ - 1 presented to TSG for information;
170
+ - 2 presented to TSG for approval;
171
+ - 3 or greater indicates TSG approved document under change control.
172
+ - y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
173
+ - z the third digit is incremented when editorial only changes have been incorporated in the document.
174
+
175
+ # --- Introduction
176
+
177
+ The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below:
178
+
179
+ - 32.301: Configuration Management (CM); Notification Integration Reference Point (IRP): Requirements
180
+ - 32.302: Configuration Management (CM); Notification Integration Reference Point (IRP): Information Service (IS)**
181
+ - 32.303: Configuration Management (CM); Notification Integration Reference Point (IRP): Common Object Request Broker Architecture (CORBA) Solution Set (SS)
182
+ - 32.305: Configuration Management (CM); Notification Integration Reference Point (IRP): eXtensible Markup Language (XML) definition
183
+ - 32.307: Configuration Management (CM); Notification Integration Reference Point (IRP): Simple Object Access Protocol (SOAP) Solution Set (SS)
184
+
185
+ The Itf-N interface is built up by a number of Integration Reference Points (IRPs) and a related Name Convention, which realise the functional capabilities over this interface. The basic structure of the IRPs is defined in 3GPP TS 32.101 [5] and 3GPP TS 32.102 [6].
186
+
187
+ Network Elements (NEs) under management and element managers generate notifications of events about occurrences within the network. Different kinds of events carry different kinds of information. For instance a new alarm as specified in Alarm IRP: Information Service [1], is one possible kind of event, an object creation as specified in Basic CM IRP: Information Service [8] is another possible kind of event.
188
+
189
+ Information of an event is carried in notification. An IRPAgent (typically an EM or a NE) emits notifications. IRPManager (typically a network management system) receives notifications. The purpose of Notification IRP is to define an interface through which an IRPManager can subscribe to IRPAgent for receiving notifications.
190
+
191
+ This IRP bases its design on work captured in ITU-T Recommendation X.734 [2], OMG Notification Service [4]. The central design ideas are:
192
+
193
+ - Separation of notification Consumers (IRPManagers) from Producers (IRPAgents);
194
+ - Notifications are sent to IRPManagers without the need for IRPManagers to periodically check for new notifications.
195
+
196
+ Common characteristics related to notifications in all other IRPs are gathered in one IRP.
197
+
198
+ # --- 1 Scope
199
+
200
+ The purpose of Notification IRP is to define an interface through which an IRPManager can subscribe to an IRPAgent for receiving notifications. The present document is the "Information Service" of Notification IRP. It defines, for the purpose of subscribing to an IRPAgent for receiving notifications, the information observable and controlled by management system's client and it also specifies the semantics of the interactions used to carry this information. It also defines the information common to all notifications which is called the notificationHeader.
201
+
202
+ An IRPAgent supporting this IRP IS may emit one or multiple categories of notifications, such as alarms (as specified in Alarm IRP: Information Service [1]) and others. This IRP IS defines a mechanism that IRPManager can use to determine the categories of notifications supported by an IRPAgent. It also defines a mechanism (subscribe and unsubscribe operations) that IRPManager can use to specify the categories of notifications IRPAgent should emit to IRPManager during subscription. It also defines a mechanism (getSubscriptionIds operation) that IRPManager can use to check which categories of notifications it has subscribed to. IRPManager can set and change filter criteria applicable during the life-cycle of a subscription. IRPManager can also exercise flow-control on IRPAgent's emission of notifications (suspendSubscription and resumeSubscription operations).
203
+
204
+ Using different managerReference, an IRPManager can subscribe several times. It will result in multiple subscriptions. As far as IRPAgent is concerned, notifications are sent to multiple "places".
205
+
206
+ Using the same managerReference, an IRPManager can subscribe several times specifying different categories of notifications.
207
+
208
+ This IRP IS does not specify information that is carried in some but not all notifications. That kind of information is specified in other IRP ISs involved. For example, *perceivedSeverity* is a piece of information specific for notifications carrying alarm information. This information is not defined in the present document but in Alarm IRP: Information Service [1].
209
+
210
+ How IRPManager discovers the IRPAgent's address or reference (so that IRPManager can invoke an operation) is outside the scope of the present document.
211
+
212
+ # --- 2 References
213
+
214
+ The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
215
+
216
+ - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
217
+ - For a specific reference, subsequent revisions do not apply.
218
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
219
+
220
+ - [1] 3GPP TS 32.111-2: "Telecommunication management; Fault Management; Part 2: Alarm Integration Reference Point (IRP): Information Service (IS)".
221
+ - [2] ITU-T Recommendation X.734 (1992): "Information technology - Open Systems Interconnection - Systems management: Event report management function".
222
+ - [3] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects".
223
+ - [4] OMG: "OMG Notification Service". <http://www.omg.org/technology/documents/>
224
+ - [5] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements".
225
+ - [6] 3GPP TS 32.102: "Telecommunication management; Architecture".
226
+ - [7] 3GPP TS 32.301: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP): Requirements".
227
+
228
+ - [8] 3GPP TS 32.602: "Telecommunication management; Configuration Management (CM); Basic CM Integration Reference Point (IRP): Information Service (IS)".
229
+ - [9] Void.
230
+ - [10] 3GPP TS 32.312: "Telecommunication management; Generic Integration Reference Point (IRP) management: Information Service (IS)".
231
+ - [11] 3GPP TS 32.311: "Telecommunication management; Generic Integration Reference Point (IRP) management: Requirements".
232
+ - [12] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions".
233
+
234
+ # --- 3 Definitions and abbreviations
235
+
236
+ ## 3.1 Definitions
237
+
238
+ For the purposes of the present document, the terms and definitions given in 3GPP TS 32.101 [5], 3GPP TS 32.102 [6] and 3GPP TS 32.301 [7] and the following apply:
239
+
240
+ **IRP Agent:** See 3GPP TS 32.102 [6].
241
+
242
+ **IRP Manager:** See 3GPP TS 32.102 [6].
243
+
244
+ **event:** it is an occurrence that is of significance to network operators, the NEs under surveillance and network management applications
245
+
246
+ Events can indicate many types of network management information, such as network alarms, network configuration change information and network performance data.
247
+
248
+ **notification:** it refers to the transport of information regarding events from event producer to consumer (receiver)
249
+ In this IRP, notification is used to carry information about network events from IRP Agent to IRP Manager. Producer sends notifications to consumers as soon as new events occur. Consumer does not need to check ("pull") for events.
250
+
251
+ **IRP:** See 3GPP TS 32.102 [6].
252
+
253
+ **notification category:** The semantics and syntax of the notification category string are identical to that defined for "IRP document version number string", see 3GPP TS 32.311 [11] subclause 3.1.
254
+
255
+ **qualifiers:** the meaning of qualifiers for operations, parameters and information attributes (whether they are Mandatory(M)/ Conditional(C)/ Optional(O)) defined in the present (Information Service) document is provided in 3GPP TS 32.102 [6].
256
+
257
+ Moreover, qualifiers of information attributes, when those information attributes are re-used in other IRP ISs, obey to the following rule: Mandatory and Conditional qualifiers of information attributes shall always be the same in other IRPs ISs, Optional qualifiers of information attributes may be set to either Optional or Mandatory in the other IRP ISs.
258
+
259
+ ## 3.2 Abbreviations
260
+
261
+ For the purposes of the present document, the following abbreviations apply:
262
+
263
+ | | |
264
+ |-------|-------------------------------------------|
265
+ | CM | Configuration Management |
266
+ | CORBA | Common Object Request Broker Architecture |
267
+ | DN | Distinguished Name |
268
+ | EM | Element Manager |
269
+ | IOC | Information Object Class |
270
+ | IRP | Integration Reference Point |
271
+ | IS | Information Service |
272
+ | NE | Network Element |
273
+ | NM | Network Manager |
274
+ | NR | Network Resource |
275
+ | NRM | Network Resource Model |
276
+ | OMG | Object Management Group |
277
+ | SS | Solution Set |
278
+
279
+ # 4 System overview
280
+
281
+ ## 4.1 System Context
282
+
283
+ The general definition of the System Context for the present IRP is found in 3GPP TS 32.150 [12] subclause 4.7.
284
+
285
+ In addition, the set of related IRP(s) relevant to the present IRP is shown in figure 1 and figure 2.
286
+
287
+ ![Figure 1: System Context A. A UML diagram showing an IRPManager (NM) connected to an IRPAgent (EM), which is connected to multiple NEs. A dashed vertical line separates the NM and EM. A curved arrow labeled 'Itf-N' points from the EM side to the NM side, with the text 'Notification IRP' next to it.](b28af4985cdef1e519e3aaf26561dcb3_img.jpg)
288
+
289
+ The diagram illustrates System Context A. On the left, a box labeled 'IRPManager' is associated with 'NM'. On the right, a box labeled 'IRPAgent' is associated with 'EM'. A solid horizontal line connects the IRPManager and the IRPAgent. To the right of the IRPAgent, a dotted line connects it to a box labeled 'NEs'. A dashed vertical line runs between the IRPManager and the IRPAgent. A curved arrow labeled 'Itf-N' originates from the IRPAgent side and points towards the IRPManager side, with the text 'Notification IRP' positioned next to the arrow.
290
+
291
+ Figure 1: System Context A. A UML diagram showing an IRPManager (NM) connected to an IRPAgent (EM), which is connected to multiple NEs. A dashed vertical line separates the NM and EM. A curved arrow labeled 'Itf-N' points from the EM side to the NM side, with the text 'Notification IRP' next to it.
292
+
293
+ Figure 1: System Context A
294
+
295
+ ![Figure 2: System Context B. A UML diagram showing an IRPManager (NM) connected to an IRPAgent (NE). A dashed vertical line separates the NM and NE. A curved arrow labeled 'Itf-N' points from the NE side to the NM side, with the text 'Notification IRP' next to it.](0bf9346902e9a3bdabf05ceacc1947f5_img.jpg)
296
+
297
+ The diagram illustrates System Context B. On the left, a box labeled 'IRPManager' is associated with 'NM'. On the right, a box labeled 'IRPAgent' is associated with 'NE'. A solid horizontal line connects the IRPManager and the IRPAgent. A dashed vertical line runs between the IRPManager and the IRPAgent. A curved arrow labeled 'Itf-N' originates from the IRPAgent side and points towards the IRPManager side, with the text 'Notification IRP' positioned next to the arrow.
298
+
299
+ Figure 2: System Context B. A UML diagram showing an IRPManager (NM) connected to an IRPAgent (NE). A dashed vertical line separates the NM and NE. A curved arrow labeled 'Itf-N' points from the NE side to the NM side, with the text 'Notification IRP' next to it.
300
+
301
+ Figure 2: System Context B
302
+
303
+ # 5 Information Object Classes
304
+
305
+ ## 5.1 Imported information entities and local labels
306
+
307
+ | Label reference | Local label |
308
+ |-----------------------------------------------------|-------------------|
309
+ | 3GPP TS 32.312 [10], Support IOC, ManagedGenericIRP | ManagedGenericIRP |
310
+
311
+ ## 5.2 Class Diagram
312
+
313
+ ### 5.2.1 Attributes and relationships
314
+
315
+ This subclause depicts the set of Support IOCs that encapsulate information within the notification IRP. The intent is to identify the information required for the notification IRP implementation of its operations and notification emission.
316
+
317
+ This subclause provides the overview of all Support IOCs in UML. Subsequent subclauses provide more detailed specification of various aspects of these Support IOCs.
318
+
319
+ ![UML Class Diagram showing relationships between NotificationIRP, NtfSubscriber, and NtfSubscription.](daa4a6fa7e2ba1954258f86b4928eb32_img.jpg)
320
+
321
+ ```
322
+ classDiagram
323
+ class NotificationIRP {
324
+ <<SupportIOC>>
325
+ }
326
+ class NtfSubscriber {
327
+ <<SupportIOC>>
328
+ }
329
+ class NtfSubscription {
330
+ <<SupportIOC>>
331
+ }
332
+ NotificationIRP "1" *-- "0..n" NtfSubscriber : +theNotificationIRP
333
+ NtfSubscriber "1" -- "1..n" NtfSubscription : +theNtfSubscriber, +theNtfSubscription
334
+ ```
335
+
336
+ The diagram illustrates three classes: **<<SupportIOC>> NotificationIRP**, **<<SupportIOC>> NtfSubscriber**, and **<<SupportIOC>> NtfSubscription**. **NotificationIRP** has a composition relationship with **NtfSubscriber** (multiplicity 1 to 0..n), labeled **+theNotificationIRP** and **relation-ntfIRP-ntfSubscriber**. **NtfSubscriber** has an association relationship with **NtfSubscription** (multiplicity 1 to 1..n), labeled **+theNtfSubscriber** and **+theNtfSubscription**, and **relation-ntfSubscriber-ntfSubscription**.
337
+
338
+ UML Class Diagram showing relationships between NotificationIRP, NtfSubscriber, and NtfSubscription.
339
+
340
+ ### 5.2.2 Inheritance
341
+
342
+ This subclause depicts the inheritance relationships that exist between Support IOCs.
343
+
344
+ ![UML Class Diagram showing inheritance from NotificationIRP to ManagedGenericIRP.](c2fc2621e8206d24427b56bcb2398fc0_img.jpg)
345
+
346
+ ```
347
+ classDiagram
348
+ class ManagedGenericIRP {
349
+ <<SupportIOC>>
350
+ (from TS 32.312)
351
+ }
352
+ class NotificationIRP {
353
+ <<SupportIOC>>
354
+ }
355
+ NotificationIRP --|> ManagedGenericIRP
356
+ ```
357
+
358
+ The diagram shows an inheritance relationship where **<<SupportIOC>> NotificationIRP** inherits from **<<SupportIOC>> ManagedGenericIRP (from TS 32.312)**.
359
+
360
+ UML Class Diagram showing inheritance from NotificationIRP to ManagedGenericIRP.
361
+
362
+ ## 5.3 Information object classes definition
363
+
364
+ ### 5.3.1 NtfSubscriber
365
+
366
+ #### 5.3.1.1 Definition
367
+
368
+ This Support IOC represents a Subscriber from a notification IRP perspective : a subscriber is fully identified by a manager reference. An IRPManager using multiple managerReference attributes to subscribe will result in multiple NtfSubscriber instances.
369
+
370
+ #### 5.3.1.2 Attributes
371
+
372
+ | Attribute name | Support Qualifier | Read Qualifier | Write Qualifier |
373
+ |---------------------|-------------------|----------------|-----------------|
374
+ | ntfManagerReference | M | M | M |
375
+
376
+ ### 5.3.2 NtfSubscription
377
+
378
+ #### 5.3.2.1 Definition
379
+
380
+ This Support IOC represents a subscription that has been requested by an IRPManager and created.
381
+
382
+ #### 5.3.2.2 Attributes
383
+
384
+ | Attribute name | Support Qualifier | Read Qualifier | Write Qualifier |
385
+ |----------------------------|-------------------|----------------|-----------------|
386
+ | ntfSubscriptionId | M | M | - |
387
+ | ntfSubscriptionState | M | M | M |
388
+ | ntfTimeTick | M | M | M |
389
+ | ntfTimeTickTimer | M | - | - |
390
+ | ntfNotificationCategorySet | M | M | M |
391
+ | ntfFilter | M | M | M |
392
+
393
+ #### 5.3.2.3 State diagram
394
+
395
+ The diagram below depicts states that can be supported by a NtfSubscription.
396
+
397
+ ![State diagram for NtfSubscription showing states notSuspended and suspended, with transitions for subscribe, suspendSubscription, resumeSubscription, and unsubscribe.](7f17c430b9598e4d748a8041457810b3_img.jpg)
398
+
399
+ ```
400
+
401
+ stateDiagram-v2
402
+ [*] --> notSuspended : subscribe / ntfTimeTickTimer initialised
403
+ notSuspended --> notSuspended : resumeSubscription
404
+ notSuspended --> notSuspended : ntfTimeTickTimer=0 / ntfSubscription is not deleted
405
+ notSuspended --> notSuspended : getSubscriptionStatus / ntfTimeTickTimer re-initialised
406
+ notSuspended --> suspended : suspendSubscription
407
+ suspended --> notSuspended : resumeSubscription
408
+ suspended --> suspended : suspendSubscription
409
+ notSuspended --> [*] : ntfTimeTickTimer=0 / ntfSubscription (and possibly ntfSubscriber) is deleted.
410
+ suspended --> [*] : unSubscribe / ntfSubscription (and possibly ntfSubscriber) is deleted
411
+
412
+ ```
413
+
414
+ The state diagram illustrates the lifecycle of a `NtfSubscription`. It begins at an initial state, transitioning to `notSuspended` via a `subscribe` event that initializes the `ntfTimeTickTimer`. From `notSuspended`, a `resumeSubscription` event loops back to the same state, while a `suspendSubscription` event transitions to the `suspended` state. From `suspended`, a `resumeSubscription` event returns to `notSuspended`. Both states can transition to the final state: `notSuspended` via a `ntfTimeTickTimer=0` event (deleting the subscription and possibly the subscriber) or `suspended` via an `unSubscribe` event (also deleting the subscription and possibly the subscriber). Additionally, `notSuspended` has self-transitions for `ntfTimeTickTimer=0` (if the subscription is not deleted) and `getSubscriptionStatus` (re-initializing the timer).
415
+
416
+ State diagram for NtfSubscription showing states notSuspended and suspended, with transitions for subscribe, suspendSubscription, resumeSubscription, and unsubscribe.
417
+
418
+ NotificationIRP can lose the list of `managerReference` that identifies current IRPManagers under subscription. Under this condition, IRPAgent is incapable of sending events to the affected subscriber(s).
419
+
420
+ This Notification IRP recommends that IRPManager should invoke the `getSubscriptionStatus` operation periodically to confirm that IRPAgent still has the IRPManager's reference in its list. In case `getSubscriptionStatus` returns the exception `operation_failed`, IRPManager should assume that IRPAgent has lost the IRPManager's reference.
421
+
422
+ This IRP does not recommend the frequency IRPManager should use to invoke `getSubscriptionStatus` operation.
423
+
424
+ ### 5.3.3 NotificationIRP
425
+
426
+ #### 5.3.3.1 Definition
427
+
428
+ This Support IOC represents a notification IRP. It inherits from Support IOC `ManagedGenericIRP`.
429
+
430
+ ## 5.4 Information relationship definitions
431
+
432
+ ### 5.4.1 relation-ntfSubscriber-ntfSubscription (M)
433
+
434
+ #### 5.4.1.1 Definition
435
+
436
+ This relationship defines the relationship between a NtfSubscriber and its current subscriptions.
437
+
438
+ #### 5.4.1.2 Roles
439
+
440
+ | Name | Definition |
441
+ |--------------------|-------------------------------------------------------------------------------------------------------------------------------------------|
442
+ | theNtfSubscriber | This role represents the one who has subscribed. It can be played by instances of Support IOC NtfSubscriber |
443
+ | theNtfSubscription | This role represents the subscriptions which were made and not unsubscribed. It can be played by instances of Support IOC NtfSubscription |
444
+
445
+ #### 5.4.1.3 Constraints
446
+
447
+ | Name | Definition |
448
+ |---------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
449
+ | inv_notificationCategoriesAllDistinct | The notification categories contained in the ntfNotificationCategorySet attribute of NtfSubscription playing the role theNtfSubscription are all distinct from each other. |
450
+
451
+ ### 5.4.2 relation-ntfIRP-ntfSubscriber (M)
452
+
453
+ #### 5.4.2.1 Definition
454
+
455
+ This relationship defines the relationship between the NotificationIRP and the current subscribers of notifications.
456
+
457
+ #### 5.4.2.2 Roles
458
+
459
+ | Name | Definition |
460
+ |--------------------|------------------------------------------------------------------------------------------------------------------------------------------|
461
+ | theNtfSubscriber | This role represents the entities to which IRPAgent will notify events. It is played by instances of Support IOC NtfSubscriber |
462
+ | theNotificationIRP | This role represents the NotificationIRP to which an IRPManager has subscribed. It is played by instances of Support IOC NotificationIRP |
463
+
464
+ #### 5.4.2.3 Constraints
465
+
466
+ | Name | Definition |
467
+ |----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
468
+ | inv_uniqueManagerReference | All NtfSubscriber involved in the subscriptionRegistration relationship with NotificationIRP are distinguished from each other by their ntfManagerReference Attribute. |
469
+
470
+ ## 5.5 Information attribute definitions
471
+
472
+ This subclause defines the semantics of the Attributes used in Support IOCs.
473
+
474
+ ### 5.5.1 Definitions and legal values
475
+
476
+ | Attribute Name | Definition | Legal Values |
477
+ |----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------|
478
+ | ntfSubscriptionId | It identifies uniquely a subscription | N/A |
479
+ | ntfSubscriptionState | It indicates the activation state of a subscription | "suspended": the subscription is suspended<br>"notSuspended": the subscription is active |
480
+ | ntfTimeTick | this Attribute represents the initial value of ntfTimeTickTimer. It is in unit of whole minute. This value defines a time window within which IRPManager intends to invoke <code>getSubscriptionStatus</code> (or <code>subscribe</code> ) operation to confirm its subscription. A special value indicates infinity which is such that timer will never expire and IRPAgent needs other means to decide when to delete resources allocated to the IRPManager | Integer greater or equal to 15, OR special infinite value |
481
+ | ntfTimeTickTimer | this Attribute represents the current value of a timer | integer greater or equal to zero |
482
+ | ntfNotificationCategorySet | this Attribute represents a set of notification categories (see also Definition of notification category in subclause 3.1) | |
483
+ | ntfFilter | this Attribute represents the filter of a subscription. The filter can be applied to parameters of notification header (see <code>NotificationIRPNotification</code> interface) and to parameters of notifications defined as filterable in other IRP ISs. IRPAgent shall notify IRPManagers if the event satisfies the filter constraint. | |
484
+ | ntfManagerReference | this Attribute contains the reference of a manager. It uniquely identifies a subscriber | |
485
+
486
+ ### 5.5.2 Constraints
487
+
488
+ - "ntfTimeTickTimer is lower or equal to ntfTimeTick".
489
+
490
+ # 6 Interface Definition
491
+
492
+ ## 6.1 Class diagram representing interfaces
493
+
494
+ ![UML Class diagram showing the NotificationIRP interface and its associated interfaces.](9b6b5924b48bf2fd5f347f88f06f45b3_img.jpg)
495
+
496
+ ```
497
+
498
+ classDiagram
499
+ class SubscriptionStatusOperations {
500
+ <<Interface>>
501
+ getSubscriptionStatus()
502
+ }
503
+ class SubscriptionFilterOperations {
504
+ <<Interface>>
505
+ changeSubscriptionFilter()
506
+ }
507
+ class SubscriptionSuspendOperations {
508
+ <<Interface>>
509
+ suspendSubscription()
510
+ resumeSubscription()
511
+ }
512
+ class IRPManagementOperations {
513
+ <<Interface>>
514
+ getNotificationCategories()
515
+ }
516
+ class NotificationIRPManagement {
517
+ <<Interface>>
518
+ subscribe()
519
+ unsubscribe()
520
+ }
521
+ class SubscriberManagement {
522
+ <<Interface>>
523
+ getSubscriptionIds()
524
+ }
525
+ class NotificationIRP {
526
+ <<SupportIOC>>
527
+ }
528
+ class NotificationIRPNotification {
529
+ <<Interface>>
530
+ notify()
531
+ }
532
+
533
+ NotificationIRP --> SubscriptionStatusOperations : <<may realize>>
534
+ NotificationIRP --> SubscriptionFilterOperations : <<may realize>>
535
+ NotificationIRP --> SubscriptionSuspendOperations : <<may realize>>
536
+ NotificationIRP --> IRPManagementOperations : <<may realize>>
537
+ NotificationIRP --> NotificationIRPManagement : <<may realize>>
538
+ NotificationIRP --> SubscriberManagement : <<may realize>>
539
+ NotificationIRP --> NotificationIRPNotification : <<use>> 0..1
540
+
541
+ ```
542
+
543
+ This <<interface>> defines the notificationHeader. Other <<interface>>, such as AlarmIRPNotification, inherits from this <<interface>> and the notifications emitted by these other <<interface>> shall support the inherited notificationHeader.
544
+
545
+ UML Class diagram showing the NotificationIRP interface and its associated interfaces.
546
+
547
+ ## 6.2 Generic rules
548
+
549
+ - Rule 1:** Each operation with at least one input parameter supports a pre-condition `valid_input_parameter` which indicates that all input parameters shall be valid with regards to their information type. Additionally, each such operation supports an exception `operation_failed_invalid_input_parameter` which is raised when pre-condition `valid_input_parameter` is false. The exception has the same entry and exit state.
550
+ - Rule 2:** Each operation with at least one optional input parameter supports a set of pre-conditions `supported_optional_input_parameter_xxx` where "xxx" is the name of the optional input parameter and the pre-condition indicates that the operation supports the named optional input parameter. Additionally, each such operation supports an exception `operation_failed_unsupported_optional_input_parameter_xxx` which is raised when (a) the pre-condition `supported_optional_input_parameter_xxx` is false and (b) the named optional input parameter is carrying information. The exception has the same entry and exit state.
551
+ - Rule 3:** Each operation shall support a generic exception `operation_failed_internal_problem` which is raised when an internal problem occurs and that the operation cannot be completed. The exception has the same entry and exit state.
552
+
553
+ ## 6.3 notificationIRPManagement Interface (M)
554
+
555
+ ### 6.3.1 Operation `subscribe` (M)
556
+
557
+ #### 6.3.1.1 Definition
558
+
559
+ IRPManager invokes this operation to establish subscription to receive network events via notifications, under the filter constraint specified in this operation.
560
+
561
+ #### 6.3.1.2 Input parameters
562
+
563
+ | Parameter Name | Qualifier | Information Type | Comment |
564
+ |------------------------|-----------|----------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
565
+ | managerReference | M | NtfSubscriber.ntfManagerReference | It specifies the reference of IRPManager to which notifications shall be sent. |
566
+ | timeTick | O | NtfSubscription.ntfTimeTick | It specifies the value of a timer hold by NotificationIRP for the subject IRPManager.<br>The value is in unit of whole minute.<br>A special infinite value is assumed when parameter is absent or present but equal to zero. |
567
+ | notificationCategories | O | SET OF (name of IRP, version of IRP) | It identifies one or more Notification Category (see also Definition in subclause 3.1) |
568
+ | filter | O | NtfSubscription.ntfFilter<br><br>Filter constraint grammar is SS dependent | It specifies a filter constraint that IRPAgent shall use to filter notification of the category specified in notificationCategories parameter.<br>If this parameter is absent, then no filter constraint shall be applied. |
569
+
570
+ #### 6.3.1.3 Output parameters
571
+
572
+ | Parameter Name | Qualifier | Matching Information | Comment |
573
+ |----------------|-----------|---------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
574
+ | subscriptionId | M | NtfSubscription.ntfSubscriptionId | It holds an unambiguous identity of this subscription. |
575
+ | status | M | ENUM (OperationSucceeded, OperationFailedExistingSubscription, OperationFailed) | If subscriptionCreated is true, status = OperationSucceeded.<br>If operation_failed_existing_subscription is true, status = OperationFailedExistingSubscription<br>If operation_failed is true, status = OperationFailed. |
576
+
577
+ #### 6.3.1.4 Pre-condition
578
+
579
+ notificationCategoriesNotAllSubscribed OR notificationCategoriesParameterAbsentAndNotAllSubscribed.
580
+
581
+ | Assertion Name | Definition |
582
+ |----------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
583
+ | notificationCategoriesNotAllSubscribed | At least one notificationCategory identified in the notificationCategories input parameter is supported by IRPAgent and is not a member of the ntfNotificationCategorySet attribute of an NtfSubscription which is involved in a subscription relationship with the NtfSubscriber identified by the managerReference input parameter. |
584
+ | notificationCategoriesParameterAbsentAndNotAllSubscribed | The notificationCategories input parameter is absent and at least one notificationCategory supported by IRPAgent is not a member of the ntfNotificationCategorySet attribute of an ntfSubscription which is involved in a subscription relationship with the NtfSubscriber identified by the managerReference input parameter. |
585
+
586
+ #### 6.3.1.5 Post-condition
587
+
588
+ subscriberPossiblyCreated AND subscriptionCreated.
589
+
590
+ | Assertion Name | Definition |
591
+ |---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
592
+ | subscriberPossiblyCreated | An NtfSubscriber with a ntfManagerReference attribute equal to the value of the managerReference input parameter is involved in a subscriptionRegistration relationship with NotificationIRP. |
593
+ | subscriptionCreated | An NtfSubscription has been created according to the following rules: <ul style="list-style-type: none"> <li>ntfSubscriptionState attribute value has been set to "notSuspended";</li> <li>ntfTimeTick attribute value has been set to the value of the timeTick input parameter if this value was higher or equal to 15, or set to 15 if this parameter value was between 1 and 15, or set to a special infinite value if the parameter value was lower or equal to 0 or if parameter was absent;</li> <li>ntfTimeTickTimer has been reset with the value of timeTick attribute;</li> <li>ntfFilter attribute value has been set to the value of the filter input parameter if present;</li> <li>NtfSubscription is involved in a subscription relationship with the NtfSubscriber identified by the managerReference input parameter;</li> <li>attribute ntfNotificationCategorySet of NtfSubscription contains EITHER the notification categories identified by the notificationCategories input parameter that were not already contained in the ntfNotificationCategorySet attribute of other NtfSubscription of the same NtfSubscriber identified by the managerReference input parameter OR if notificationCategories input parameter is absent, all notification categories supported by IRPAgent that were not already contained in the ntfNotificationCategorySet attribute of other subscriptions of the same NtfSubscriber identified by the managerReference input parameter.</li> </ul> |
594
+
595
+ #### 6.3.1.6 Exceptions
596
+
597
+ | Name | Definition |
598
+ |----------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
599
+ | operation_failed_existing_subscription | <b>Condition:</b> (notificationCategoriesNotAllSubscribed OR notificationCategoriesParameterAbsentAndNotAllSubscribed) not true<br><b>Returned Information:</b> The output parameter status<br><b>Exit state:</b> Entry State |
600
+ | Operation_failed | <b>Condition:</b> Post-condition is false<br><b>Returned Information:</b> The output parameter status<br><b>Exit state:</b> Entry State |
601
+
602
+ ### 6.3.2 Operation unsubscribe (M)
603
+
604
+ #### 6.3.2.1 Definition
605
+
606
+ The IRPManager invokes this operation to cancel subscriptions. The IRPManager can cancel one subscription made with a managerReference by providing the corresponding subscriptionId or all subscriptions made with the same managerReference by leaving the subscriptionId parameter absent.
607
+
608
+ #### 6.3.2.2 Input parameters
609
+
610
+ | Parameter Name | Qualifier | Information Type | Comment |
611
+ |------------------|-----------|-----------------------------------|---------------------------------------------------------------------------------------|
612
+ | managerReference | M | NtfSubscriber.ntfManagerReference | It specifies the reference of an IRPManager. |
613
+ | subscriptionId | O | NtfSubscription.ntfSubscriptionId | It holds a subscriptionId carried as the output parameter in the subscribe operation. |
614
+
615
+ #### 6.3.2.3 Output parameters
616
+
617
+ | Parameter Name | Qualifier | Matching Information | Comment |
618
+ |----------------|-----------|-----------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|
619
+ | status | M | ENUM<br>(OperationSucceeded, OperationFailed) | If (subscriptionDeleted OR allSubscriptionDeleted) is true, status = OperationSucceeded.<br>If operation_failed is true, status = OperationFailed. |
620
+
621
+ #### 6.3.2.4 Pre-condition
622
+
623
+ validSubscriptionId&ManagerReference OR SubscriptionIdAbsent&ValidManagerReference
624
+
625
+ | Assertion Name | Definition |
626
+ |--------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
627
+ | validSubscriptionId&ManagerReference | The NtfSubscription identified by subscriptionId input parameter is involved in a subscription relationship with the NtfSubscriber identified by the managerReference input parameter. |
628
+ | SubscriptionIdAbsent&ValidManagerReference | The subscriptionId input parameter is absent and the NtfSubscriber identified by the managerReference input parameter exists. |
629
+
630
+ #### 6.3.2.5 Post-condition
631
+
632
+ subscriptionDeleted OR allSubscriptionDeleted.
633
+
634
+ | Assertion Name | Definition |
635
+ |------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
636
+ | subscriptionDeleted | The NtfSubscription identified by subscriptionId input parameter is no more involved in a subscription relationship with the NtfSubscriber identified by the managerReference input parameter and has been deleted. If this NtfSubscriber has no more NtfSubscription, it is deleted as well. |
637
+ | allSubscriptionDeleted | In the case subscriptionId input parameter was absent, the NtfSubscriber identified by the managerReference input parameter is no more involved in any subscription relationship and is deleted, the corresponding NtfSubscription have been deleted as well. |
638
+
639
+ #### 6.3.2.6 Exceptions
640
+
641
+ | Name | Definition |
642
+ |------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|
643
+ | Operation_failed | <b>Condition:</b> Pre-condition is false or post-condition is false<br><b>Returned Information:</b> The output parameter status<br><b>Exit state:</b> Entry State |
644
+
645
+ ## 6.4 subscriberManagement Interface (O)
646
+
647
+ ### 6.4.1 Operation getSubscriptionIds (M)
648
+
649
+ #### 6.4.1.1 Definition
650
+
651
+ IRPManager invokes this operation to get the values of all still valid (not unsubscribed or removed by IRPAgent) subscriptionIds assigned by NotificationIRP as result of previously subscribe operations performed by this IRPManager.
652
+
653
+ #### 6.4.1.2 Input parameters
654
+
655
+ | Parameter Name | Qualifier | Information Type | Comment |
656
+ |------------------|-----------|-----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|
657
+ | managerReference | M | NtfSubscriber.ntfManagerReference | It specifies the reference of IRPManager that requests the set of identifiers of active subscriptions related to this IRPManager. |
658
+
659
+ #### 6.4.1.3 Output parameters
660
+
661
+ | Parameter Name | Qualifier | Matching Information | Comment |
662
+ |-------------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
663
+ | subscriptionIdSet | M | SET OF NtfSubscription.ntfSubscriptionId where NtfSubscription is involved in a subscription relationship with the NtfSubscriber identified by the managerReference input parameter | It holds a set of the subscriptionId, each assigned as output parameter in previous subscribe operations invoked by the current IRPManager. This value should contain no information if the IRPManager did not yet subscribed to that System or System lost all subscription related information. |
664
+ | status | M | ENUM (Operation succeeded, Operation failed) | If validSubscriptionIdSet is true, status = OperationSucceeded.<br>If operation_failed is true, status = OperationFailed. |
665
+
666
+ #### 6.4.1.4 Pre-condition
667
+
668
+ validManagerReference.
669
+
670
+ | Assertion Name | Definition |
671
+ |-----------------------|------------------------------------------------------------------------------|
672
+ | validManagerReference | The NtfSubscriber identified by the managerReference input parameter exists. |
673
+
674
+ #### 6.4.1.5 Post-condition
675
+
676
+ None specific
677
+
678
+ #### 6.4.1.6 Exceptions
679
+
680
+ | Name | Definition |
681
+ |------------------|----------------------------------------------------------------------------------------------------------------------------------------|
682
+ | Operation_failed | <b>Condition:</b> Pre-condition is false<br><b>Returned Information:</b> The output parameter status<br><b>Exit state:</b> Entry State |
683
+
684
+ ## 6.5 subscriptionStatusOperations Interface (O)
685
+
686
+ ### 6.5.1 Operation getSubscriptionStatus (M)
687
+
688
+ #### 6.5.1.1 Definition
689
+
690
+ IRPManager invokes this operation to query the subscription status of a particular subscription. IRPManager can use getSubscriptionStatus operation to know about the filter constraint in effect, the state of subscription (i.e. if subscription is suspended/inactive or resumed/active), the timeTick value that may be set at subscribe invocation time and the notificationCategory currently in used in the subscription.
691
+
692
+ #### 6.5.1.2 Input parameters
693
+
694
+ | Parameter Name | Qualifier | Information Type | Comment |
695
+ |----------------|-----------|-----------------------------------|----------------------------------------------------------------------------------------|
696
+ | subscriptionId | M | NtfSubscription.ntfSubscriptionId | It holds the subscriptionId carried as the output parameter in the subscribe operation |
697
+
698
+ #### 6.5.1.3 Output parameters
699
+
700
+ | Parameter Name | Qualifier | Matching Information | Comment |
701
+ |-------------------------|-----------|----------------------------------------------|--------------------------------------------------------------------------------------------------------------------|
702
+ | notificationCategorySet | C | NtfSubscription.ntfNotificationCategorySet | It identifies the notification Category(ies) supported in this subscription. |
703
+ | filterInEffect | O | NtfSubscription.ntfFilter | It contains the filter constraint currently set. |
704
+ | SubscriptionState | O | NtfSubscription.ntfSubscriptionState | |
705
+ | timeTick | O | NtfSubscription.ntfTimeTick | It carries the same value as the one in subscribe operation |
706
+ | status | M | ENUM (Operation succeeded, Operation failed) | If (timeTickReset) is true, status = OperationSucceeded.<br>If operation_failed is true, status = OperationFailed. |
707
+
708
+ #### 6.5.1.4 Pre-condition
709
+
710
+ validSubscriptionId.
711
+
712
+ | Assertion Name | Definition |
713
+ |---------------------|---------------------------------------------------------------------------------------------------------------|
714
+ | validSubscriptionId | "the NtfSubscription identified by subscriptionId input parameter is involved in a subscription relationship" |
715
+
716
+ #### 6.5.1.5 Post-condition
717
+
718
+ timeTickReset
719
+
720
+ | Assertion Name | Definition |
721
+ |----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
722
+ | timeTickReset | The ntfTimeTickTimer attribute of NtfSubscription identified as input parameter has been reset with the value of ntfTimeTick attribute of the same NtfSubscription. |
723
+
724
+ #### 6.5.1.6 Exceptions
725
+
726
+ | Name | Definition |
727
+ |------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|
728
+ | Operation_failed | <b>Condition:</b> Pre-condition is false or post-condition is false<br><b>Returned Information:</b> The output parameter status<br><b>Exit state:</b> Entry State |
729
+
730
+ ## 6.6 subscriptionFilterOperations Interface (O)
731
+
732
+ ### 6.6.1 Operation changeSubscriptionFilter (M)
733
+
734
+ #### 6.6.1.1 Definition
735
+
736
+ IRPManager invokes this operation to replace the present filter constraint with a new one.
737
+
738
+ #### 6.6.1.2 Input parameters
739
+
740
+ | Parameter Name | Qualifier | Information Type | Comment |
741
+ |----------------|-----------|-----------------------------------|-------------------------------------------------------------------------------------------|
742
+ | subscriptionId | M | NtfSubscription.ntfSubscriptionId | It carries the subscriptionId carried as the output parameter in the subscribe operation. |
743
+ | filter | M | NtfSubscription.ntfFilter | It specifies a filter constraint |
744
+
745
+ #### 6.6.1.3 Output parameters
746
+
747
+ | Parameter Name | Qualifier | Matching Information | Comment |
748
+ |----------------|-----------|----------------------------------------------|------------------------------------------------------------------------------------------------------------------|
749
+ | status | M | ENUM (Operation succeeded, Operation failed) | If filterUpdated is true, status = OperationSucceeded.<br>If operation_failed is true, status = OperationFailed. |
750
+
751
+ #### 6.6.1.4 Pre-condition
752
+
753
+ validNtfSubscriptionId.
754
+
755
+ | Assertion Name | Definition |
756
+ |------------------------|--------------------------------------------------------------------------------------------------------------|
757
+ | validNtfSubscriptionId | The NtfSubscription identified by subscriptionId input parameter is involved in a subscription relationship. |
758
+
759
+ #### 6.6.1.5 Post-condition
760
+
761
+ filterUpdated.
762
+
763
+ | Assertion Name | Definition |
764
+ |----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
765
+ | filterUpdated | The ntfFilter attribute value of the NtfSubscription identified by subscriptionId input parameter has been set to the value of the filter input parameter. |
766
+
767
+ #### 6.6.1.6 Exceptions
768
+
769
+ | Name | Definition |
770
+ |------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|
771
+ | Operation_failed | <b>Condition:</b> Pre-condition is false or post-condition is false<br><b>Returned Information:</b> The output parameter status<br><b>Exit state:</b> Entry State |
772
+
773
+ ## 6.7 subscriptionSuspendOperations Interface (O)
774
+
775
+ ### 6.7.1 Operation suspendSubscription (M)
776
+
777
+ #### 6.7.1.1 Definition
778
+
779
+ IRPManager invokes this operation to request IRPAgent to stop emission of notifications. IRPAgent may lose notification(s) if subscription is suspended.
780
+
781
+ #### 6.7.1.2 Input parameters
782
+
783
+ | Parameter Name | Qualifier | Information Type | Comment |
784
+ |----------------|-----------|-----------------------------------|-------------------------------------------------------------------------------------------|
785
+ | subscriptionId | M | NtfSubscription.ntfSubscriptionId | It carries the subscriptionId carried as the output parameter in the subscribe operation. |
786
+
787
+ #### 6.7.1.3 Output parameters
788
+
789
+ | Parameter Name | Qualifier | Matching Information | Comment |
790
+ |----------------|-----------|----------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|
791
+ | status | M | ENUM (Operation succeeded, Operation failed) | If subscriptionStateSuspended is true, status = OperationSucceeded.<br>If operation_failed is true, status = OperationFailed. |
792
+
793
+ #### 6.7.1.4 Pre-condition
794
+
795
+ validSubscriptionId.
796
+
797
+ | Assertion Name | Definition |
798
+ |---------------------|--------------------------------------------------------------------------------------------------------------|
799
+ | validSubscriptionId | The NtfSubscription identified by subscriptionId input parameter is involved in a subscription relationship. |
800
+
801
+ #### 6.7.1.5 Post-condition
802
+
803
+ subscriptionStateSuspended.
804
+
805
+ | Assertion Name | Definition |
806
+ |----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|
807
+ | subscriptionStateSuspended | The ntfSubscriptionState attribute value of the NtfSubscription identified by subscriptionId input parameter has been set to or kept as "suspended". |
808
+
809
+ #### 6.7.1.6 Exceptions
810
+
811
+ | Name | Definition |
812
+ |------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|
813
+ | Operation_failed | <b>Condition:</b> Pre-condition is false or post-condition is false<br><b>Returned Information:</b> The output parameter status<br><b>Exit state:</b> Entry State |
814
+
815
+ ### 6.7.2 Operation resumeSubscription (M)
816
+
817
+ #### 6.7.2.1 Definition
818
+
819
+ IRPManager invokes this operation to request IRPAgent to resume emission of notifications.
820
+
821
+ #### 6.7.2.2 Input parameters
822
+
823
+ | Parameter Name | Qualifier | Information Type | Comment |
824
+ |----------------|-----------|-----------------------------------|-------------------------------------------------------------------------------------------|
825
+ | subscriptionId | M | NtfSubscription.ntfSubscriptionId | It carries the subscriptionId carried as the output parameter in the subscribe operation. |
826
+
827
+ #### 6.7.2.3 Output parameters
828
+
829
+ | Parameter Name | Qualifier | Matching Information | Comment |
830
+ |----------------|-----------|----------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------|
831
+ | status | M | ENUM (Operation succeeded, Operation failed) | If subscriptionStateNotSuspended is true, status = OperationSucceeded.<br>If operation_failed is true, status = OperationFailed. |
832
+
833
+ #### 6.7.2.4 Pre-condition
834
+
835
+ validSubscriptionId.
836
+
837
+ | Assertion Name | Definition |
838
+ |---------------------|--------------------------------------------------------------------------------------------------------------|
839
+ | validSubscriptionId | The NtfSubscription identified by subscriptionId input parameter is involved in a subscription relationship. |
840
+
841
+ #### 6.7.2.5 Post-condition
842
+
843
+ subscriptionStateNotSuspended.
844
+
845
+ | Assertion Name | Definition |
846
+ |-------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
847
+ | subscriptionStateNotSuspended | The ntfSubscriptionState attribute value of the NtfSubscription identified by subscriptionId input parameter has been set to or kept as "notSuspended". |
848
+
849
+ #### 6.7.2.6 Exceptions
850
+
851
+ | Name | Definition |
852
+ |------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|
853
+ | Operation_failed | <b>Condition:</b> Pre-condition is false or post-condition is false<br><b>Returned Information:</b> The output parameter status<br><b>Exit state:</b> Entry State |
854
+
855
+ ## 6.8 IRPManagementOperations Interface (O)
856
+
857
+ ### 6.8.1 Operation getNotificationCategories (M)
858
+
859
+ #### 6.8.1.1 Definition
860
+
861
+ IRPManager invokes this operation to query the categories of notification supported by IRPAgent. IRPAgent returns the list of categories of notification supported. Each category of notification defines the name and the version of the IRP specification. The list of category of notification returned shall only contain the name and version of the IRP specifications that actually have notifications defined.
862
+
863
+ IRPManager does not need to be in subscription to invoke this operation.
864
+
865
+ #### 6.8.1.2 Input parameters
866
+
867
+ None.
868
+
869
+ #### 6.8.1.3 Output parameters
870
+
871
+ | Parameter Name | Qualifier | Matching Information | Comment |
872
+ |--------------------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------|
873
+ | NotificationCategoryList | M | SET OF (name and version of IRP specification) where each IRP is contained by IRPAgent and the attribute notificationNameProfile of the ManagedGenericIRP is not empty. | |
874
+ | status | M | ENUM (Operation succeeded, Operation failed) | OperationFailed only if operation_failed_internal_problem |
875
+
876
+ #### 6.8.1.4 Pre-condition
877
+
878
+ None specific.
879
+
880
+ #### 6.8.1.5 Post-condition
881
+
882
+ None specific.
883
+
884
+ #### 6.8.1.6 Exceptions
885
+
886
+ None specific.
887
+
888
+ ## 6.9 NotificationIRPNotification Interface
889
+
890
+ IRP Agent notifies the subscribed IRP Manager that an event has occurred and that the event has satisfied the filter constraints used for this subscription. One event example is the notification defined in Alarm IRP: IS (3GPP TS 32.111-2 [1]).
891
+
892
+ It should be possible to pack multiple notifications together for sending to NM. This provides more efficient use of data communication resources. In order to pack multiple notifications, an EM/NE configurable parameter defines the maximum number of notifications to be packed together. Additionally an EM/NE configurable parameter defines the maximum time delay before the notifications have to be sent.
893
+
894
+ Under normal operations, an IRP Agent shall send, to each IRP Manager, notifications in the same order they were generated, i.e. in the First-In, First-Out order. There shall not be any priority given to types of notifications.
895
+
896
+ This interface doesn't define any specific notification but instead defines information that is commonly found in notifications defined by other IRPs. This information is called notificationHeader. Notification interfaces defined in other IRPs, such as Alarm IRP: IS (3GPP TS 32.111-2 [1]), shall inherit from this interface and define their notifications by:
897
+
898
+ - Identifying and qualifying the Notification Header attributes for their use;
899
+ - Specify additional attributes specific to their use.
900
+
901
+ Despite the fact that the semantic of notifications is defined by other IRP ISs, it is notification IRP and not those IRP that is responsible for the emission of those notifications.
902
+
903
+ The Notification Header is defined here below.
904
+
905
+ | Attribute Name | Qualifier | Comment |
906
+ |------------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
907
+ | objectClass | M, Y | It specifies the class name of the IOC. A network event has occurred in an instance of this class. |
908
+ | objectInstance | M, Y | It specifies the instance of the above IOC in which the network event occurred by carrying the Distinguished Name (DN) of this object instance. This object may or may not be identical to the object instance actually emitting the notification. |
909
+ | notificationId | O,N | <p>This is an identifier for the notification, which may be used to correlate notifications. The identifier of the notification shall be chosen to be unique across all notifications of a particular managed object throughout the time that correlation is significant, it uniquely identifies the notification from other notifications generated by the subject Information Object.</p> <p>If IRPManager receives notifications from one IRPAgent, IRPManager shall use the identifier of the notification and the <code>objectInstance</code> to uniquely identify all received notifications.</p> <p>If IRPManager receives notifications from multiple IRPAgents and notifications of each Information Object are reported at most through one IRPAgent, IRPManager shall use the identifier of the notification and <code>objectInstance</code> to uniquely identify all received notifications.</p> <p>If IRPManager receives notifications from multiple IRPAgents and notifications of one or more Information Objects are reported through two or more IRPAgents, IRPManager shall use the identifier of the notification together with <code>objectInstance</code> and the identity of IRPAgent (<code>systemDN</code>), to uniquely identify all received notifications. If the information <code>systemDN</code> is absent, IRPManager needs other means, which are outside the scope of this IRP, to determine the identity of IRPAgent.</p> <p>How identifiers of notifications are re-used to correlate notifications is outside of the scope of this recommendation.</p> |
910
+ | eventTime | M, Y | It indicates the event occurrence time. The semantics of Generalised Time specified by ITU-T shall be used here. |
911
+ | systemDN | C, Y | <p>The <code>systemDN</code> of that notification shall carry either (1) the <code>IRPAgent</code> instance containing that Interface IRP instance, or (2) the DN of that particular Interface IRP instance responsible for the emission of the notification.</p> <p>(1) If the <code>IRPAgent</code> contains single (not multiple) Interface IRP instance of a particular class, then the <code>systemDN</code> of a notification may carry the DN of the <code>IRPAgent</code> or DN of the subject Interface IRP instance.</p> <p>(2) If the <code>IRPAgent</code> contains multiple Interface IRP instances of the same class, then the <code>systemDN</code> of a notification shall carry the DN of a particular Interface IRP instance responsible for the emission of that notification.</p> <p>Example of item (2) above:</p> <ul style="list-style-type: none"> <li>Alarm IRP:IS specifies <code>notifyNewAlarm</code>. If there are multiple <code>AlarmIRP</code> instances under one <code>IRPAgent</code>, then the <code>systemDN</code> of <code>notifyNewAlarm</code> shall be present and carry the DN of the <code>AlarmIRP</code>.</li> </ul> |
912
+ | notificationType | M, Y | The type of notification which is reported by the notification |
913
+
914
+ # Annex A (informative): Change history
915
+
916
+ | Change history | | | | | | | | |
917
+ |----------------|-------|-----------|------|-----|-----------------------------------------------------------------------------------------------------------------------------------------------|---------|-------|--------|
918
+ | Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Ca<br>t | Old | New |
919
+ | Jun 2001 | S_12 | SP-010283 | -- | -- | Approved at TSG SA #12 and placed under Change Control | -- | 2.0.0 | 4.0.0 |
920
+ | Dec 2001 | S_14 | SP-010642 | 0001 | -- | Remove ambiguity of the return information for getNotificationCategories() operation | F | 4.0.0 | 4.1.0 |
921
+ | Dec 2001 | S_14 | SP-010653 | 0002 | -- | Change from Mandatory to Conditional the qualifier of the output parameter 'NotificationCategorySet' of the operation 'getSubscriptionStatus' | C | 4.1.0 | 5.0.0 |
922
+ | Mar 2002 | -- | -- | -- | -- | Cosmetics (changed styles on cover) | -- | 5.0.0 | 5.0.1 |
923
+ | Dec 2002 | -- | -- | -- | -- | Cosmetics | -- | 5.0.1 | 5.0.2 |
924
+ | Jun 2003 | S_20 | SP-030278 | 0004 | -- | Correction of the description of the objectClass and objectInstance parameter of the notification header | A | 5.0.2 | 5.1.0 |
925
+ | Mar 2004 | S_23 | SP-040118 | 0005 | -- | Update Ntf IRP IS using new Template and UML Repertoire | F | 5.1.0 | 6.0.0 |
926
+ | Dec 2004 | S_26 | SP-040793 | 0007 | -- | Add missing rules on how to construct the string NotificationCategory | A | 6.0.0 | 6.1.0 |
927
+ | Mar 2005 | S_27 | SP-050035 | 0008 | -- | Apply Generic System Context | F | 6.1.0 | 6.2.0 |
928
+ | Jun 2005 | -- | -- | -- | -- | Introduction update : added 32.305 new TS-family member | -- | 6.2.0 | 6.2.1 |
929
+ | Mar 2006 | SA_31 | SP-060089 | 0009 | -- | Correct the use/meaning of systemDN in notification header | F | 6.2.1 | 6.3.0 |
930
+ | Jun 2007 | SA_36 | -- | -- | -- | Automatic upgrade to Rel-7 (no CR) at freeze of Rel-7. Deleted reference to CMIP SS, discontinued from R7 onwards. | -- | 6.3.0 | 7.0.0 |
931
+ | Dec 2008 | SA_42 | -- | -- | -- | Upgrade to Release 8 | - | 7.0.0 | 8.0.0 |
932
+ | Dec 2009 | SA_46 | SP-090719 | 0010 | -- | Align usage of SupportIOC according to repertoire and template | C | 8.0.0 | 9.0.0 |
933
+ | Sep 2010 | SA_49 | SP-100489 | 0011 | -- | Correction of incorrect attribute name for NtfSubscription | F | 9.0.0 | 10.0.0 |
marked/Rel-10/32_series/32306/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
marked/Rel-10/32_series/32311/raw.md ADDED
@@ -0,0 +1,196 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+
4
+
5
+ Keywords
6
+ UMTS, management
7
+
8
+ # 3GPP TS 32.311 V10.1.0 (2011-12)
9
+
10
+ *Technical Specification*
11
+
12
+ ## 3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; c Integration Reference Point (IRP) management:
13
+
14
+ 3GPP support office address
15
+ 050 Route des Lucioles - Sophia Antipolis
16
+ 06410 VALBONNE - FRANCE
17
+ Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
18
+
19
+ ![LTE logo with '4ADVANCED' text above the 'e'.](b6cb8677b4ffb35c6468fa5c24091bff_img.jpg)
20
+
21
+ LTE logo with '4ADVANCED' text above the 'e'.
22
+
23
+ Internet
24
+ <http://www.3gpp.org>
25
+
26
+ ![3GPP logo with a registered trademark symbol.](1211e36d120f0d2912a745437f4c8f19_img.jpg)
27
+
28
+ 3GPP logo with a registered trademark symbol.
29
+
30
+ ## **Copyright Notification**
31
+
32
+ No part may be reproduced except as authorized by written permission.
33
+ The copyright and the foregoing restriction extend to reproduction in all media.
34
+
35
+ © 2011, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TTA, TTC).
36
+ All rights reserved.
37
+
38
+ UMTS™ is a Trade Mark of ETSI registered for the benefit of its members
39
+ 3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
40
+ The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP.
41
+ 3GPP LTE™ is a Trade Mark of ETSI currently being registered for the benefit of its Members and of the 3GPP Organizational Partners.
42
+ The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented.
43
+ GSM® and the GSM logo are registered and owned by the GSM Association.
44
+ This Specification is provided for future development work within 3GPP only. The Organisational Partners accept no liability for any use of this Specification.
45
+ Specifications and reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organisational Partners' Publications Offices
46
+
47
+ # --- Contents
48
+
49
+ - Foreword ..... 4
50
+ - Introduction ..... 4
51
+ - 1 Scope..... 5
52
+ - 2 References..... 5
53
+ - 3 Definitions and abbreviations ..... 5
54
+ - 3.1 Definitions..... 5
55
+ - 3.2 Abbreviations ..... 6
56
+ - 4 Generic IRP functions over Itf-N..... 6
57
+ - 4.1 Version retrieval function..... 6
58
+ - 4.2 Profiles retrieval functions ..... 6
59
+ - Annex A (informative): Change history..... 8
60
+
61
+ # --- Foreword
62
+
63
+ This Technical Specification (TS) has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP).
64
+
65
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
66
+
67
+ Version x.y.z
68
+
69
+ where:
70
+
71
+ - x the first digit:
72
+ - 1 presented to TSG for information;
73
+ - 2 presented to TSG for approval;
74
+ - 3 or greater indicates TSG approved document under change control.
75
+ - y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
76
+ - z the third digit is incremented when editorial only changes have been incorporated in the document.
77
+
78
+ # --- Introduction
79
+
80
+ The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below:
81
+
82
+ - 32.311: "Generic Integration Reference Point (IRP) management; Requirements".**
83
+ - 32.312: "Generic Integration Reference Point (IRP) management; Information Service (IS)".
84
+ - 32.316: " Generic Integration Reference Point (IRP) management; Solution Set (SS) Definitions".
85
+
86
+ The Itf-N interface is built up by a number of Integration Reference Points (IRPs) and a related Name Convention, which realise the functional capabilities over this interface. The basic structure of the IRPs is defined in 3GPP TS 32.101 [1] and 3GPP TS 32.102 [2].
87
+
88
+ The IRPs support a set of common services. Those features allow to retrieve IRP profile and IRP supported versions. The present document contains the requirements of those common services.
89
+
90
+ # --- 1 Scope
91
+
92
+ The purpose of the present document is to define a common service supported by all IRPs such as AlarmIRP. The present document is the "Requirements" part. It defines the requirements that shall be fulfilled by all IRPs, such as AlarmIRP, supporting this common service.
93
+
94
+ With this common service supported by all IRPs, an IRPManager shall be able to retrieve the profile of operations and notifications supported by a given IRP which is name-contained by an IRPAgent. An IRPManager shall also be able to retrieve the IRPVersions supported by the given IRP.
95
+
96
+ # --- 2 References
97
+
98
+ The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
99
+
100
+ - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
101
+ - For a specific reference, subsequent revisions do not apply.
102
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
103
+
104
+ [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements".
105
+
106
+ [2] 3GPP TS 32.102: "Telecommunication management; Architecture".
107
+
108
+ # --- 3 Definitions and abbreviations
109
+
110
+ ## 3.1 Definitions
111
+
112
+ For the purposes of the present document, the terms and definitions given in 3GPP TS 32.101 [1], 3GPP TS 32.102 [2] and the following apply:
113
+
114
+ **IRP:** see 3GPP TS 32.102 [2].
115
+
116
+ **IRPAgent:** see 3GPP TS 32.102 [2].
117
+
118
+ **IRPManager:** see 3GPP TS 32.102 [2].
119
+
120
+ **IRP document version number string:** the IRP document version number (sometimes called "IRPVersion") string is used to identify a technology of a particular IRP Solution Set (SS) specification and its version number.
121
+
122
+ For Release 9 and earlier releases, it is derived using the following rule:
123
+
124
+ Take the 3GPP TS/version number on the front page of the SS specification, such as "3GPP TS 32.111-3 V4.1.0 (2001-09)". Discard the leading "3GPP TS". Discard all characters after and including the last period. Eliminate leading and trailing spaces. Reduce multiple consecutive spaces to one space. Express the resultant in a string. Capitalise all letters of the string.
125
+
126
+ EXAMPLE 1: If the 3GPP document version number is "3GPP TS 32.111-3 V4.1.0 (2001-09)", then the IRP document version number shall be "32.111-3 V4.1".
127
+
128
+ EXAMPLE 2: If the 3GPP document version number is "3GPP TS 32.303 V4.1.0 (2001-09)", then the IRP document version number shall be "32.303 V4.1".
129
+
130
+ For Release 10 and later releases, it is derived using the following rule:
131
+
132
+ Take the 3GPP TS/version number on the front page of the SS specification, such as "3GPP TS 32.111-6 V10.1.0 (2011-06)", Discard the leading "3GPP TS". Discard all characters after and including the last period. Remove all spaces. Construct a string that is a concatenation of ‘-’, the identifier of the Annex where the solution set technology is captured (e.g., ‘A’ for Annex A) and a trailing space. Insert the concatenated string before ‘V’, Express the resultant in a string. Capitalise all letters of the string.
133
+
134
+ EXAMPLE 3: If the 3GPP document version number is "3GPP TS 32.111-6 V10.1.0 (2011-06)", then the IRP document version number shall be:
135
+
136
+ - "32.111-6-A V10.1" for CORBA Solution Set;
137
+ - "32.111-6-B V10.1" for XML Definitions;
138
+ - "32.111-6-C V10.1" for SOAP Solution Set.
139
+
140
+ EXAMPLE 4: If the 3GPP document version number is "3GPP TS 32.306 V10.1.0 (2011-09)", then the IRP document version number shall be:
141
+
142
+ - "32.306-A V10.1" for CORBA Solution Set;
143
+ - "32.306-B V10.1" for XML Definitions;
144
+ - "32.306-C V10.1" for SOAP Solution Set.
145
+
146
+ ## 3.2 Abbreviations
147
+
148
+ For the purposes of the present document, the following abbreviations apply:
149
+
150
+ | | |
151
+ |-----|-----------------------------|
152
+ | CM | Configuration Management |
153
+ | EM | Element Manager |
154
+ | IRP | Integration Reference Point |
155
+ | IS | Information Service |
156
+ | NE | Network Element |
157
+ | NM | Network Manager |
158
+ | SS | Solution Set |
159
+
160
+ # 4 Generic IRP functions over Itf-N
161
+
162
+ The requirements for the generic IRP service over Itf-N are provided in the following clauses.
163
+
164
+ ## 4.1 Version retrieval function
165
+
166
+ An IRPAgent may support one or multiple IRP instances simultaneously (e.g. AlarmIRP instances, BulkCMIRP instances, etc.).
167
+
168
+ The set of capabilities of each IRP instance is fully identified by the version number of the corresponding IRP specification (i.e. the “IRP document version number string” or in short, the IRPVersion; see clause 3.1.).
169
+
170
+ An IRP instance shall provide a function to allow IRPManager to retrieve all its (i.e. IRP instance’s) supported IRPVersion(s) over Itf-N.
171
+
172
+ An IRPManager may then decide if it wants to communicate with the IRP instance.
173
+
174
+ ## 4.2 Profiles retrieval functions
175
+
176
+ Each IRP supported by an IRPAgent provides a set of operations and notifications. It is possible to define in each IRP Information Service (IS) some operations and notification that are optional, which means that the final implementation of those operations and notifications is vendor dependant. Similarly, some parameters of operations and notifications may be defined as optional in the IRP IS.
177
+
178
+ It shall be possible for an IRPManager to retrieve over Itf-N the profile of an IRP of a given version: the profile shall provide information such as name of supported operations and notifications, and the list of supported parameters for each supported operation and notification.
179
+
180
+ # Annex A (informative): Change history
181
+
182
+ | Change history | | | | | | | |
183
+ |----------------|-------|-----------|------|-----|--------------------------------------------------------------------------------------------------------------------|--------|--------|
184
+ | Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New |
185
+ | Jun 2001 | SA 12 | SP-010285 | -- | -- | Approved at TSG SA #12 and placed under Change Control | 2.0.0 | 4.0.0 |
186
+ | Jul 2001 | -- | -- | -- | -- | TS number wrongly shown as 32.312 instead of 32.311 | 4.0.0 | 4.0.1 |
187
+ | Mar 2002 | SA 15 | -- | -- | -- | Automatic upgrade to Rel-5 (no Rel-5 CR) | 4.0.1 | 5.0.0 |
188
+ | Dec 2002 | -- | -- | -- | -- | Cosmetics | 5.0.0 | 5.0.1 |
189
+ | Dec 2003 | SA 22 | SP-030639 | 0002 | -- | Align with 32.102 | 5.0.1 | 5.1.0 |
190
+ | Mar 2004 | SA 23 | SP-040105 | -- | -- | Automatic upgrade to Rel-6 (no CR) | 5.1.0 | 6.0.0 |
191
+ | Dec 2004 | SA 26 | SP-040794 | 0003 | -- | Update UML diagrams, Add reference to its CORBA/CMIP SSs | 6.0.0 | 6.1.0 |
192
+ | Jun 2007 | SA_36 | -- | -- | -- | Automatic upgrade to Rel-7 (no CR) at freeze of Rel-7. Deleted reference to CMIP SS, discontinued from R7 onwards. | 6.1.0 | 7.0.0 |
193
+ | Dec 2008 | SA 42 | -- | -- | -- | Upgrade to Release 8 | 7.0.0 | 8.0.0 |
194
+ | Dec 2009 | - | - | - | - | Update to Rel-9 version (MCC) | 8.0.0 | 9.0.0 |
195
+ | Mar 2011 | - | - | - | - | Update to Rel-10 version (MCC) | 9.0.0 | 10.0.0 |
196
+ | Dec 2012 | SA 54 | SP-110706 | 0004 | 4 | Enhance definition of IRPVersion | 10.0.0 | 10.1.0 |
marked/Rel-10/32_series/32312/raw.md ADDED
@@ -0,0 +1,477 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+
4
+
5
+ Keywords
6
+ UMTS, management
7
+
8
+ # 3GPP TS 32.312 V10.1.0 (2013-03)
9
+
10
+ *Technical Specification*
11
+
12
+ ## 3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; c Integration Reference Point (IRP) management: Information
13
+
14
+ 3GPP support office address
15
+ 050 Route des Lucioles - Sophia Antipolis
16
+ 06410 VALBONNE - FRANCE
17
+ Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
18
+
19
+ Internet
20
+ <http://www.3gpp.org>
21
+
22
+ ![LTE logo with '4ADVANCED' text above the 'e'.](f5f48eb1753d75fb380cf01027a6395d_img.jpg)
23
+
24
+ LTE logo with '4ADVANCED' text above the 'e'.
25
+
26
+ ![3GPP logo with a signal icon below the 'P'.](1211e36d120f0d2912a745437f4c8f19_img.jpg)
27
+
28
+ 3GPP logo with a signal icon below the 'P'.
29
+
30
+ ## Copyright Notification
31
+
32
+ No part may be reproduced except as authorized by written permission.
33
+ The copyright and the foregoing restriction extend to reproduction in all media.
34
+
35
+ © 2013, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TTA, TTC).
36
+ All rights reserved.
37
+
38
+ UMTS™ is a Trade Mark of ETSI registered for the benefit of its members
39
+ 3GPP is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners.
40
+ The present document has not been subject to any approval process by the 3GPP Organisational Partners and shall not be implemented.
41
+ LTE™ is a Trade Mark of ETSI currently being registered for the benefit of its Members and of the 3GPP Organizational Partners.
42
+ This Specification is provided for future development work within 3GPP only. The Organisational Partners accept no liability for any use of this Specification.
43
+ GSM™ and the GSM logo are registered and owned by the GSM Association.
44
+ Specifications and reports for implementation of the 3GPP system should be obtained via the 3GPP Organisational Partners' Publications Offices
45
+
46
+ # Contents
47
+
48
+ | | |
49
+ |---------------------------------------------------------|----|
50
+ | Foreword ..... | 5 |
51
+ | Introduction ..... | 5 |
52
+ | 1 Scope..... | 6 |
53
+ | 2 References..... | 6 |
54
+ | 3 Definitions and abbreviations ..... | 6 |
55
+ | 3.1 Definitions..... | 6 |
56
+ | 3.2 Abbreviations ..... | 7 |
57
+ | 4 System Overview ..... | 8 |
58
+ | 4.1 System Context ..... | 8 |
59
+ | 5 Information Object Classes (IOCs)..... | 9 |
60
+ | 5.1 Imported information entities and local labels..... | 9 |
61
+ | 5.2 Class Diagram ..... | 9 |
62
+ | 5.2.1 Attributes and relationships..... | 9 |
63
+ | 5.2.2 Inheritance ..... | 9 |
64
+ | 5.3 Information object class definitions ..... | 9 |
65
+ | 5.3.1 ManagedGenericIRP ..... | 9 |
66
+ | 5.3.1.1 Definition ..... | 9 |
67
+ | 5.3.1.2 Attributes ..... | 10 |
68
+ | 5.3.1.3 Notification ..... | 10 |
69
+ | 5.4 Information relationship definitions..... | 10 |
70
+ | 5.5 Information attribute definitions ..... | 10 |
71
+ | 5.5.1 Definitions and legal values ..... | 10 |
72
+ | 6 Interface Definition ..... | 11 |
73
+ | 6.1 Class diagram representing interfaces..... | 11 |
74
+ | 6.2 Generic rules ..... | 12 |
75
+ | 6.3 genericIRPVersionOperations Interface (M)..... | 12 |
76
+ | 6.3.1 Operation getIRPVersion (M)..... | 12 |
77
+ | 6.3.1.1 Definition ..... | 12 |
78
+ | 6.3.1.2 Input parameters ..... | 12 |
79
+ | 6.3.1.3 Output parameters..... | 12 |
80
+ | 6.3.1.4 Pre-condition..... | 12 |
81
+ | 6.3.1.5 Post-condition ..... | 12 |
82
+ | 6.3.1.6 Exceptions..... | 12 |
83
+ | 6.4 genericIRPProfileOperations Interface (O) ..... | 13 |
84
+ | 6.4.1 Operation getOperationProfile (O)..... | 13 |
85
+ | 6.4.1.1 Definition ..... | 13 |
86
+ | 6.4.1.2 Input parameters ..... | 13 |
87
+ | 6.4.1.3 Output parameters..... | 13 |
88
+ | 6.4.1.4 Pre-condition..... | 13 |
89
+ | 6.4.1.5 Post-condition ..... | 13 |
90
+ | 6.4.1.6 Exceptions..... | 13 |
91
+ | 6.4.2 Operation getNotificationProfile (O)..... | 14 |
92
+ | 6.4.2.1 Definition ..... | 14 |
93
+ | 6.4.2.2 Input parameters ..... | 14 |
94
+ | 6.4.2.3 Output parameters..... | 14 |
95
+ | 6.4.2.4 Pre-condition..... | 14 |
96
+ | 6.4.2.5 Post-condition ..... | 14 |
97
+ | 6.4.2.6 Exceptions..... | 14 |
98
+ | Annex A (informative): Change history..... | 15 |
99
+
100
+ # --- Foreword
101
+
102
+ This Technical Specification (TS) has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP).
103
+
104
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
105
+
106
+ Version x.y.z
107
+
108
+ where:
109
+
110
+ - x the first digit:
111
+ - 1 presented to TSG for information;
112
+ - 2 presented to TSG for approval;
113
+ - 3 or greater indicates TSG approved document under change control.
114
+ - y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
115
+ - z the third digit is incremented when editorial only changes have been incorporated in the document.
116
+
117
+ # --- Introduction
118
+
119
+ The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below:
120
+
121
+ - 32.311: Generic Integration Reference Point (IRP) management; Requirements
122
+ - 32.312: Generic Integration Reference Point (IRP) management; Information Service (IS)**
123
+ - 32.316: Generic Integration Reference Point (IRP) management; Solution Set (SS) Definitions
124
+
125
+ The Itf-N interface is built up by a number of IRPs and a related Name Convention, which realise the functional capabilities over this interface. The basic structure of the IRPs is defined in TS 32.101 [1] and TS 32.102 [2].
126
+
127
+ All IRPs support a set of generic features. Those features allow to retrieve IRP profile and IRP supported versions. The present document contains the specification of those generic features.
128
+
129
+ # --- 1 Scope
130
+
131
+ The purpose of the present document is to define a common service supported by all IRPs such as AlarmIRP. The present document is the "Information Service" part. It defines, for the purpose of supporting the common service, the information observable and controllable by management system's client (i.e. IRPManager) via the Itf-N. It also specifies the semantics of and the interactions used to carry this information.
132
+
133
+ With this common service supported by all IRPs, an IRPManager can retrieve the profile of operations and notifications supported by a given IRP name-contained by an IRPAgent. An IRPManager can also retrieve the IRPVersions supported by a given IRP.
134
+
135
+ # --- 2 References
136
+
137
+ The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
138
+
139
+ - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
140
+ - For a specific reference, subsequent revisions do not apply.
141
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
142
+ - [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements".
143
+ - [2] 3GPP TS 32.102: "Telecommunication management; Architecture".
144
+ - [3] 3GPP TS 32.301: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP): Requirements".
145
+ - [4] Void.
146
+ - [5] 3GPP TS 32.311: "Telecommunication management; Generic Integration Reference Point (IRP) management; Requirements".
147
+ - [6] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions".
148
+ - [7] 3GPP TS 32.111-2: "Telecommunication management; Fault Management; Part 2: Alarm Integration Reference Point (IRP): Information Service (IS)".
149
+ - [8] 3GPP TS 32.622: "Generic network resources Integration Reference Point (IRP): Network Resource Model (NRM)".
150
+
151
+ # --- 3 Definitions and abbreviations
152
+
153
+ ## 3.1 Definitions
154
+
155
+ For the purposes of the present document, the terms and definitions given in TS 32.101 [1], TS 32.102 [2], TS 32.301 [3] and the following apply:
156
+
157
+ **IRP:** see TS 32.102 [2].
158
+
159
+ **IRPAgent:** see TS 32.102 [2].
160
+
161
+ **IRPManager:** see TS 32.102 [2].
162
+
163
+ **IRP document version number string (or "IRPVersion"):** see TS 32.311 [5].
164
+
165
+ **Itf-N:** see TS 32.102 [2].
166
+
167
+ **SupportIOC:** see TS 32.150 [6].
168
+
169
+ ## 3.2 Abbreviations
170
+
171
+ For the purposes of the present document, the following abbreviations apply:
172
+
173
+ | | |
174
+ |-------|--------------------------------------------------------------------------------|
175
+ | CM | Configuration Management |
176
+ | DN | Distinguished Name |
177
+ | EM | Element Manager |
178
+ | IOC | Information Object Class |
179
+ | IRP | Integration Reference Point |
180
+ | IS | Information Service |
181
+ | ITU-T | International Telecommunication Union Telecommunication standardisation sector |
182
+ | NE | Network Element |
183
+ | NM | Network Manager |
184
+ | NR | Network Resource |
185
+ | NRM | Network Resource Model |
186
+ | OMG | Object Management Group |
187
+ | RDN | Relative Distinguished Name |
188
+ | SS | Solution Set |
189
+ | UML | Unified Modelling Language (OMG) |
190
+
191
+ # 4 System Overview
192
+
193
+ ## 4.1 System Context
194
+
195
+ The general definition of the System Context for the present IRP is found in TS 32.150 [6] clause 4.7.
196
+
197
+ In addition, the set of related IRP(s) relevant to the present IRP is shown in the two diagrams below.
198
+
199
+ ![Figure 4.1: System Context A. A diagram showing an IRPManager (NM) connected to an IRPAgent (EM) via an interface labeled Itf-N. The IRPAgent is connected to multiple NEs. A curved arrow labeled 'Any IRP' points to the Itf-N interface.](1c953f32bd34345dfd68fddf8a3736d6_img.jpg)
200
+
201
+ The diagram illustrates the system context for IRP. On the left, a box labeled 'NM' contains a sub-box 'IRPManager'. A solid line connects 'IRPManager' to another box on the right labeled 'EM', which contains a sub-box 'IRPAgent'. A vertical dashed line, labeled 'Itf-N' at its base, separates the 'NM' and 'EM' boxes. To the right of the 'EM' box, a dotted line connects 'IRPAgent' to a box labeled 'NEs'. A curved arrow labeled 'Any IRP' points from the right towards the 'Itf-N' interface.
202
+
203
+ Figure 4.1: System Context A. A diagram showing an IRPManager (NM) connected to an IRPAgent (EM) via an interface labeled Itf-N. The IRPAgent is connected to multiple NEs. A curved arrow labeled 'Any IRP' points to the Itf-N interface.
204
+
205
+ Figure 4.1: System Context A
206
+
207
+ ![Figure 4.2: System Context B. A diagram showing an IRPManager (NM) connected to an IRPAgent (NE) via an interface labeled Itf-N. A curved arrow labeled 'Any IRP' points to the Itf-N interface.](ca4d4ff86cf319ed7cc36a1ecda29101_img.jpg)
208
+
209
+ The diagram illustrates the system context for IRP. On the left, a box labeled 'NM' contains a sub-box 'IRPManager'. A solid line connects 'IRPManager' to another box on the right labeled 'NE', which contains a sub-box 'IRPAgent'. A vertical dashed line, labeled 'Itf-N' at its base, separates the 'NM' and 'NE' boxes. A curved arrow labeled 'Any IRP' points from the right towards the 'Itf-N' interface. Unlike Figure 4.1, there is no connection to 'NEs'.
210
+
211
+ Figure 4.2: System Context B. A diagram showing an IRPManager (NM) connected to an IRPAgent (NE) via an interface labeled Itf-N. A curved arrow labeled 'Any IRP' points to the Itf-N interface.
212
+
213
+ Figure 4.2: System Context B
214
+
215
+ # 5 Information Object Classes (IOCs)
216
+
217
+ ## 5.1 Imported information entities and local labels
218
+
219
+ | Label reference | Local label |
220
+ |-----------------------------------------------------------|-----------------------|
221
+ | 3GPP TS 32.111-2 [7], notification, notifyNewAlarm | notifyNewAlarm |
222
+ | 3GPP TS 32.111-2 [7], notification, notifyChangedAlarm | notifyChangedAlarm |
223
+ | 3GPP TS 32.111-2 [7], notification, notifyClearedAlarm | notifyClearedAlarm |
224
+ | 3GPP TS 32.111-2 [7], notification, notifyAckStateChanged | notifyAckStateChanged |
225
+ | 3GPP TS 32.622 [8], information object class, Top | Top |
226
+
227
+ ## 5.2 Class Diagram
228
+
229
+ ### 5.2.1 Attributes and relationships
230
+
231
+ This clause depicts the set of classes (e.g. IOCs) that encapsulates the information relevant for this IRP. This clause provides an overview of the relationships between relevant classes in UML. Subsequent clauses provide more detailed specification of various aspects of these classes.
232
+
233
+ ![UML Class Diagram showing a class box for ManagedGenericIRP with the stereotype <<SupportIOC>>.](731f533b0599c8e42a063f06e4332045_img.jpg)
234
+
235
+ ```
236
+
237
+ classDiagram
238
+ class ManagedGenericIRP {
239
+ <<SupportIOC>>
240
+ }
241
+
242
+ ```
243
+
244
+ UML Class Diagram showing a class box for ManagedGenericIRP with the stereotype <>.
245
+
246
+ ### 5.2.2 Inheritance
247
+
248
+ This clause depicts the inheritance relationships that exist between SupportIOCs.
249
+
250
+ ![UML Class Diagram showing inheritance from ManagedGenericIRP to Top class.](3b621c21b0af3a504a28d2547e87138f_img.jpg)
251
+
252
+ ```
253
+
254
+ classDiagram
255
+ class Top {
256
+ <<InformationObjectClass>>
257
+ (from TS 32.622)
258
+ }
259
+ class ManagedGenericIRP {
260
+ <<SupportIOC>>
261
+ }
262
+ ManagedGenericIRP --|> Top
263
+
264
+ ```
265
+
266
+ UML Class Diagram showing inheritance from ManagedGenericIRP to Top class.
267
+
268
+ ## 5.3 Information object class definitions
269
+
270
+ ### 5.3.1 ManagedGenericIRP
271
+
272
+ #### 5.3.1.1 Definition
273
+
274
+ This SupportIOC represents a generic IRP which supports generic management capabilities associated with each IRP Agent. This SupportIOC cannot be instantiated. It is defined for sub-classing purposes.
275
+
276
+ #### 5.3.1.2 Attributes
277
+
278
+ | Attribute name | Support Qualifier | Read Qualifier | Write Qualifier |
279
+ |------------------------------|-------------------|----------------|-----------------|
280
+ | iRPId | M | M | - |
281
+ | iRPVersions | M | M | - |
282
+ | operationNameProfile | O | M | - |
283
+ | operationParameterProfile | O | M | - |
284
+ | notificationNameProfile | O | M | - |
285
+ | notificationParameterProfile | O | M | - |
286
+
287
+ #### 5.3.1.3 Notification
288
+
289
+ | Name | Qualifier | Notes |
290
+ |-----------------------|-----------|--------------------------------------|
291
+ | notifyNewAlarm | O | See Alarm IRP (3GPP TS 32.111-2 [7]) |
292
+ | notifyChangedAlarm | O | See Alarm IRP (3GPP TS 32.111-2 [7]) |
293
+ | notifyClearedAlarm | O | See Alarm IRP (3GPP TS 32.111-2 [7]) |
294
+ | notifyComments | O | See Alarm IRP (3GPP TS 32.111-2 [7]) |
295
+ | notifyAckStateChanged | O | See Alarm IRP (3GPP TS 32.111-2 [7]) |
296
+
297
+ ## 5.4 Information relationship definitions
298
+
299
+ None
300
+
301
+ ## 5.5 Information attribute definitions
302
+
303
+ This clause defines the semantics of the attributes used in SupportIOCs.
304
+
305
+ ### 5.5.1 Definitions and legal values
306
+
307
+ | Attribute Name | Definition | Legal Values |
308
+ |------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------|
309
+ | iRPId | An attribute whose 'name+value' can be used as an RDN when naming an instance of this object class. This RDN uniquely identifies the object instance within the scope of its containing (parent) object instance. | |
310
+ | iRPVersions | This attribute contains a set of IRPVersions. The set contains at least one element. | See definition "IRP document version number string" in clause 3.1. |
311
+ | operationNameProfile | This attribute contains a set of elements. The n-th element of this set contains the set of operation names supported for the IRPVersion identified in the n-th element of iRPVersions attribute. | |
312
+ | notificationNameProfile | This attribute contains a set of elements. The n-th element of this set contains the set of notification names supported for the IRPVersion identified in the n-th element of iRPVersions attribute. | |
313
+ | operationParameterProfile | This attribute contains a set of elements. The n-th element of this set contains the set of set of notification parameters supported by the operations identified in the n-th element of operationNameProfile attribute. The set of operation parameters are placed in the set in the same order as the order followed by the operation names in their set. | |
314
+ | notificationParameterProfile | This attribute contains a set of elements. The n-th element of this set contains the set of set of notification parameters supported by the notifications identified in the n-th element of notificationNameProfile attribute. The set of notification parameters are placed in the set in the same order as the order followed by the notification names in their set. | |
315
+
316
+ # 6 Interface Definition
317
+
318
+ ## 6.1 Class diagram representing interfaces
319
+
320
+ ![UML Class diagram showing ManagedGenericIRP implementing GenericIRPVersionOperations and possibly realizing GenericIRPProfileOperations.](7e670a2b556b53ea9002dfff3a420e08_img.jpg)
321
+
322
+ ```
323
+ classDiagram
324
+ class ManagedGenericIRP {
325
+ <<SupportIOC>>
326
+ ManagedGenericIRP
327
+ }
328
+ class GenericIRPVersionOperations {
329
+ <<Interface>>
330
+ getIRPVersion()
331
+ }
332
+ class GenericIRPProfileOperations {
333
+ <<Interface>>
334
+ <<opt>> getOperationProfile()
335
+ <<opt>> getNotificationProfile()
336
+ }
337
+ ManagedGenericIRP --|> GenericIRPVersionOperations
338
+ ManagedGenericIRP --> GenericIRPProfileOperations : <<may realize>>
339
+ ```
340
+
341
+ The diagram illustrates a class hierarchy. At the top is a class box labeled **<<SupportIOC>> ManagedGenericIRP**. Below it are two interface boxes. The left interface is labeled **<<Interface>> GenericIRPVersionOperations** and contains the method **getIRPVersion()**. The right interface is labeled **<<Interface>> GenericIRPProfileOperations** and contains two optional methods: **<<opt>> getOperationProfile()** and **<<opt>> getNotificationProfile()**. A solid line with an open triangle arrowhead points from **ManagedGenericIRP** to **GenericIRPVersionOperations**, indicating inheritance or implementation. A dashed line with an open arrowhead points from **ManagedGenericIRP** to **GenericIRPProfileOperations**, labeled with **<<may realize>>**, indicating a possible realization of the interface.
342
+
343
+ UML Class diagram showing ManagedGenericIRP implementing GenericIRPVersionOperations and possibly realizing GenericIRPProfileOperations.
344
+
345
+ ## 6.2 Generic rules
346
+
347
+ - **Rule 1:** each operation with at least one input parameter supports a pre-condition `valid_input_parameter` which indicates that all input parameters shall be valid with regards to their information type. Additionally, each such operation supports an exception `operation_failed_invalid_input_parameter` which is raised when pre-condition `valid_input_parameter` is false. The exception has the same entry and exit state.
348
+ - **Rule 2:** Each operation with at least one optional input parameter supports a set of pre-conditions `supported_optional_input_parameter_xxx` where "xxx" is the name of the optional input parameter and the pre-condition indicates that the operation supports the named optional input parameter. Additionally, each such operation supports an exception `operation_failed_unsupported_optional_input_parameter_xxx` which is raised when (a) the pre-condition `supported_optional_input_parameter_xxx` is false and (b) the named optional input parameter is carrying information. The exception has the same entry and exit state.
349
+ - **Rule 3:** each operation shall support a generic exception `operation_failed_internal_problem` which is raised when an internal problem occurs and that the operation cannot be completed. The exception has the same entry and exit state.
350
+
351
+ ## 6.3 genericIRPVersionOperations Interface (M)
352
+
353
+ ### 6.3.1 Operation getIRPVersion (M)
354
+
355
+ #### 6.3.1.1 Definition
356
+
357
+ IRPManager wishes to find out the IRP SS versions supported by an IRP. The IRP shall respond with a set of supported IRP SS version(s). The list of returned `IRPVersions` is such that the IRPManager can use any of these versions without having to specify an `IRPVersion` to the IRPAgent.
358
+
359
+ #### 6.3.1.2 Input parameters
360
+
361
+ None
362
+
363
+ #### 6.3.1.3 Output parameters
364
+
365
+ | Parameter Name | Qualifier | Matching Information | Comment |
366
+ |-------------------------------|-----------|----------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|
367
+ | <code>versionNumberSet</code> | M | <code>ManagedGenericIRP.iRPPVersions</code> | It indicates one or more SS version numbers ( <code>IRPVersion</code> , as defined by "IRP document version number string" in clause 3.1) supported by the IRP. |
368
+ | <code>status</code> | M | ENUM (Operation succeeded, Operation failed) | If <code>operation_failed_internal_problem status = OperationFailed</code> . |
369
+
370
+ #### 6.3.1.4 Pre-condition
371
+
372
+ None specific
373
+
374
+ #### 6.3.1.5 Post-condition
375
+
376
+ None specific
377
+
378
+ #### 6.3.1.6 Exceptions
379
+
380
+ None specific
381
+
382
+ ## 6.4 genericIRPProfileOperations Interface (O)
383
+
384
+ ### 6.4.1 Operation getOperationProfile (O)
385
+
386
+ #### 6.4.1.1 Definition
387
+
388
+ IRPManager invokes this operation to query the detailed profile of an IRP (supported operations and supported parameters) for a specific supported version. The notification profile will provide details about notifications that are specifically defined by this IRP.
389
+
390
+ #### 6.4.1.2 Input parameters
391
+
392
+ | Parameter Name | Qualifier | Information Type | Comment |
393
+ |----------------|-----------|---------------------------------------------------------|-------------------------------|
394
+ | iRPVersion | M | Element of <code>ManagedGenericIRP.iRPVersions</code> . | It contains a version number. |
395
+
396
+ #### 6.4.1.3 Output parameters
397
+
398
+ | Parameter Name | Qualifier | Matching Information | Comment |
399
+ |---------------------------|-----------|------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
400
+ | operationNameProfile | M | Elements of <code>ManagedGenericIRP.operationNameProfile</code> corresponding to the <code>iRPVersion</code> parameter. | If this parameter contains no information, it implies that the IRP does not support any operation. |
401
+ | operationParameterProfile | M | Elements of <code>ManagedGenericIRP.operationParameterProfile</code> corresponding to the <code>iRPVersion</code> parameter. | |
402
+ | status | M | ENUM (Operation succeeded, Operation failed) | If <code>operation_failed_invalid_version</code> status = <code>OperationFailed</code> . |
403
+
404
+ #### 6.4.1.4 Pre-condition
405
+
406
+ `validIRPVersion`.
407
+
408
+ | Assertion Name | Definition |
409
+ |------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
410
+ | <code>validIRPVersion</code> | The <code>iRPVersion</code> input parameter identifies a supported version contained in attribute <code>iRPVersions</code> of the <code>ManagedGenericIRP</code> SupportLOC. |
411
+
412
+ #### 6.4.1.5 Post-condition
413
+
414
+ None specific
415
+
416
+ #### 6.4.1.6 Exceptions
417
+
418
+ | Name | Definition |
419
+ |-----------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|
420
+ | <code>Operation_failed_invalid_version</code> | <b>Condition:</b> <code>validIRPVersion</code> is false<br><b>Returned Information:</b> The output parameter status<br><b>Exit state:</b> Entry State |
421
+
422
+ ### 6.4.2 Operation `getNotificationProfile` (O)
423
+
424
+ #### 6.4.2.1 Definition
425
+
426
+ `IRPManager` invokes this operation to query the detailed notification profile of an IRP (supported notifications and supported parameters) for a specific supported version. The notification profile will provide details about notifications that are specifically defined by this IRP. For example, if this IRP is notification IRP R4, then `getNotificationProfile` will not return any information since no notification is defined in notification IRP R4.
427
+
428
+ #### 6.4.2.2 Input parameters
429
+
430
+ | Parameter Name | Qualifier | Information Type | Comment |
431
+ |-------------------------|-----------|------------------------------------------------------|-------------------------------|
432
+ | <code>iRPVersion</code> | M | Element of <code>ManagedGenericIRP.iRPVersion</code> | It contains a version number. |
433
+
434
+ #### 6.4.2.3 Output parameters
435
+
436
+ | Parameter Name | Qualifier | Matching Information | Comment |
437
+ |-------------------------------------------|-----------|--------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|
438
+ | <code>notificationNameProfile</code> | M | Element of <code>ManagedGenericIRP.notificationNameProfile</code> corresponding to the <code>iRPVersion</code> parameter. | If this parameter contains no information, it implies that the IRP does not support any notification. |
439
+ | <code>notificationParameterProfile</code> | M | Element of <code>ManagedGenericIRP.notificationParameterProfile</code> corresponding to the <code>iRPVersion</code> parameter. | |
440
+ | <code>status</code> | M | ENUM (Operation succeeded, Operation failed) | If <code>operation_failed_invalid_version</code><br><code>status = OperationFailed</code> . |
441
+
442
+ #### 6.4.2.4 Pre-condition
443
+
444
+ `validIRPVersion`.
445
+
446
+ | Assertion Name | Definition |
447
+ |------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
448
+ | <code>validIRPVersion</code> | The <code>iRPVersion</code> input parameter identifies a supported version contained in attribute <code>iRPVersions</code> of the <code>ManagedGenericIRP SupportIOC</code> . |
449
+
450
+ #### 6.4.2.5 Post-condition
451
+
452
+ None specific
453
+
454
+ #### 6.4.2.6 Exceptions
455
+
456
+ | Name | Definition |
457
+ |-----------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
458
+ | <code>Operation_failed_invalid_version</code> | <b>Condition:</b> <code>validIRPVersion</code> is false<br><b>Returned Information:</b> The output parameter <code>status</code><br><b>Exit state:</b> Entry State |
459
+
460
+ # Annex A (informative): Change history
461
+
462
+ | Change history | | | | | | | | |
463
+ |----------------|-------|-----------|----------|-----|--------------------------------------------------------------------------------------------------------------------|-----|--------|--------|
464
+ | Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Cat | Old | New |
465
+ | Jun 2001 | SA_12 | SP-010285 | -- | -- | Approved at TSG SA #12 and placed under Change Control | -- | 2.0.0 | 4.0.0 |
466
+ | Mar 2002 | SA_15 | -- | -- | -- | Automatic upgrade to Rel-5 (no Rel-5 CR) | -- | 4.0.0 | 5.0.0 |
467
+ | Dec 2002 | -- | -- | -- | -- | Cosmetics | -- | 5.0.0 | 5.0.1 |
468
+ | Dec 2003 | SA_22 | SP-030640 | 000<br>2 | -- | Align with 32.102 and 32.311 | A | 5.0.1 | 5.1.0 |
469
+ | Mar 2004 | SA_23 | SP-040105 | -- | -- | Automatic upgrade to Rel-6 (no CR) | -- | 5.1.0 | 6.0.0 |
470
+ | Dec 2004 | SA_26 | SP-040794 | 000<br>3 | -- | Update UML diagrams, Add reference to its CORBA/CMIP SSs | F | 6.0.0 | 6.1.0 |
471
+ | Jun 2005 | SA_28 | SP-050329 | 000<br>4 | -- | Apply Generic System Context – Align with TS 32.150 | F | 6.1.0 | 6.2.0 |
472
+ | Dec 2006 | SA_34 | SP-060708 | 000<br>5 | -- | Add missing Notification Table for ManagedGenericIRP | F | 6.2.0 | 6.3.0 |
473
+ | Jun 2007 | SA_36 | -- | -- | -- | Automatic upgrade to Rel-7 (no CR) at freeze of Rel-7. Deleted reference to CMIP SS, discontinued from R7 onwards. | -- | 6.3.0 | 7.0.0 |
474
+ | Dec 2008 | SA_42 | -- | -- | -- | Upgrade to Release 8 | -- | 7.0.0 | 8.0.0 |
475
+ | Dec 2009 | SA_46 | SP-090719 | 000<br>6 | -- | Align usage of SupportIOC according to repertoire and template | C | 8.0.0 | 9.0.0 |
476
+ | Mar 2011 | - | - | - | - | Update to Rel-10 version (MCC) | - | 9.0.0 | 10.0.0 |
477
+ | Mar 2013 | SA_59 | SP-130049 | 001<br>1 | -- | add missing iRPId etc. | A | 10.0.0 | 10.1.0 |
marked/Rel-10/32_series/32316/raw.md ADDED
@@ -0,0 +1,987 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+ # Keywords UMTS, management, **3GPP TS 32.316 V10.0.0 (2010-06)**
4
+
5
+ *Technical Specification*
6
+
7
+ **3GPP**
8
+
9
+ ## Postal address **3rd Generation Partnership Project;** **Technical Specification Group Services and System Aspects;** **Telecommunication management;** 3GPP support office address **Generic Integration Reference Point (IRP) management;** **Solution Set**
10
+
11
+ ![LTE logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg)
12
+
13
+ LTE logo
14
+
15
+ Internet Protocol Suite: IPv6
16
+ Valbonne - FRANCE
17
+ Tel.: +33 4 92 94 42 00 Fax: +33 4 92 94 42 01
18
+
19
+ Internet
20
+ <http://www.3gpp.org>
21
+
22
+ ![3GPP logo](4f4b52340aaccb1bcf733468dca9ee03_img.jpg)
23
+
24
+ 3GPP logo
25
+
26
+ # **Copyright Notification**
27
+
28
+ No part may be reproduced except as authorized by written permission.
29
+ The copyright and the foregoing restriction extend to reproduction in all media.
30
+
31
+ © 2010, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TTA, TTC).
32
+ All rights reserved.
33
+
34
+ UMTS™ is a Trade Mark of ETSI registered for the benefit of its members
35
+
36
+ 3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
37
+
38
+ LTE™ is a Trade Mark of ETSI currently being registered for the benefit of its Members and of the 3GPP Organizational Partners
39
+
40
+ GSM® and the GSM logo are registered and owned by the GSM Association
41
+
42
+ The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP.
43
+
44
+ The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented.
45
+
46
+ This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices.
47
+
48
+ # --- Contents
49
+
50
+ | | |
51
+ |-------------------------------------------------------------------|-----------|
52
+ | Foreword ..... | 4 |
53
+ | Introduction ..... | 4 |
54
+ | 1 Scope..... | 5 |
55
+ | 2 References..... | 5 |
56
+ | 3 Definitions and abbreviations ..... | 5 |
57
+ | 3.1 Definitions..... | 5 |
58
+ | 3.2 Abbreviations ..... | 6 |
59
+ | 4 Solution Set definitions..... | 6 |
60
+ | <b>Annex A (normative): CORBA Solution Set.....</b> | <b>7</b> |
61
+ | A.1 Architectural Features..... | 7 |
62
+ | A.1.1 Syntax for Distinguished Names..... | 7 |
63
+ | A.1.2 Abstract IOC ..... | 7 |
64
+ | A.2 Mapping ..... | 7 |
65
+ | A.2.1 Operation mapping..... | 7 |
66
+ | A.2.2 Operation parameter mapping..... | 7 |
67
+ | A.3 Solution Set definitions..... | 9 |
68
+ | A.3.1 IDL definition structure..... | 9 |
69
+ | A.3.2 IDL specification “GenericIRPManagementConstDefs.idl” ..... | 9 |
70
+ | A.3.3 IDL specification “GenericIRPManagementSystem.idl” ..... | 11 |
71
+ | <b>Annex B (normative): SOAP Solution Set.....</b> | <b>13</b> |
72
+ | B.1 Architectural Features..... | 13 |
73
+ | B.1.1 Syntax for Distinguished Names..... | 13 |
74
+ | B.2 Mapping ..... | 14 |
75
+ | B.2.1 Operation mapping..... | 14 |
76
+ | B.2.2 Operation parameter mapping..... | 14 |
77
+ | B.2.2.1 Operation getIRPVersion ..... | 14 |
78
+ | B.2.2.1.1 Input parameters ..... | 14 |
79
+ | B.2.2.1.2 Output parameters..... | 14 |
80
+ | B.2.2.1.3 Fault definition..... | 14 |
81
+ | B.2.2.2 Operation getOperationProfile ..... | 15 |
82
+ | B.2.2.2.1 Input parameters ..... | 15 |
83
+ | B.2.2.2.2 Output parameters..... | 15 |
84
+ | B.2.2.2.3 Fault definition..... | 15 |
85
+ | B.2.2.3 Operation getNotificationProfile ..... | 15 |
86
+ | B.2.2.3.1 Input parameters ..... | 15 |
87
+ | B.2.2.3.2 Output parameters..... | 16 |
88
+ | B.2.2.3.3 Fault definition..... | 16 |
89
+ | B.3 Solution Set definitions..... | 16 |
90
+ | B.3.1 WSDL definition structure ..... | 16 |
91
+ | B.3.2 Graphical Representation..... | 16 |
92
+ | B.3.3 WSDL specification “GenericIRPSystem.wsdl” ..... | 16 |
93
+ | Annex C (informative): Change history..... | 20 |
94
+
95
+ # --- Foreword
96
+
97
+ This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP).
98
+
99
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
100
+
101
+ Version x.y.z
102
+
103
+ where:
104
+
105
+ - x the first digit:
106
+ - 1 presented to TSG for information;
107
+ - 2 presented to TSG for approval;
108
+ - 3 or greater indicates TSG approved document under change control.
109
+ - y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
110
+ - z the third digit is incremented when editorial only changes have been incorporated in the document.
111
+
112
+ # --- Introduction
113
+
114
+ The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below:
115
+
116
+ - 32.311: Generic Integration Reference Point (IRP) management; Requirements
117
+ - 32.312: Generic Integration Reference Point (IRP) management; Information Service (IS)
118
+ - 32.316: Generic Integration Reference Point (IRP) management; Solution Set (SS) definitions**
119
+
120
+ # --- 1 Scope
121
+
122
+ The present document provides the Solution Set definitions for Generic Integration Reference Point (IRP) management, whose capabilities are specified in 3GPP TS 32.312 [1], the Generic IRP management: Information Service.
123
+
124
+ This Solution Set Definition specification is related to 3GPP TS 32.312 V10.0.X.
125
+
126
+ # --- 2 References
127
+
128
+ The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
129
+
130
+ - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
131
+ - For a specific reference, subsequent revisions do not apply.
132
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
133
+ - [1] 3GPP TS 32.312: "Telecommunication management; Generic Integration Reference Point (IRP) management: Information Service (IS)".
134
+ - [2] 3GPP TS 32.311: "Telecommunication management; Generic Integration Reference Point (IRP) management; Requirements".
135
+ - [3] 3GPP TS 32.111-2: "Telecommunication management; Alarm Integration Reference Point (IRP); Information Service (IS)".
136
+ - [4] 3GPP TS 32.302: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP): Information Service (IS)".
137
+ - [5] W3C WSDL 1.1 specification (<http://www.w3.org/TR/2001/NOTE-wSDL-20010315>)
138
+ - [6] Thompson, H.S., Beech, D., Maloney, M., Mendleshon, N., eds. (May 2002). "XML Schema Part 1: Structures," Recommendation, World Wide Web Consortium <http://www.w3.org/TR/xmlschema-1/>
139
+ - [7] Biron, P.V., Malhotra, A., eds. (May 2002). "XML Schema Part 2: Datatypes," Recommendation, World Wide Web Consortium <http://www.w3.org/TR/xmlschema-2/>
140
+ - [8] W3C SOAP 1.1 specification (<http://www.w3.org/TR/2000/NOTE-SOAP-20000508/>)
141
+ - [9] RFC 2616 (June 1999): "Hypertext Transfer Protocol – HTTP/1.1"
142
+ - [10] W3C WSDL 1.1 specification (<http://www.w3.org/TR/2001/NOTE-wSDL-20010315>)
143
+ - [11] W3C SOAP 1.2 specification (<http://www.w3.org/TR/soap12-part1/>)
144
+ - [12] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects".
145
+
146
+ # --- 3 Definitions and abbreviations
147
+
148
+ ## 3.1 Definitions
149
+
150
+ For the purposes of the present document, the terms and definitions given in TS 32.312 [1] apply.
151
+
152
+ **IRP document version number string (or "IRPVersion")**: See 3GPP TS 32.311 [2] subclause 3.1.
153
+
154
+ ## 3.2 Abbreviations
155
+
156
+ For the purposes of the present document, the following abbreviations apply:
157
+
158
+ | | |
159
+ |-------|--------------------------------------------|
160
+ | CORBA | Common Object Request Broker Architecture |
161
+ | HTTP | HyperText Transfer Protocol |
162
+ | IDL | Interface Definition Language |
163
+ | IRP | Integration Reference Point |
164
+ | IOC | Information Object Class |
165
+ | OMG | Object Management Group |
166
+ | SS | Solution Set |
167
+ | WSDL | Web Services Description Language |
168
+ | WS-I | Web Services Interoperability Organization |
169
+ | XML | eXtensible Markup Language |
170
+
171
+ # --- 4 Solution Set definitions
172
+
173
+ This specification defines the following 3GPP Generic IRP management Solution Set definitions:
174
+
175
+ - 3GPP Generic IRP management CORBA SS (Annex A)
176
+ - 3GPP Generic IRP management SOAP Solution Set (Annex B)
177
+
178
+ Solution Set to XML definitions is not present in the current version of this specification.
179
+
180
+ # --- Annex A (normative): CORBA Solution Set
181
+
182
+ This annex contains the CORBA Solution Set for the IRP whose semantics is specified in Generic IRP: Information Service (TS 32.312 [1]).
183
+
184
+ ---
185
+
186
+ ## A.1 Architectural Features
187
+
188
+ The overall architectural feature of this IRP is specified in 3G TS 32.312 [1]. This clause specifies features that are specific to the CORBA SS.
189
+
190
+ ### A.1.1 Syntax for Distinguished Names
191
+
192
+ The syntax of a Distinguished Name is defined in 3GPP TS 32.300 [12].
193
+
194
+ ### A.1.2 Abstract IOC
195
+
196
+ The capabilities of the Generic IRP management: IS [1] are captured by the definition of an IOC called ManagedGenericIRP. This IOC is an abstract class and is mapped to a MOC of the same name. The MOC is intended for inheritance by other MOCs specified in Interface IRPs such as AlarmIRP [3], NotificationIRP [4], etc.
197
+
198
+ ---
199
+
200
+ ## A.2 Mapping
201
+
202
+ ### A.2.1 Operation mapping
203
+
204
+ Generic IRP management: IS [1] defines semantics of operation visible across the Itf-N. Table A.1 indicates mapping of these operations to their equivalents defined in this SS.
205
+
206
+ **Table A.1: Mapping from IS Notification/Operation to SS equivalents**
207
+
208
+ | IS Operation TS 32.312 [1] | SS Method | Qualifier |
209
+ |----------------------------|----------------------------------------|-----------|
210
+ | getIRPVersion | get_irp_versions | M |
211
+ | getOperationProfile | get_interface_irp_operation_profile | O |
212
+ | getNotificationProfile | get_interface_irp_notification_profile | O |
213
+
214
+ ### A.2.2 Operation parameter mapping
215
+
216
+ Generic IRP management: IS [1] defines semantics of parameters carried in operations across the Itf-N. The following set of tables indicates the mapping of these parameters, as per operation, to their equivalents defined in this SS.
217
+
218
+ **Table A.2 Mapping from IS getIRPVersion parameters to SS equivalents**
219
+
220
+ | IS Operation parameter | SS Method parameter | Qualifier |
221
+ |------------------------|----------------------------------------------------------------------|-----------|
222
+ | versionNumberSet | Return value of type GenericIRPManagementConstDefs::VersionNumberSet | M |
223
+ | status | Exceptions:<br>GenericIRPManagementSystem::GetIRPVersions | M |
224
+
225
+ **Table A.3 Mapping from IS getOperationProfile parameters to SS equivalents**
226
+
227
+ | IS Operation parameter | SS Method parameter | Qualifier |
228
+ |----------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|
229
+ | iRPVersion | GenericIRPManagementConstDefs::VersionNumber<br>this_irp_version | M |
230
+ | operationNameProfile,<br>operationParameterProfile | Return value of type<br>GenericIRPManagementConstDefs::MethodList | M |
231
+ | status | Exceptions:<br>GenericIRPManagementSystem::GetInterfaceIRPOperationsProfile,<br>GenericIRPManagementSystem::OperationNotSupported,<br>GenericIRPManagementSystem::InvalidParameter,<br>GenericIRPManagementSystem::ValueNotSupported | M |
232
+
233
+ **Table A.4 Mapping from IS getNotificationProfile parameters to SS equivalents**
234
+
235
+ | IS Operation parameter | SS Method parameter | Qualifier |
236
+ |----------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|
237
+ | iRPVersion | GenericIRPManagementConstDefs::VersionNumber<br>this_irp_version | M |
238
+ | notificationNameProfile,<br>notificationParameterProfile | Return value of type<br>GenericIRPManagementConstDefs::NotificationList | M |
239
+ | status | Exceptions:<br>GenericIRPManagementSystem::GetInterfaceIRPNotificationProfile,<br>GenericIRPManagementSystem::OperationNotSupported,<br>GenericIRPManagementSystem::InvalidParameter,<br>GenericIRPManagementSystem::ValueNotSupported | M |
240
+
241
+ ## --- A.3 Solution Set definitions
242
+
243
+ ### A.3.1 IDL definition structure
244
+
245
+ Clause A.3.2 defines the constants and types used by the Generic IRP.
246
+
247
+ Clause A.3.3 defines the operations and notifications which are performed by the Generic IRP agent.
248
+
249
+ ### A.3.2 IDL specification “GenericIRPManagementConstDefs.idl”
250
+
251
+ ```
252
+ //File: GenericIRPManagementConstDefs.idl
253
+ #ifndef _GENERIC_IRP_MANAGEMENT_CONST_DEFS_IDL_
254
+ #define _GENERIC_IRP_MANAGEMENT_CONST_DEFS_IDL_
255
+ #include <TimeBase.idl>
256
+ // This statement must appear after all include statements
257
+ #pragma prefix "3gppsa5.org"
258
+ /* ## Module: GenericIRPManagementConstDefs
259
+ This module contains definitions commonly used among all IRPs.
260
+ =====
261
+ */
262
+ module GenericIRPManagementConstDefs
263
+ {
264
+ /*
265
+ * Definition imported from CosTime.
266
+ * The time refers to time in Greenwich Time Zone.
267
+ * It also consists of a time displacement factor in the form of minutes of
268
+ * displacement from the Greenwich Meridian.
269
+ */
270
+ typedef TimeBase::UtcT IRPTime;
271
+ typedef string DN;
272
+ typedef sequence <DN> DNList;
273
+
274
+ enum Signal {OK, FULL_FAILURE, PARTIAL_FAILURE};
275
+ enum Result {SUCCESS, FAILURE};
276
+ /*
277
+ * This holds a list of notification Ids
278
+ */
279
+ typedef sequence <long> NotifIdSet;
280
+
281
+ /*
282
+ * This holds identifiers of notifications that are correlated.
283
+ */
284
+ struct CorrelatedNotification
285
+ {
286
+ DN source;// Contains DN of MO that emitted the set of notifications
287
+ // DN string format in compliance with Name Convention for
288
+ // Managed Object.
289
+ // This may be a zero-length string. In this case, the MO
290
+ // is identified by the value of the MOI attribute
291
+ // of the Structured Event, i.e., the notification.
292
+ NotifIdSet notif_id_set; // Set of related notification ids
293
+ };
294
+ /*
295
+ * The VersionNumber is a string that identifies the IRP specification name
296
+ * and its version number. See definition "IRP document version number
297
+ * string" or "IRPVersion".
298
+ * The VersionNumberSet is a sequence of such VersionNumber. It is returned
299
+ * by get_XXX_IRP_versions(). The sequence order has no significance.
300
+ */
301
+ typedef string VersionNumber;
302
+ typedef sequence <VersionNumber> VersionNumberSet;
303
+ typedef string MethodName;
304
+ typedef string ParameterName;
305
+ typedef sequence <ParameterName> ParameterList;
306
+ /*
307
+ * The Method defines the structure to be returned as part of
308
+ * get_supported_operations_profile(). The name shall be the actual method
309
+ * name (ex. "attach_push", "change_subscription_filter", etc.)
310
+ * The parameter_list contains a list of strings. Each string shall be
311
+ * the actual parameter name (ex. "manager_reference", "filter", etc.)
312
+ */
313
+ struct Method
314
+ {
315
+ MethodName name;
316
+ };
317
+ }
318
+ ```
319
+
320
+ ```
321
+
322
+ ParameterList parameter_list;
323
+ };
324
+ /*
325
+ * List of all methods and their associated parameters.
326
+ */
327
+ typedef sequence <Method> MethodList;
328
+ typedef string NotificationName;
329
+ struct Notification
330
+ {
331
+ NotificationName name;
332
+ ParameterList parameter_list;
333
+ };
334
+ typedef sequence <Notification> NotificationList;
335
+ /*
336
+ * Defines the name of an attribute of a Managed Object
337
+ */
338
+ typedef string MOAttributeName;
339
+ /*
340
+ * Defines the value of an attribute of a Managed Object in form of a CORBA
341
+ * Any. Apart from basic datatypes already defined in CORBA, the allowed
342
+ * attribute value types are defined in the AttributeTypes module.
343
+ */
344
+ typedef any MOAttributeValue;
345
+ /*
346
+ * Represents an attribute: "name" is the attribute name
347
+ * and "value" is the attribute value.
348
+ */
349
+ struct MOAttribute
350
+ {
351
+ MOAttributeName name;
352
+ MOAttributeValue value;
353
+ };
354
+ typedef sequence <MOAttribute> MOAttributeSet;
355
+
356
+ typedef string ManagerIdentifier;
357
+ /*
358
+ * The following are types carrying an optional parameter.
359
+ * If the boolean is TRUE, then the value is present.
360
+ * Otherwise the value is absent.
361
+ */
362
+ union StringOpt switch (boolean)
363
+ {
364
+ case TRUE: string value;
365
+ };
366
+ union ShortOpt switch (boolean)
367
+ {
368
+ case TRUE: short value;
369
+ };
370
+ union UnsignedShortOpt switch (boolean)
371
+ {
372
+ case TRUE: unsigned short value;
373
+ };
374
+ union LongOpt switch (boolean)
375
+ {
376
+ case TRUE: long value;
377
+ };
378
+ union UnsignedLongOpt switch (boolean)
379
+ {
380
+ case TRUE: unsigned long value;
381
+ };
382
+ union IRPTimeOpt switch (boolean)
383
+ {
384
+ case TRUE: GenericIRPManagementConstDefs::IRPTime value;
385
+ };
386
+ };
387
+
388
+ #endif // _GENERIC_IRP_MANAGEMENT_CONST_DEFS_IDL_
389
+
390
+ ```
391
+
392
+ ### A.3.3 IDL specification “GenericIRPManagementSystem.idl”
393
+
394
+ ```
395
+ //File: GenericIRPManagementSystem.idl
396
+ #ifndef _GENERIC_IRP_MANAGEMENT_SYSTEM_IDL_
397
+ #define _GENERIC_IRP_MANAGEMENT_SYSTEM_IDL_
398
+
399
+ #include <GenericIRPManagementConstDefs.idl>
400
+
401
+ // This statement must appear after all include statements
402
+ #pragma prefix "3gppsa5.org"
403
+
404
+ module GenericIRPManagementSystem
405
+ {
406
+ exception GetInterfaceIRPNotificationProfile { string reason; };
407
+ exception GetInterfaceIRPOperationProfile { string reason; };
408
+ exception GetIRPVersions { string reason; };
409
+
410
+ /*
411
+ Exception thrown when an unsupported optional parameter
412
+ is passed with information.
413
+ The parameter shall be the actual unsupported parameter name.
414
+ */
415
+ exception ParameterNotSupported {
416
+ GenericIRPManagementConstDefs::ParameterName parameter; };
417
+
418
+ /*
419
+ Exception thrown when an invalid parameter value is passed.
420
+ The parameter shall be the actual parameter name.
421
+ */
422
+ exception InvalidParameter {
423
+ GenericIRPManagementConstDefs::ParameterName parameter; };
424
+
425
+ /*
426
+ Exception thrown when a valid but unsupported parameter value is passed.
427
+ The parameter shall be the actual parameter name.
428
+ */
429
+ exception ValueNotSupported {
430
+ GenericIRPManagementConstDefs::ParameterName parameter; };
431
+
432
+ /*
433
+ Exception thrown when an unsupported optional method is called.
434
+ */
435
+ exception OperationNotSupported {};
436
+
437
+ interface GenericIRPManagement
438
+ {
439
+ /*
440
+ Return the list of all supported Interface IRP versions
441
+ Each IRPVersion is defined by the rule in the definition
442
+ "IRP document version number string" or "IRPVersion"
443
+ (see subclause 3.1).
444
+ */
445
+ GenericIRPManagementConstDefs::VersionNumberSet get_irp_versions
446
+ (
447
+ )
448
+ raises (GetIRPVersions);
449
+
450
+ /*
451
+ Return the list of all supported methods and their supported
452
+ parameters for this Interface IRPVersion.
453
+ */
454
+ GenericIRPManagementConstDefs::MethodList
455
+ get_interface_irp_operation_profile
456
+ (
457
+ in GenericIRPManagementConstDefs::VersionNumber this_irp_version
458
+ )
459
+ raises (GetInterfaceIRPOperationProfile,
460
+ OperationNotSupported,
461
+ InvalidParameter,
462
+ ValueNotSupported);
463
+
464
+ /*
465
+ Return the list of all supported notifications and their supported
466
+ parameters for this Interface IRPVersion.
467
+ */
468
+ typedef GenericIRPManagementConstDefs::NotificationList NotificationList;
469
+ ```
470
+
471
+ ```
472
+ NotificationList get_interface_irp_notification_profile
473
+ (
474
+ in GenericIRPManagementConstDefs::VersionNumber this_irp_version
475
+ )
476
+ raises (GetInterfaceIRPNotificationProfile,
477
+ OperationNotSupported,
478
+ InvalidParameter,
479
+ ValueNotSupported);
480
+ };
481
+
482
+ };
483
+
484
+ #endif // _GENERIC_IRP_MANAGEMENT_SYSTEM_IDL_
485
+ ```
486
+
487
+ # --- Annex B (normative): SOAP Solution Set
488
+
489
+ This annex specifies the SOAP Solution Set for the IRP whose semantics are specified in Generic IRP: Information Service (3GPP TS 32.312[1]).
490
+
491
+ ## --- B.1 Architectural Features
492
+
493
+ The overall architectural feature of this IRP is specified in 3G TS 32.312 [1]. This clause specifies features that are specific to the SOAP SS.
494
+
495
+ The SOAP 1.1 specification [8] and WSDL 1.1 specification [5] are supported.
496
+
497
+ The SOAP 1.2 specification [11] is optionally supported.
498
+
499
+ This specification uses "document" style in the WSDL description.
500
+
501
+ This specification uses "literal" encoding style in the WSDL description.
502
+
503
+ This specification uses a number of namespace prefixes throughout that are listed in Table B.1.
504
+
505
+ **Table B.1: Prefixes and Namespaces used in this specification**
506
+
507
+ | Prefix | Namespace |
508
+ |------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|
509
+ | http | <a href="http://schemas.xmlsoap.org/wsdl/http/">http://schemas.xmlsoap.org/wsdl/http/</a> |
510
+ | soap | <a href="http://schemas.xmlsoap.org/wsdl/soap/">http://schemas.xmlsoap.org/wsdl/soap/</a> |
511
+ | SOAP-ENV | <a href="http://schemas.xmlsoap.org/soap/envelope/">http://schemas.xmlsoap.org/soap/envelope/</a> |
512
+ | SOAP-ENC or<br>soapenc | <a href="http://schemas.xmlsoap.org/soap/encoding/">http://schemas.xmlsoap.org/soap/encoding/</a> |
513
+ | xs or xsd | <a href="http://www.w3.org/2001/XMLSchema">http://www.w3.org/2001/XMLSchema</a> |
514
+ | xsi | <a href="http://www.w3.org/2001/XMLSchema-instance">http://www.w3.org/2001/XMLSchema-instance</a> |
515
+ | genericIRPData | <a href="http://www.3gpp.org/ftp/specs/archive/32_series/32.316#GenericIRPData">http://www.3gpp.org/ftp/specs/archive/32_series/32.316#GenericIRPData</a> |
516
+
517
+ ### B.1.1 Syntax for Distinguished Names
518
+
519
+ The syntax of a Distinguished Name is defined in 3GPP TS 32.300 [12].
520
+
521
+ ## B.2 Mapping
522
+
523
+ ### B.2.1 Operation mapping
524
+
525
+ Generic IRP management: IS [1] defines semantics of operation visible across the Itf-N. Table B.2.1 indicates mapping of these operations to their equivalents defined in this SS.
526
+
527
+ **Table B.2.1: Mapping from IS Notification/Operation to SS equivalents**
528
+
529
+ | IS Operation TS 32.312 [1] | SS Operation | Qualifier |
530
+ |----------------------------|------------------------|-----------|
531
+ | getIRPVersion | getIRPVersion | M |
532
+ | getOperationProfile | getOperationProfile | O |
533
+ | getNotificationProfile | getNotificationProfile | O |
534
+
535
+ ### B.2.2 Operation parameter mapping
536
+
537
+ #### B.2.2.1 Operation getIRPVersion
538
+
539
+ ##### B.2.2.1.1 Input parameters
540
+
541
+ None.
542
+
543
+ Here is the XML schema fragment of the getIRPVersion request:
544
+
545
+ ```
546
+ <!-- getIRPVersion Request -->
547
+ <element name="getIRPVersion">
548
+ </element>
549
+ ```
550
+
551
+ ##### B.2.2.1.2 Output parameters
552
+
553
+ None.
554
+
555
+ **Table B.2.2.1.2: Mapping from IS getIRPVersion output parameters to SS equivalents**
556
+
557
+ | IS Operation parameter | SS Operation parameter | Qualifier |
558
+ |------------------------|------------------------------------------------------|-----------|
559
+ | versionNumberSet | genericIRPData:VersionNumberSetType versionNumberSet | M |
560
+ | status | genericIRPData:getIRPVersionFault | M |
561
+
562
+ Here is the XML schema fragment of the getIRPVersion response:
563
+
564
+ ```
565
+ <!-- getIRPVersion Response -->
566
+ <element name="getIRPVersionResponse">
567
+ <complexType>
568
+ <sequence>
569
+ <element name="versionNumberSet" type="genericIRPData:VersionNumberSetType"/>
570
+ </sequence>
571
+ </complexType>
572
+ </element>
573
+ ```
574
+
575
+ ##### B.2.2.1.3 Fault definition
576
+
577
+ ```
578
+ <!-- getIRPVersion Fault -->
579
+ <element name="getIRPVersionFault">
580
+ <complexType>
581
+ <choice>
582
+ <element name="getIRPVersionFault" type="string" default="getIRPVersionFault"/>
583
+ </choice>
584
+ </complexType>
585
+ </element>
586
+ ```
587
+
588
+ #### B.2.2.2 Operation getOperationProfile
589
+
590
+ ##### B.2.2.2.1 Input parameters
591
+
592
+ **Table B.2.2.2.1: Mapping from IS getOperationProfile input parameters to SS equivalents**
593
+
594
+ | IS Operation parameter | SS Operation parameter | Qualifier |
595
+ |------------------------|---------------------------------------------|-----------|
596
+ | iRPVersion | genericIRPData:VersionNumberType iRPVersion | M |
597
+
598
+ Here is the XML schema fragment of the getOperationProfile request:
599
+
600
+ ```
601
+ <!-- getOperationProfile Request -->
602
+ <element name="getOperationProfile">
603
+ <complexType>
604
+ <sequence>
605
+ <element name="iRPVersion" type="genericIRPData:VersionNumberType"/>
606
+ </sequence>
607
+ </complexType>
608
+ </element>
609
+ ```
610
+
611
+ ##### B.2.2.2.2 Output parameters
612
+
613
+ **Table B.2.2.2.2: Mapping from IS getOperationProfile output parameters to SS equivalents**
614
+
615
+ | IS Operation parameter | SS Operation parameter | Qualifier |
616
+ |------------------------------------------------|----------------------------------------------|-----------|
617
+ | operationNameProfile,operationParameterProfile | genericIRPData:OperationSetType operationSet | M |
618
+ | status | genericIRPData:getOperationProfileFault | M |
619
+
620
+ Here is the XML schema fragment of the getOperationProfile response:
621
+
622
+ ```
623
+ <!-- getOperationProfile Response -->
624
+ <element name="getOperationProfileResponse">
625
+ <complexType>
626
+ <sequence>
627
+ <element name="operationSet" type="genericIRPData:OperationSetType"/>
628
+ </sequence>
629
+ </complexType>
630
+ </element>
631
+ ```
632
+
633
+ ##### B.2.2.2.3 Fault definition
634
+
635
+ ```
636
+ <!-- getOperationProfile Fault -->
637
+
638
+ <element name="getOperationProfileFault">
639
+ <complexType>
640
+ <choice>
641
+ <element name="getOperationProfileFault" type="string"/>
642
+ <element ref="genericIRPData:OperationNotSupportedFault"/>
643
+ <element ref="genericIRPData:InvalidParameterFault"/>
644
+ </choice>
645
+ </complexType>
646
+ </element>
647
+ ```
648
+
649
+ #### B.2.2.3 Operation getNotificationProfile
650
+
651
+ ##### B.2.2.3.1 Input parameters
652
+
653
+ **Table B.2.2.3.1: Mapping from IS getNotificationProfile input parameters to SS equivalents**
654
+
655
+ | IS Operation parameter | SS Operation parameter | Qualifier |
656
+ |------------------------|---------------------------------------------|-----------|
657
+ | iRPVersion | genericIRPData:VersionNumberType iRPVersion | M |
658
+
659
+ Here is the XML schema fragment of the getNotificationProfile request:
660
+
661
+ ```
662
+ <!-- getNotificationProfile Request -->
663
+ ```
664
+
665
+ ```
666
+
667
+ <element name="getNotificationProfile">
668
+ <complexType>
669
+ <sequence>
670
+ <element name="iRPVersion" type="genericIRPData:VersionNumberType"/>
671
+ </sequence>
672
+ </complexType>
673
+ </element>
674
+
675
+ ```
676
+
677
+ ##### B.2.2.3.2 Output parameters
678
+
679
+ **Table B.2.2.3.2: Mapping from IS getNotificationProfile output parameters to SS equivalents**
680
+
681
+ | IS Operation parameter | SS Operation parameter | Qualifier |
682
+ |------------------------------------------------------|----------------------------------------------------|-----------|
683
+ | notificationNameProfile,notificationParameterProfile | genericIRPData:NotificationSetType notificationSet | M |
684
+ | Status | genericIRPData:getNotificationProfileFault | M |
685
+
686
+ Here is the XML schema fragment of the getNotificationProfile response:
687
+
688
+ ```
689
+
690
+ <!-- getNotificationProfile Response -->
691
+ <element name="getNotificationProfileResponse">
692
+ <complexType>
693
+ <sequence>
694
+ <element name="notificationSet" type="genericIRPData:NotificationSetType"/>
695
+ </sequence>
696
+ </complexType>
697
+ </element>
698
+
699
+ ```
700
+
701
+ ##### B.2.2.3.3 Fault definition
702
+
703
+ ```
704
+
705
+ <!-- getNotificationProfile Fault -->
706
+ <element name="getNotificationProfileFault">
707
+ <complexType>
708
+ <choice>
709
+ <element name="getNotificationProfileFault" type="string"
710
+ default="getNotificationProfileFault"/>
711
+ <element ref="genericIRPData:OperationNotSupportedFault"/>
712
+ <element ref="genericIRPData:InvalidParameterFault"/>
713
+ </choice>
714
+ </complexType>
715
+ </element>
716
+
717
+ ```
718
+
719
+ ## B.3 Solution Set definitions
720
+
721
+ ### B.3.1 WSDL definition structure
722
+
723
+ Clause B.3.2 provides a graphical representation of the Generic IRP service.
724
+
725
+ Clause B.3.3 defines the services which are supported the Generic IRP agent.
726
+
727
+ ### B.3.2 Graphical Representation
728
+
729
+ Not present in the current version of this specification.
730
+
731
+ ### B.3.3 WSDL specification “GenericIRPSystem.wsdl”
732
+
733
+ ```
734
+
735
+ <?xml version="1.0" encoding="UTF-8"?>
736
+ <definitions xmlns="http://schemas.xmlsoap.org/wsdl/"
737
+ xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
738
+ xmlns:genericIRPSystem="http://www.3gpp.org/ftp/specs/archive/32_series/32.316#GenericIRPSystem"
739
+ xmlns:xs="http://www.w3.org/2001/XMLSchema"
740
+ xmlns:genericIRPData="http://www.3gpp.org/ftp/specs/archive/32_series/32.316#GenericIRPData"
741
+ targetNamespace="http://www.3gpp.org/ftp/specs/archive/32_series/32.316#GenericIRPSystem">
742
+
743
+ ```
744
+
745
+ ```
746
+
747
+ <types>
748
+ <schema
749
+ targetNamespace="http://www.3gpp.org/ftp/specs/archive/32_series/32.316#GenericIRPData"
750
+ xmlns="http://www.w3.org/2001/XMLSchema">
751
+ <element name="OperationNotSupportedFault" type="string"/>
752
+ <element name="InvalidParameterFault" type="string"/>
753
+ <simpleType name="VersionNumberType">
754
+ <restriction base="string"/>
755
+ </simpleType>
756
+ <complexType name="VersionNumberSetType">
757
+ <sequence>
758
+ <element name="versionNumber" type="genericIRPData:VersionNumberType"
759
+ maxOccurs="unbounded"/>
760
+ </sequence>
761
+ </complexType>
762
+ <complexType name="ParameterSetType">
763
+ <sequence>
764
+ <element name="parameterName" type="string" maxOccurs="unbounded"/>
765
+ </sequence>
766
+ </complexType>
767
+ <complexType name="OperationType">
768
+ <sequence>
769
+ <element name="operationName" type="string"/>
770
+ <element name="parameterSet" type="genericIRPData:ParameterSetType"/>
771
+ </sequence>
772
+ </complexType>
773
+ <complexType name="OperationSetType">
774
+ <sequence>
775
+ <element name="operation" type="genericIRPData:OperationType"
776
+ maxOccurs="unbounded"/>
777
+ </sequence>
778
+ </complexType>
779
+ <complexType name="NotificationType">
780
+ <sequence>
781
+ <element name="notificationName" type="string"/>
782
+ <element name="parameterSet" type="genericIRPData:ParameterSetType"/>
783
+ </sequence>
784
+ </complexType>
785
+ <complexType name="NotificationSetType">
786
+ <sequence>
787
+ <element name="notification" type="genericIRPData:NotificationType"
788
+ maxOccurs="unbounded"/>
789
+ </sequence>
790
+ </complexType>
791
+ <!-- getIRPVersion Request -->
792
+ <element name="getIRPVersion"/>
793
+ <!-- getIRPVersion Response -->
794
+ <element name="getIRPVersionResponse">
795
+ <complexType>
796
+ <sequence>
797
+ <element name="versionNumberSet" type="genericIRPData:VersionNumberSetType"/>
798
+ </sequence>
799
+ </complexType>
800
+ </element>
801
+ <!-- getIRPVersion Fault -->
802
+ <element name="getIRPVersionFault">
803
+ <complexType>
804
+ <choice>
805
+ <element name="getIRPVersionFault" type="string"/>
806
+ </choice>
807
+ </complexType>
808
+ </element>
809
+ <!-- getOperationProfile Request -->
810
+ <element name="getOperationProfile">
811
+ <complexType>
812
+ <sequence>
813
+ <element name="iRPVersion" type="genericIRPData:VersionNumberType"/>
814
+ </sequence>
815
+ </complexType>
816
+ </element>
817
+ <!-- getOperationProfile Response -->
818
+ <element name="getOperationProfileResponse">
819
+ <complexType>
820
+ <sequence>
821
+ <element name="operationSet" type="genericIRPData:OperationSetType"/>
822
+ </sequence>
823
+ </complexType>
824
+ </element>
825
+ </schema>
826
+ </types>
827
+
828
+ ```
829
+
830
+ ```
831
+
832
+ <!-- getOperationProfile Fault -->
833
+ <element name="getOperationProfileFault">
834
+ <complexType>
835
+ <choice>
836
+ <element name="getOperationProfileFault" type="string"/>
837
+ <element ref="genericIRPData:OperationNotSupportedFault"/>
838
+ <element ref="genericIRPData:InvalidParameterFault"/>
839
+ </choice>
840
+ </complexType>
841
+ </element>
842
+ <!-- getNotificationProfile Request -->
843
+ <element name="getNotificationProfile">
844
+ <complexType>
845
+ <sequence>
846
+ <element name="iRPVersion" type="genericIRPData:VersionNumberType"/>
847
+ </sequence>
848
+ </complexType>
849
+ </element>
850
+ <!-- getNotificationProfile Response -->
851
+ <element name="getNotificationProfileResponse">
852
+ <complexType>
853
+ <sequence>
854
+ <element name="notificationSet" type="genericIRPData:NotificationSetType"/>
855
+ </sequence>
856
+ </complexType>
857
+ </element>
858
+ <!-- getNotificationProfile Fault -->
859
+ <element name="getNotificationProfileFault">
860
+ <complexType>
861
+ <choice>
862
+ <element name="getNotificationProfileFault" type="string"/>
863
+ <element ref="genericIRPData:OperationNotSupportedFault"/>
864
+ <element ref="genericIRPData:InvalidParameterFault"/>
865
+ </choice>
866
+ </complexType>
867
+ </element>
868
+ </schema>
869
+ </types>
870
+ <message name="getIRPVersionRequest">
871
+ <part name="parameter" element="genericIRPData:getIRPVersion"/>
872
+ </message>
873
+ <message name="getIRPVersionResponse">
874
+ <part name="parameter" element="genericIRPData:getIRPVersionResponse"/>
875
+ </message>
876
+ <message name="getIRPVersionFault">
877
+ <part name="parameter" element="genericIRPData:getIRPVersionFault"/>
878
+ </message>
879
+ <message name="getOperationProfileRequest">
880
+ <part name="parameter" element="genericIRPData:getOperationProfile"/>
881
+ </message>
882
+ <message name="getOperationProfileResponse">
883
+ <part name="parameter" element="genericIRPData:getOperationProfileResponse"/>
884
+ </message>
885
+ <message name="getOperationProfileFault">
886
+ <part name="parameter" element="genericIRPData:getOperationProfileFault"/>
887
+ </message>
888
+ <message name="getNotificationProfileRequest">
889
+ <part name="parameter" element="genericIRPData:getNotificationProfile"/>
890
+ </message>
891
+ <message name="getNotificationProfileResponse">
892
+ <part name="parameter" element="genericIRPData:getNotificationProfileResponse"/>
893
+ </message>
894
+ <message name="getNotificationProfileFault">
895
+ <part name="parameter" element="genericIRPData:getNotificationProfileFault"/>
896
+ </message>
897
+ <portType name="GenericIRPPortType">
898
+ <operation name="getIRPVersion">
899
+ <input message="genericIRPSystem:getIRPVersionRequest"/>
900
+ <output message="genericIRPSystem:getIRPVersionResponse"/>
901
+ <fault name="getIRPVersionFault" message="genericIRPSystem:getIRPVersionFault"/>
902
+ </operation>
903
+ <operation name="getOperationProfile">
904
+ <input message="genericIRPSystem:getOperationProfileRequest"/>
905
+ <output message="genericIRPSystem:getOperationProfileResponse"/>
906
+ <fault name="getOperationProfileFault"
907
+ message="genericIRPSystem:getOperationProfileFault"/>
908
+ </operation>
909
+ <operation name="getNotificationProfile">
910
+
911
+ ```
912
+
913
+ ```
914
+
915
+ <input message="genericIRPSystem:getNotificationProfileRequest"/>
916
+ <output message="genericIRPSystem:getNotificationProfileResponse"/>
917
+ <fault name="getNotificationProfileFault"
918
+ message="genericIRPSystem:getNotificationProfileFault"/>
919
+ </operation>
920
+ </portType>
921
+ <binding name="GenericIRPBinding" type="genericIRPSystem:GenericIRPPortType">
922
+ <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
923
+ <operation name="getIRPVersion">
924
+ <soap:operation
925
+ soapAction="http://www.3gpp.org/ftp/specs/archive/32_series/32.316#getIRPVersion" style="document"/>
926
+ <input>
927
+ <soap:body use="literal"/>
928
+ </input>
929
+ <output>
930
+ <soap:body use="literal"/>
931
+ </output>
932
+ <fault name="getIRPVersionFault">
933
+ <soap:fault name="getIRPVersionFault" use="literal"/>
934
+ </fault>
935
+ </operation>
936
+ <operation name="getOperationProfile">
937
+ <soap:operation
938
+ soapAction="http://www.3gpp.org/ftp/specs/archive/32_series/32.316#getOperationProfile"
939
+ style="document"/>
940
+ <input>
941
+ <soap:body use="literal"/>
942
+ </input>
943
+ <output>
944
+ <soap:body use="literal"/>
945
+ </output>
946
+ <fault name="getOperationProfileFault">
947
+ <soap:fault name="getOperationProfileFault" use="literal"/>
948
+ </fault>
949
+ </operation>
950
+ <operation name="getNotificationProfile">
951
+ <soap:operation
952
+ soapAction="http://www.3gpp.org/ftp/specs/archive/32_series/32.316#getNotificationProfile"
953
+ style="document"/>
954
+ <input>
955
+ <soap:body use="literal"/>
956
+ </input>
957
+ <output>
958
+ <soap:body use="literal"/>
959
+ </output>
960
+ <fault name="getNotificationProfileFault">
961
+ <soap:fault name="getNotificationProfileFault" use="literal"/>
962
+ </fault>
963
+ </operation>
964
+ </binding>
965
+ </definitions>
966
+
967
+ ```
968
+
969
+ # --- Annex C (informative): Change history
970
+
971
+ | Change history | | | | | | | | | |
972
+ |----------------|-------|-----------|----|-----|-------------------------------------------------|----|-----------|------------|-----|
973
+ | Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | | Ca<br>t | Old | New |
974
+ | 2010-05 | SA-48 | SP-100272 | -- | -- | Presentation to SA for information and approval | -- | -- | 1.0.0 | |
975
+ | 06-2010 | SA-48 | -- | -- | -- | Publication | -- | 1.0.<br>0 | 10.0.<br>0 | |
976
+
977
+ Error! No
978
+
979
+ 20
980
+
981
+ Error! No text of specified style in
982
+
983
+ Error! No
984
+
985
+ 20
986
+
987
+ Error! No text of specified style in
marked/Rel-10/32_series/32321/raw.md ADDED
@@ -0,0 +1,342 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+ # **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; Test management Integration Reference Point (IRP); Requirements (Release 10)**
4
+
5
+ ![LTE Advanced logo](935eed7aa61f7777f62cfc032e11bee9_img.jpg)
6
+
7
+ The logo for LTE Advanced, featuring the word "lte" in bold lowercase letters with a red signal icon above the "e". The word "ADVANCED" is written in smaller capital letters above the "e". A trademark symbol (TM) is at the bottom right of the "e".
8
+
9
+ LTE Advanced logo
10
+
11
+ ![3GPP logo](30a26f2d17ca95672702bf50fb4f0242_img.jpg)
12
+
13
+ The logo for 3GPP, featuring the letters "3GPP" in a stylized, bold font. The "3" is black, "G" is black, "P" is black, and "P" is black. A red signal icon is positioned below the "G". A trademark symbol (TM) is at the top right of the "P".
14
+
15
+ 3GPP logo
16
+
17
+ Keywords
18
+ UMTS, GSM, management
19
+
20
+ # **3GPP**
21
+
22
+ Postal address
23
+
24
+ ---
25
+
26
+ 3GPP support office address
27
+
28
+ ---
29
+
30
+ 650 Route des Lucioles - Sophia Antipolis
31
+ Valbonne - FRANCE
32
+ Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
33
+
34
+ Internet
35
+
36
+ ---
37
+
38
+ <http://www.3gpp.org>
39
+
40
+ # ***Copyright Notification***
41
+
42
+ No part may be reproduced except as authorized by written permission.
43
+ The copyright and the foregoing restriction extend to reproduction in all media.
44
+
45
+ © 2011, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TTA, TTC).
46
+ All rights reserved.
47
+
48
+ UMTSTM is a Trade Mark of ETSI registered for the benefit of its members
49
+ 3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
50
+ LTETM is a Trade Mark of ETSI currently being registered for the benefit of its Members and of the 3GPP Organizational Partners
51
+ GSM® and the GSM logo are registered and owned by the GSM Association
52
+
53
+ # Contents
54
+
55
+ | | |
56
+ |--------------------------------------------|----|
57
+ | Foreword ..... | 4 |
58
+ | Introduction ..... | 4 |
59
+ | 1 Scope..... | 5 |
60
+ | 2 References..... | 5 |
61
+ | 3 Definitions and abbreviations ..... | 6 |
62
+ | 3.1 Definitions..... | 6 |
63
+ | 3.2 Abbreviations ..... | 6 |
64
+ | 4 Purpose..... | 6 |
65
+ | 5 Requirements ..... | 7 |
66
+ | 5.1 Overview ..... | 7 |
67
+ | 5.2 Test..... | 7 |
68
+ | 5.2.1 Test Initiation..... | 7 |
69
+ | 5.2.2 Test Termination ..... | 8 |
70
+ | 5.2.2.1 Explicit Test Termination ..... | 8 |
71
+ | 5.2.2.2 Implicit Test Termination ..... | 8 |
72
+ | 5.2.3 Test Monitoring ..... | 8 |
73
+ | 5.2.4 Test Result Reporting..... | 9 |
74
+ | 5.3 Test States ..... | 9 |
75
+ | 5.4 Test Categories..... | 10 |
76
+ | 5.4.1 Resource Self Test..... | 10 |
77
+ | 5.4.2 Connection Test..... | 10 |
78
+ | 5.4.3 Loopback Test ..... | 10 |
79
+ | Annex A (informative): Change history..... | 11 |
80
+
81
+ # --- Foreword
82
+
83
+ This Technical Specification (TS) has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP).
84
+
85
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
86
+
87
+ Version x.y.z
88
+
89
+ where:
90
+
91
+ - x the first digit:
92
+ - 1 presented to TSG for information;
93
+ - 2 presented to TSG for approval;
94
+ - 3 or greater indicates TSG approved document under change control.
95
+ - y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
96
+ - z the third digit is incremented when editorial only changes have been incorporated in the document.
97
+
98
+ # --- Introduction
99
+
100
+ The present document is part of a TS-family covering the 3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below:
101
+
102
+ - 32.321:** "Test management Integration Reference Point (IRP): Requirements";
103
+ - 32.322:** "Test management Integration Reference Point (IRP): Information Service (IS)";
104
+ - 32.326:** "Test management Integration Reference Point (IRP): Solution Set (SS) definitions".
105
+
106
+ A 3G telecommunication network is composed of a multitude of different network elements (NE). For a successful operation of the network the operator must be provided with mechanisms allowing him to manage the network. These management activities can be grouped into several areas: configuration management, fault management, performance management, accounting management and security management.
107
+
108
+ A management function assisting in different high level management areas such as fault management and performance management is test management. The purpose of testing is to get information about the functionality and performance of the 3G managed network subject to the test.
109
+
110
+ The present document is part of a set of technical specifications defining the telecommunication management (TM) of 3G systems. The TM principles are described in 3GPP TS 32.101 [5]. The TM architecture is described in 3GPP TS 32.102 [6]. The other specifications define the interface (ITf-N) between the managing system (manager), which is in general the network manager (NM) and the managed system (agent), which is either an element manager (EM) or the managed NE itself. The Itf-N is composed of a number of integration reference points (IRPs) defining the information in the agent that is visible for the manager, the operations that the manager may perform on this information and the notifications that are sent from the agent to the manager. One of these IRPs is the Test Management IRP.
111
+
112
+ Each IRP is specified by a set of TSs: Requirements, Information Service, CORBA SS, etc.
113
+
114
+ # --- 1 Scope
115
+
116
+ The present document describes, in addition to the requirements defined in [1] and [2], the requirements for the Test Management IRP.
117
+
118
+ # --- 2 References
119
+
120
+ The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
121
+
122
+ - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
123
+ - For a specific reference, subsequent revisions do not apply.
124
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
125
+
126
+ - [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements".
127
+ - [2] 3GPP TS 32.102: "Telecommunication management; Architecture".
128
+ - [3] ITU-T Recommendation X.745: "Information technology - Open Systems Interconnection - Systems Management: Test management function".
129
+ - [4] 3GPP TS 32.301: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP): Requirements".
130
+ - [5] Void
131
+ - [6] ITU-T Recommendation X.737: "Information technology - Open Systems Interconnection; Systems Management: Confidence and diagnostic test categories".
132
+ - [7] IETF RFC2679: "A One-way Delay Metric for IPPM".
133
+ - [8] IETF RFC3393: "IP Packet Delay Variation Metric for IP Performance Metrics (IPPM)".
134
+ - [9] IETF RFC2680: "A One-way Packet Loss Metric for IPPM".
135
+ - [10] IETF RFC2681: "A Round-trip Delay Metric for IPPM".
136
+
137
+ # --- 3 Definitions and abbreviations
138
+
139
+ ## 3.1 Definitions
140
+
141
+ For the purposes of the present document, the following terms and definitions apply:
142
+
143
+ **test category:** one or more tests sharing a common purpose and similar characteristics
144
+
145
+ **Tester Object (TO):** managed object that is instantiated for the purpose of monitoring and controlling a test invocation
146
+ Each test invocation has one associated TO. TOs are created and deleted by managed objects with TARR functionality.
147
+
148
+ ## 3.2 Abbreviations
149
+
150
+ For the purposes of the present document, the following abbreviations apply:
151
+
152
+ | | |
153
+ |------|------------------------------|
154
+ | NE | Network Element |
155
+ | NM | Network Management Center |
156
+ | TARR | Test Action Request Receiver |
157
+ | TO | Tester Object |
158
+
159
+ # --- 4 Purpose
160
+
161
+ The purpose of testing is to get information about the functionality and performance of the 3G managed network subject to the test. This information can be used in other network management areas, for instance in fault management.
162
+
163
+ Testing is an activity that involves the operator, the managing system (the OS) and the managed system (the NE). Generally the operator requests the execution of tests from the OS and the managed NE autonomously executes the tests without any further support from the operator.
164
+
165
+ In case of intrusive tests it is required that the network resources to be tested are locked prior to test execution. During the test execution the telecommunication service provided by the network resources is interrupted. After completion of the test, depending on the test result, the network resources shall be set to the most appropriate state.
166
+
167
+ Test management capabilities should be provided over the Itf-N in order to allow the NM operator to perform tests on network resources. This capability is especially important at times when only the NM but not the OMC is attended, which might be the case at night or during weekends.
168
+
169
+ In the context of fault management the NM operator may use the testing capabilities over the Itf-N for numerous purposes:
170
+
171
+ - When a fault has been detected and if the information provided in the alarm report is not sufficient to localise the faulty resource, tests can be executed in order to localise the fault.
172
+ - When a fault has been detected and if the information provided in the alarm report specifies the faulty resource, tests can be executed on that resource in order to determine the required repair action.
173
+ - During normal operation of the NE, tests can be executed for the purpose of discovering undetected faults.
174
+ - After a faulty resource has been repaired or replaced and before it is restored to service, tests can be executed on that resource in order to make sure that it is fault free.
175
+
176
+ However, regardless of the context where the testing is used, its target is always the same: verify if a system's physical or functional resource performs properly and, in case it happens to be faulty, provide all the information to help the operator to localise and correct the fault.
177
+
178
+ The requirements for the test management service shall be based on ITU-T Recommendation X.745 [3].
179
+
180
+ # --- 5 Requirements
181
+
182
+ ## 5.1 Overview
183
+
184
+ The IRPManager (test conductor) must be able to initiate and terminate tests. For this purpose special test initiation and termination requests may be used. The IRPAgent (test performer) must be able to receive and react upon these requests. Special objects may be created for the purpose of monitoring and control of the test execution. During test execution the IRPManager shall be able to monitor the test.
185
+
186
+ Test results shall be made available to the IRPManager by test result reports (notifications). It shall be possible to log these test result reports.
187
+
188
+ This gives rise to the following requirements for the test management function to be satisfied:
189
+
190
+ - the ability for the manager to initiate tests;
191
+ - the ability for the manager to terminate tests;
192
+ - the ability for the manager to monitor the test execution;
193
+ - the specification of a mechanism to report the test results to the manager;
194
+ - the specification of a mechanism to log test results in the agent.
195
+
196
+ These capabilities are outlined in the following sections in more detail.
197
+
198
+ ## 5.2 Test
199
+
200
+ ### 5.2.1 Test Initiation
201
+
202
+ The IRPManager shall be able to initiate a test in the IRPAgent by sending a test request to the IRPAgent. The IRPAgent must have at least one object instance capable of receiving these test requests. In response to a test request one or more tests shall be initiated. Each test shall be controlled and monitored individually by special objects instantiated exclusively for this purpose. These objects are called Tester Objects (TOs). Each of the tests initiated in response to a test request shall have a single associated TO.
203
+
204
+ The test request shall include the following information:
205
+
206
+ - The network resources to be tested.
207
+ - Information about the managed objects (e.g. TOs) assisting in the test execution.
208
+ - Any other information useful for the test execution.
209
+
210
+ In response to the test request the IRPAgent shall send a test request response to the IRPManager. For a successful test request this response shall contain the following information:
211
+
212
+ - A unique identifier for each test initiated by the test request.
213
+ - Information about the managed objects assisting to execute the test.
214
+
215
+ For a failed test request the response shall contain the following information:
216
+
217
+ - Information about the reason for the failure.
218
+
219
+ ### 5.2.2 Test Termination
220
+
221
+ A test may terminate in two different ways, either by request (explicit test termination) or spontaneously (implicit test termination).
222
+
223
+ #### 5.2.2.1 Explicit Test Termination
224
+
225
+ During the lifetime of a test explicit test termination may be requested by the IRPManager by:
226
+
227
+ - Emission of a test termination request.
228
+
229
+ The test termination request must be directed to the object in the IRPAgent which received the test request. The test termination request shall provide the following information:
230
+
231
+ - The identifiers of the tests to be terminated.
232
+
233
+ All TO(s) related to the tests to be terminated shall be deleted.
234
+
235
+ After reception of a test termination request a test termination response shall be generated by the IRPAgent and forwarded to the IRPManager. In case the test termination request is successful the test termination response shall contain the following information:
236
+
237
+ - The identifiers of all tests that have been successfully terminated.
238
+
239
+ If one or more of the tests specified in the test termination request cannot be terminated a test termination request failure response shall be generated. This response shall contain the following information:
240
+
241
+ - The identifiers of the tests that could not be deleted.
242
+ - Information about the reason for the failure.
243
+
244
+ #### 5.2.2.2 Implicit Test Termination
245
+
246
+ Implicit test termination may be triggered by three events:
247
+
248
+ - Fulfilment of conditions for a successful completion of the test.
249
+ - Fulfilment of conditions for a premature termination of the test, e.g. expiry of a time-out period.
250
+ - Occurrence of abnormal conditions, e.g. fault situations.
251
+
252
+ ### 5.2.3 Test Monitoring
253
+
254
+ The IRPManager shall be able to monitor the tests, i. e. get information about the tests while they are still executing. For this purpose the IRPManager shall be able to inquire the values of attributes containing specific information about the test execution.
255
+
256
+ ### 5.2.4 Test Result Reporting
257
+
258
+ Test results shall be made available to the IRPManager by one or more notifications emitted by the TO that is related to the test. These notifications shall be generated in an automatic manner upon occurrence of predefined triggering events without that any action of the IRPManager is required (unsolicited reporting). The triggering events depend on the test category and shall be defined by the TO class behaviour.
259
+
260
+ Depending on the nature of the test and the amount of test result data to be transferred to the IRPManager it may be beneficial to capture some test result data in a file and to transfer this file to the IRPManager. It is up to the TO to decide whether the file based transfer of test result data shall be used in addition to the emission of test result notifications.
261
+
262
+ Test result notifications may be emitted during the test execution (intermediate test result reporting) and at the end of the test execution (final test result reporting).
263
+
264
+ The event triggering the emission of final test result reports is the termination of the test execution, irrespective of if the test terminates by request or spontaneously except for the case where the test is terminated by deleting its related TO. This applies to all test categories.
265
+
266
+ The events triggering intermediate test result reporting depend on the test category. They may include:
267
+
268
+ - Arrival of the test execution at specified points, for example at the end of test phases.
269
+ - Expiry of specified reporting time intervals.
270
+ - Fulfilment of certain predefined criteria.
271
+
272
+ A test result notification shall include the following information:
273
+
274
+ - The identifier of the test for which the results are reported.
275
+ - Information about the outcome of the test, e.g. if the test terminated successfully upon test completion or prematurely.
276
+ - Information about the test and the test execution, e.g. tested network resources, proposed repair actions in case of fault detection.
277
+ - Any other useful information pertaining to the test.
278
+
279
+ For test result reporting the Notification IRP as defined in 3GPP TS 32.301 [4] to 3GPP TS 32.304 [5] shall be used. According to the operations provided by the Notification IRP the IRPManager is able to specify filter conditions selecting the notifications that are forwarded over the Itf-N to the IRPManager. Notifications not satisfying the filter conditions are discarded.
280
+
281
+ ## 5.3 Test States
282
+
283
+ For the purpose of monitoring tests TOs shall provide information about the current state of a test. Therefore each TO shall support a special test state attribute. The test state may assume one of the following values: not initialised, idle, initialising, testing, terminating, disabled. The actual test state value shall be derived from the actual operational state and procedural status according to the mapping table specified in ITU-T Recommendation X.745 [3].
284
+
285
+ Any state change shall be reported to the NM using the Notification IRP.
286
+
287
+ ## 5.4 Test Categories
288
+
289
+ Most tests can be classified into test categories. In ITU-T Recommendation X.737 [6] eight different test categories are defined.
290
+
291
+ In case a certain test does not fit in any of the test categories defined in ITU-T Recommendation X.737 [6] vendors shall define new vendor-specific-extended (VSE) test categories.
292
+
293
+ ### 5.4.1 Resource Self Test
294
+
295
+ Resource self tests are used to investigate the ability of a simple resource in the managed network (e.g. a hardware board) to perform its allotted function. For the specification of the resource to be tested a single MORT is required. No associated objects are necessary.
296
+
297
+ The resource self test may be intrusive or non-intrusive. In case of intrusive tests the MORT has to be placed in the appropriate state before the test may start. If this is not possible the test request is rejected.
298
+
299
+ ### 5.4.2 Connection Test
300
+
301
+ The connection test allows investigation of the ability of a communications path in the IP network to support a desired service or level of functionality. Both the MORT(s) and AOs are required in the connection test. The MORT(s) represent the communications path to be tested. Two AOs are defined that reference the resources at the ends of the communications path.
302
+
303
+ The following parameters should be returned:
304
+
305
+ - the time delay in the communications path [7];
306
+ - the time delay variation in the communications path [8];
307
+ - The packet loss ratio in the communications path [9].
308
+
309
+ In the ITU-T Recommendation X.737 [6], the definition of the above parameters is not given.
310
+
311
+ In the IP network, the definition of these parameters is given in the IETF RFC [7], [8], [9].
312
+
313
+ ### 5.4.3 Loopback Test
314
+
315
+ The Loopback test is used to verify that data may be sent and received over a communications path within a specified loopback time-out period with an acceptable error ratio. Both the MORT(s) and AOs are required in the loopback test. The MORTs represent the resources that are being tested by the loopback test. The AOs references the resources providing the loopback points.
316
+
317
+ The following parameters should be returned.
318
+
319
+ - the time delay in the communications path [10].
320
+ - the time delay variation in the communications path.
321
+ - the packet loss ratio detected in the tested communications path.
322
+
323
+ In ITU-T Recommendation X.737 [6] the definition of the above parameters is not given.
324
+
325
+ In the IP network the definition of time delay in the loopback test is given in the IETF RFC [10].
326
+
327
+ The definitions of time delay variation and loss ratio in the loopback test are similar to the definitions in the connection test in the IETF RFC [8], [9].
328
+
329
+ # Annex A (informative): Change history
330
+
331
+ | Change history | | | | | | | | | |
332
+ |----------------|-----------|-----------|----------|-----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|-----------|------------|--|
333
+ | Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Ca<br>t | Old | New | |
334
+ | Jun 2002 | SA_1<br>6 | SP-020328 | -- | -- | Submitted to TSG SA #16 for Information | -- | 1.0.<br>0 | | |
335
+ | Sep 2002 | SA_1<br>7 | SP-020456 | -- | -- | Submitted to TSG SA #17 for Approval | -- | 2.0.<br>0 | 5.0.0 | |
336
+ | Dec 2002 | -- | -- | -- | -- | Cosmetics | -- | 5.0.<br>0 | 5.0.1 | |
337
+ | Mar 2004 | SA_2<br>3 | SP-040105 | -- | -- | Automatic upgrade to Rel-6 (no CR) | -- | 5.0.<br>1 | 6.0.0 | |
338
+ | Sep 2006 | SA_3<br>3 | SP-060549 | 000<br>1 | -- | Add new test categories of network performance measurement | B | 6.0.<br>0 | 7.0.0 | |
339
+ | Mar 2007 | -- | -- | -- | -- | Delete reference to the 32.324 CMIP SS. Reason: SA#35 endorsed the SA5 decision to not propagate the CMIP Solution Sets to Rel-7 (TS 32.3x4, TS 32.4x4, TS 32.6x4) | -- | 7.0.<br>0 | 7.0.1 | |
340
+ | Dec 2007 | SA_3<br>8 | SP-070743 | 000<br>2 | -- | R8 CR 32.321-701 Add new output parameters (time delay, time delay variation and packet loss ratio in connection and loopback test categories) | B | 7.0.<br>1 | 8.0.0 | |
341
+ | Dec 2009 | - | - | - | - | Update to Rel-9 version (MCC) | - | 8.0.<br>0 | 9.0.0 | |
342
+ | Mar 2011 | - | - | - | - | Update to Rel-10 version (MCC) | - | 9.0.<br>0 | 10.0.<br>0 | |
marked/Rel-10/32_series/32322/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
marked/Rel-10/32_series/32326/raw.md ADDED
@@ -0,0 +1,1463 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+ # Keywords CORBA, XML, SOAP, management, architecture 3GPP TS 32.326 V10.1.0 (2010-12)
4
+
5
+ *Technical Specification*
6
+
7
+ **3GPP**
8
+ **3rd Generation Partnership Project;**
9
+ **Technical Specification Group Services and System Aspects;**
10
+ **Telecommunication management;**
11
+ **Test management Integration Reference Point (IRP):**
12
+ **Solution Set**
13
+
14
+ Postal address:
15
+ 3GPP support office address
16
+ 0556 Route des Lucioles - Sophia Antipolis
17
+ Valbonne - FRANCE
18
+ Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
19
+
20
+ ![LTE logo](64662465bba247703fdec49c8f3309f9_img.jpg)
21
+
22
+ LTE logo
23
+
24
+ Internet
25
+ <http://www.3gpp.org>
26
+
27
+ ![3GPP logo](390120de4fe440c42fea8154fcaad334_img.jpg)
28
+
29
+ 3GPP logo
30
+
31
+ The present document has been developed within the 3<sup>rd</sup> Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP..
32
+
33
+ The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented.
34
+
35
+ This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification.
36
+
37
+ Specifications and reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices.
38
+
39
+ # ***Copyright Notification***
40
+
41
+ No part may be reproduced except as authorized by written permission.
42
+ The copyright and the foregoing restriction extend to reproduction in all media.
43
+
44
+ © 2010, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TTA, TTC).
45
+ All rights reserved.
46
+
47
+ UMTSTM is a Trade Mark of ETSI registered for the benefit of its members
48
+
49
+ 3GPPTM is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
50
+
51
+ LTETM is a Trade Mark of ETSI currently being registered for the benefit of its Members and of the 3GPP Organizational Partners
52
+
53
+ GSM® and the GSM logo are registered and owned by the GSM Association
54
+
55
+ # Contents
56
+
57
+ | | |
58
+ |--------------------------------------------------------------------|-----------|
59
+ | Foreword ..... | 5 |
60
+ | Introduction ..... | 5 |
61
+ | 1 Scope..... | 6 |
62
+ | 2 References..... | 6 |
63
+ | 3 Definitions, symbols and abbreviations..... | 7 |
64
+ | 3.1 Definitions..... | 7 |
65
+ | 3.2 Abbreviations ..... | 7 |
66
+ | 4 Solution Set Definitions ..... | 8 |
67
+ | <b>Annex A (normative): CORBA Solution Set.....</b> | <b>9</b> |
68
+ | A.1 Architectural features..... | 9 |
69
+ | A.1.1 Syntax for Distinguished Names..... | 9 |
70
+ | A.1.2 Notification Services..... | 9 |
71
+ | A.1.3 Push and Pull Style..... | 9 |
72
+ | A.1.4 Support multiple notifications in one push operation ..... | 9 |
73
+ | A.1.5 TestManagementIRPNotification Interface ..... | 9 |
74
+ | A.1.5.1 Method push (M)..... | 10 |
75
+ | A.2 Mapping ..... | 11 |
76
+ | A.2.1 Operation and Notification mapping..... | 11 |
77
+ | A.2.2 Operation parameter mapping..... | 11 |
78
+ | A.2.3 Notification parameter mapping..... | 13 |
79
+ | A.3 Solution Set definitions..... | 14 |
80
+ | A.3.1 IDL definition structure..... | 14 |
81
+ | A.3.2 IDL specification "TestManagementIRPConstDefs.idl" ..... | 15 |
82
+ | A.3.3 IDL specification "TestManagementIRPSystem.idl" ..... | 17 |
83
+ | A.3.4 IDL specification "TestManagementIRPNotifications.idl" ..... | 19 |
84
+ | <b>Annex B (normative): XML Definitions.....</b> | <b>21</b> |
85
+ | B.1 Architectural Features ..... | 21 |
86
+ | B.1.1 Syntax for Distinguished Names..... | 21 |
87
+ | B.1.2 Notification Services..... | 21 |
88
+ | B.1.3 IOC Definitions..... | 21 |
89
+ | B.2 Mapping ..... | 21 |
90
+ | B.3 Solution Set definitions..... | 21 |
91
+ | B.3.1 XML definition structure ..... | 21 |
92
+ | B.3.2 Graphical Representation..... | 22 |
93
+ | B.3.3 XML Schema "tMIRPNotif.xsd"..... | 23 |
94
+ | <b>Annex C (normative): SOAP Solution Set.....</b> | <b>24</b> |
95
+ | C.1 Architectural features..... | 24 |
96
+ | C.1.1 Syntax for Distinguished Names..... | 24 |
97
+ | C.1.2 Notification Services..... | 24 |
98
+ | C.1.3 Supported W3C specifications..... | 24 |
99
+ | C.1.4 Prefixes and namespaces..... | 24 |
100
+ | C.2 Mapping ..... | 25 |
101
+ | C.2.1 Operation and notification mapping..... | 25 |
102
+ | C.2.2 Operation parameter mapping..... | 25 |
103
+ | C.2.3 Notification parameter mapping..... | 25 |
104
+ | C.3 Solution Set definitions..... | 26 |
105
+ | C.3.1 WSDL definition structure ..... | 26 |
106
+
107
+ | | | |
108
+ |------------------------|---------------------------------------------|----|
109
+ | C.3.2 | Graphical Representation ..... | 26 |
110
+ | C.3.3 | WSDL specification “TMIRPSystem.wsdl” ..... | 27 |
111
+ | Annex D (informative): | Change history..... | 32 |
112
+
113
+ # --- Foreword
114
+
115
+ This Technical Specification has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP).
116
+
117
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
118
+
119
+ Version x.y.z
120
+
121
+ where:
122
+
123
+ - x the first digit:
124
+ - 1 presented to TSG for information;
125
+ - 2 presented to TSG for approval;
126
+ - 3 or greater indicates TSG approved document under change control.
127
+ - y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
128
+ - z the third digit is incremented when editorial only changes have been incorporated in the document.
129
+
130
+ # --- Introduction
131
+
132
+ The present document is part of a TS-family covering the 3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; Test management Integration Reference Point (IRP), as identified below:
133
+
134
+ - 32.321: "Test management Integration Reference Point (IRP); Requirements"
135
+ - 32.322: "Test management Integration Reference Point (IRP): Information Service (IS)"
136
+ - 32.326: "Test management Integration Reference Point (IRP): Solution Set definitions (SS)"**
137
+
138
+ A 3G telecommunication network is composed of a multitude of different Network Elements (NE). For a successful operation of the network the operator must be provided with mechanisms allowing him to manage the network. These management activities can be grouped into several areas: configuration management, fault management, performance management, accounting management and security management.
139
+
140
+ A management function assisting in different high level management areas such as fault management and performance management is test management. The purpose of testing is to get information about the functionality and performance of the 3G managed network subject to the test.
141
+
142
+ The present document is part of a TS-family defining the Telecommunication Management (TM) of 3G systems. The TM principles are described in 3GPP TS 32.101 [2]. The TM architecture is described in 3GPP TS 32.102 [3]. The other specifications define the interface (Itf-N) between the managing system (manager), which is in general the Network Manager (NM) and the managed system (agent), which is either an Element Manager (EM) or the managed NE itself. The Itf-N is composed of a number of integration reference points (IRPs) defining the information in the agent that is visible for the manager, the operations that the manager may perform on this information and the notifications that are sent from the agent to the manager. One of these IRPs is the Test Management IRP.
143
+
144
+ Each IRP is specified by the requirements part, the IS part and SS part.
145
+
146
+ # --- 1 Scope
147
+
148
+ The present document contains the Solution Sets for the IRP whose semantics is specified in Test management IRP IS (3GPP TS 32.322 [5]).
149
+
150
+ This Solution Set specification is related to 3GPP TS 32.322 V10.0.X.
151
+
152
+ # --- 2 References
153
+
154
+ The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
155
+
156
+ - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
157
+ - For a specific reference, subsequent revisions do not apply.
158
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
159
+
160
+ - [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications".
161
+ - [2] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements".
162
+ - [3] 3GPP TS 32.102: "Telecommunication management; Architecture".
163
+ - [4] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions".
164
+ - [5] 3GPP TS 32.322: "Telecommunication management; Test management Integration Reference Point (IRP): Information Service (IS)".
165
+ - [6] 3GPP TS 32.300: "Telecommunication management; Configuration Management (CM); Name convention for Managed Objects".
166
+ - [7] W3C SOAP 1.1 specification (<http://www.w3.org/TR/2000/NOTE-SOAP-20000508/>)
167
+ - [8] W3C XPath 1.0 specification (<http://www.w3.org/TR/1999/REC-xpath-19991116>)
168
+ - [9] W3C WSDL 1.1 specification (<http://www.w3.org/TR/2001/NOTE-wsdl-20010315>)
169
+ - [10] W3C SOAP 1.2 specification (<http://www.w3.org/TR/soap12-part1/>)
170
+ - [11] 3GPP TS 32.306: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP): Solution Set (SS) definitions".
171
+ - [12] 3GPP TS 32.312: "Telecommunication management; Generic Integration Reference Point (IRP) management; Information Service (IS)".
172
+ - [13] 3GPP TS 32.336: "Telecommunication management; Notification Log (NL) Integration Reference Point (IRP): Solution Set (SS) definitions".
173
+ - [14] 3GPP TS 32.331: "Telecommunication management; Notification Log (NL) Integration Reference Point (IRP): Requirements".
174
+ - [15] Object Management Group 98 (November 1998): "*Notification Service: Joint Revised Submission OMG TC Document telecom/98-11-01*". <http://www.omg.org/technology/documents/>
175
+ - [16] G CORBA Services (November 1996): "Common Object Services Specification" (clause 4 contains the Event Service specification). <http://www.omg.org/technology/documents/>
176
+ - [17] 3GPP TS 32.311: "Telecommunication management; Generic Integration Reference Point (IRP) management; Requirements".
177
+
178
+ # --- 3 Definitions, symbols and abbreviations
179
+
180
+ ## 3.1 Definitions
181
+
182
+ For the purposes of the present document, the terms and definitions given in TR 21.905 [1], 3GPP TS 32.101 [2], 3GPP TS 32.102 [3], 3GPP TS 32.150 [4], 3GPP TS 32.331 [14] and 3GPP TS 32.322 [5] apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TR 21.905 [1].
183
+
184
+ **Test Category:** one or more tests sharing a common purpose and similar characteristics
185
+
186
+ **Tester Object (TO):** managed object that is instantiated for the purpose of monitoring and controlling a test invocation
187
+ Each test invocation has one associated TO. TOs are created and deleted by managed objects with TARR functionality.
188
+
189
+ ### **IRP document version number string:**
190
+
191
+ The IRP document version number (sometimes called "IRP version" or "version number") string is used to identify the present document. The definition of "IRP document version number string" in 3GPP TS 32.311 [17] provides the rule to derive such a string.
192
+
193
+ This string is returned in `get_test_management_IRP_versions` method and is carried in the first field of the notification header of all notifications related to Test Management IRP. This string is also returned in `get_notification_categories` method of the Notification IRP Agent, in case that IRP Agent is responsible for emitting notifications related to Test Management IRP.
194
+
195
+ ## 3.2 Abbreviations
196
+
197
+ For the purposes of the present document, the abbreviations given in TR 21.905 [1], in 3GPP TS 32.101 [2], 3GPP TS 32.102 [3], 3GPP TS 32.150 [4], and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1].
198
+
199
+ | | |
200
+ |-------|-------------------------------------------|
201
+ | CORBA | Common Object Request Broker Architecture |
202
+ | EM | Element Manager |
203
+ | GSM | Global System for Mobile communications |
204
+ | IDL | Interface Definition Language |
205
+ | IRP | Integration Reference Point |
206
+ | IOC | Information Object Class |
207
+ | IS | Information Service |
208
+ | NE | Network Element |
209
+ | NL | Notification Log |
210
+ | NM | Network Manager |
211
+ | OMG | Object Management Group |
212
+ | QoS | Quality of Service |
213
+ | SS | Solution Set |
214
+ | TARR | Test Action Request Receiver |
215
+ | TM | Test Management |
216
+ | TMIRP | Test Management IRP |
217
+ | TO | Tester Object |
218
+ | XML | eXtensible Markup Language |
219
+
220
+ # --- 4 Solution Set Definitions
221
+
222
+ This specification defines the following 3GPP Test management IRP Solution Set Definitions:
223
+
224
+ Annex A provides the CORBA Solution Set.
225
+
226
+ Annex B provides the XML Definitions.
227
+
228
+ Annex C provides the SOAP Solution Set.
229
+
230
+ # --- Annex A (normative): CORBA Solution Set
231
+
232
+ This annex contains the CORBA Solution Set for the IRP whose semantics is specified in Test management IRP: Information Service (TS 32.322 [5]).
233
+
234
+ ---
235
+
236
+ ## A.1 Architectural features
237
+
238
+ The overall architectural feature of Test Management IRP is specified in 3GPP TS 32.322 [5]. This clause specifies features that are specific to the CORBA SS.
239
+
240
+ ### A.1.1 Syntax for Distinguished Names
241
+
242
+ The syntax of a Distinguished Name is defined in 3GPP TS 32.300 [6].
243
+
244
+ ### A.1.2 Notification Services
245
+
246
+ In implementations of CORBA SS, IRPAgent conveys Test Management information to IRPManager via OMG Notification Service (OMG Notification Service [15]).
247
+
248
+ OMG Event Service [16] provides event routing and distribution capabilities. OMG Notification Service provides, in addition to Event Service, event filtering and Quality of Service (QoS) as well.
249
+
250
+ A necessary and sufficient sub set of OMG Notification Services shall be used to support `TestManagementIRPNotifications` notifications as specified in 3GPP TS 32.322 [5].
251
+
252
+ ### A.1.3 Push and Pull Style
253
+
254
+ OMG Notification Service defines two styles of interaction. One is called push style. In this style, IRPAgent pushes notifications to IRPManager as soon as they are available. The other is called pull style. In this style, IRPAgent keeps the notifications till IRPManager requests for them.
255
+
256
+ The Notification CORBA SS in 3GPP TS 32.306 [11] specifies that support of Push style is Mandatory (M) and that support of Pull style is Optional (O).
257
+
258
+ ### A.1.4 Support multiple notifications in one push operation
259
+
260
+ For efficiency reasons, IRPAgent may send multiple notifications using one single push operation. To pack multiple notifications into one push operation, IRPAgent may wait and not invoke the push operation as soon as notifications are available. To avoid IRPAgent to wait for an extended period of time that is objectionable to IRPManager, IRPAgent shall implement an IRPAgent wide timer configurable by administrator. On expiration of this timer, IRPAgent shall invoke push if there is at least one notification to be conveyed to IRPManager. This timer is re-started after each push invocation.
261
+
262
+ ### A.1.5 TestManagementIRPNotification Interface
263
+
264
+ OMG CORBA Notification push operation is used to realise the notification of `TestManagementIRPNotifications`. All the notifications in this interface are implemented using this `push_structured_event` method.
265
+
266
+ #### A.1.5.1 Method push (M)
267
+
268
+ ```
269
+ module CosNotifyComm {
270
+ ...
271
+ interface SequencePushConsumer : NotifyPublish {
272
+ void push_structured_events(
273
+ in CosNotification::EventBatch notifications)
274
+ raises( CosEventComm::Disconnected );
275
+ }
276
+ ...
277
+ }; // SequencePushConsumer
278
+ ```
279
+
280
+ ```
281
+ ); // CosNotifyComm
282
+ ```
283
+
284
+ NOTE 1: The `push_structured_events` method takes an input parameter of type `EventBatch` as defined in the OMG `CosNotification` module (OMG Notification Service [15]). This data type is the same as a sequence of Structured Events. Upon invocation, this parameter will contain a sequence of Structured Events being delivered to `IRPManager` by `IRPAgent` to which it is connected.
285
+
286
+ NOTE 2: The maximum number of events that will be transmitted within a single invocation of this operation is controlled by `IRPAgent` wide configuration parameter.
287
+
288
+ NOTE 3: The amount of time the supplier (`IRPAgent`) of a sequence of Structured Events will accumulate individual events into the sequence before invoking this operation is controlled by `IRPAgent` wide configuration parameter as well.
289
+
290
+ NOTE 4: IRP Agent may push EventBatch with only one Structured Event.
291
+
292
+ ## A.2 Mapping
293
+
294
+ ### A.2.1 Operation and Notification mapping
295
+
296
+ The Test Management IRP IS in 3GPP TS 32.322 [5] defines semantics of operation and notification visible across the Test Management IRP. Table A.2.1 indicates mapping of these operations and notifications to their equivalents defined in the present SS.
297
+
298
+ **Table A.2.1: Mapping from IS Operations and Notification to SS equivalents**
299
+
300
+ | IS Operations/ notification TS 32.322 [5] | SS Method | Qualifier |
301
+ |------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------|-----------|
302
+ | initiateTests | initiate tests | M |
303
+ | terminateTests | terminate tests | M |
304
+ | monitorTest | monitor test | M |
305
+ | getIRPVersion | get test management IRP versions | M |
306
+ | getOperationProfile (see note) | get test management IRP operation profile | O |
307
+ | getNotificationProfile (see note) | get test management IRP notification profile | O |
308
+ | notifyTestResult | push_structured_event (See subclause A.1.5) | M |
309
+ | NOTE: This operation is of ManagedGenericIRP IOC specified in 3GPP TS 32.312 [12].<br>The TestManagementIRP IOC of [5] inherits from it. | | |
310
+
311
+ ### A.2.2 Operation parameter mapping
312
+
313
+ The Test Management IRP IS in 3GPP TS 32.322 [5] defines semantics of parameters carried in operations across the Test Management IRP. The tables below show the mapping of these parameters, as per operation, to their equivalents defined in this SS.
314
+
315
+ **Table A.2.2.1: Mapping from IS `initiateTests` parameters to SS equivalents**
316
+
317
+ | IS Operation parameter | SS Method parameter | Qualifier |
318
+ |-------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|
319
+ | testInvocationInitiator | TestManagementIRPConstDefs::TestInvocationInitiator<br>test_invocation_initiator | M |
320
+ | toBeInitiatedTests | TestManagementIRPConstDefs::ToBeInitiatedTestSeq<br>to_be_initiated_test_seq | M |
321
+ | response | TestManagementIRPConstDefs::InitiateTestsResponse<br>Exceptions:<br>InitiateTests,<br>ManagedGenericIRPSystem::ParameterNotSupported,<br>ManagedGenericIRPSystem::InvalidParameter | M |
322
+
323
+ **Table A.2.2.2: Mapping from IS `terminateTests` parameters to SS equivalents**
324
+
325
+ | IS Operation parameter | SS Method parameter | Qualifier |
326
+ |------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|
327
+ | toBeTerminatedTests | TestManagementIRPConstDefs::ToBeTerminatedTestSeq<br>to be terminated test seq | M |
328
+ | response | TestManagementIRPConstDefs::TerminateTestsResponse<br>Exceptions:<br>TerminateTests,<br>ManagedGenericIRPSystem::OperationNotSupported,<br>ManagedGenericIRPSystem::ParameterNotSupported,<br>ManagedGenericIRPSystem::InvalidParameter | M |
329
+
330
+ **Table A.2.2.3: Mapping from IS monitorTest parameters to SS equivalents**
331
+
332
+ | IS Operation parameter | SS Method parameter | Qualifier |
333
+ |--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|
334
+ | toBeMonitoredTO | TestManagementIRPConstDefs::ToBeMonitoredTO<br>to be monitored TO | M |
335
+ | monitoredAttributeValues | TestManagementIRPConstDefs::TOAttributes tO_attributes | M |
336
+ | error | ManagedGenericIRPConstDefs::Signal<br>Exceptions:<br>MonitorTest,<br>ManagedGenericIRPSystem::OperationNotSupported,<br>ManagedGenericIRPSystem::ParameterNotSupported,<br>ManagedGenericIRPSystem::InvalidParameter | M |
337
+
338
+ ### A.2.3 Notification parameter mapping
339
+
340
+ The Test Management IRP IS in 3GPP TS 32.322 [5] defines semantics of parameters carried in notifications. The following table indicates the mapping of these parameters to their OMG CORBA Structured Event (defined in OMG Notification Service [15]) equivalents. The composition of OMG Structured Event, as defined in the OMG Notification Service [15], is:
341
+
342
+ ```
343
+ Header
344
+ Fixed Header
345
+ domain_name
346
+ type_name
347
+ event_name
348
+ Variable Header
349
+ Body
350
+ filterable_body_fields
351
+ remaining_body
352
+ ```
353
+
354
+ Table A.2.3 lists in the second column all OMG Structured Event attributes. The first column identifies notification
355
+
356
+ parameters defined in 3GPP TS 32.322 [5], Test Management: Information Service (IS).
357
+
358
+ **Table A.2.3: Mapping for notifyTestResult**
359
+
360
+ | IS Parameters | OMG CORBA Structured Event attribute | Qualifier | Comment |
361
+ |-----------------------------------------|---------------------------------------|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
362
+ | There is no corresponding IS parameter. | domain_name | M | It carries the IRP document version number string. See subclause 3.1.<br>It indicates the syntax and semantics of the Structured Event as defined by the present document. |
363
+ | notificationType | type_name | M | This is the NOTIFY_TM_TEST_RESULT of module of TestManagementIRPConstDefs. |
364
+ | There is no corresponding IS parameter. | event_name | M | It carries no information. |
365
+ | There is no corresponding IS parameter. | Variable Header | | |
366
+ | objectClass, objectInstance | One NV pair of filterable_body_fields | M | NV stands for name-value pair. Order arrangement of NV pairs is not significant. The name of NV-pair is always encoded in string.<br><br>Name of this NV pair is the MANAGED_OBJECT_INSTANCE of interface AttributeNameValue of module NotificationIRPConstDefs.<br><br>Value of NV pair is a string. See corresponding table in TS 32.306 [11] Notification IRP: Solution Set (SS) definitions. |
367
+ | notificationId | One NV pair of remaining_body | M | Name of NV pair is the NOTIFICATION_ID of interface AttributeNameValue of module NotificationIRPConstDefs.<br><br>Value of NV pair is a long. See corresponding table in TS 32.306 [11] Notification IRP: Solution Set (SS) definitions. |
368
+ | eventTime | One NV pair of filterable_body_fields | M | Name of NV pair is the EVENT_TIME of interface AttributeNameValue of module NotificationIRPConstDefs.<br><br>Value of NV pair is IRPTime. See corresponding table in TS 32.306 [11] Notification IRP: Solution Set (SS) definitions. |
369
+ | systemDN | One NV pair of filterable_body_fields | M | Name of NV pair is the SYSTEM_DN of interface AttributeNameValue of module NotificationIRPConstDefs.<br><br>Value of NV pair is a string. See corresponding table in TS 32.306 [11] Notification IRP: Solution Set (SS) definitions. |
370
+ | testInvocationInitiator | One NV pair of filterable_body_fields | M | Name of NV pair is the TEST_INVOCATION_INITIATOR of module TestManagementIRPConstDefs.<br><br>Value of NV pair is a string. |
371
+ | testOutcome | One NV pair of remaining_body | O | Name of NV pair is the TEST_OUTCOME of module TestManagementIRPConstDefs.<br><br>Value of NV pair is a enum {Inconclusive, Pass, Fail, TimeOut, PrematureTermination} |
372
+ | mORT | One NV pair of remaining_body | O | Name of NV pair is the MORT of module TestManagementIRPConstDefs.<br><br>Value of NV pair is a string. |
373
+ | proposedRepairActions | One NV pair of remaining_body | O | Name of NV pair is the PROPOSED_REPAIR_ACTIONS of module TestManagementIRPConstDefs.<br><br>Value of NV pair is a string. |
374
+ | additionalInformation | One NV pair of remaining_body | O | Name of NV pair is the ADDITIONAL_INFORMATION of module TestManagementIRPConstDefs.<br><br>Value of NV pair is a string. |
375
+ | fileReference | One NV pair of remaining_body | M (Note 1) | Name of NV pair is the FILE_REFERENCE of module TestManagementIRPConstDefs.<br><br>Value of NV pair is a string. |
376
+ | fileExpiryDate | One NV pair of remaining_body | M (Note 2) | Name of NV pair is the FILE_EXPIRY_DATE of module TestManagementIRPConstDefs.<br><br>Value of NV pair is a string. |
377
+
378
+ | IS Parameters | OMG CORBA Structured Event attribute | Qualifier | Comment |
379
+ |---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|---------|
380
+ | Note 1: | It shall contain no information or be absent if there is no test result captured in a file. | | |
381
+ | Note 2: | It shall contain information if the test results are captured in a file.<br>It shall contain no information or be absent if fileReference carries no information or absent.<br>Otherwise, it shall contain a valid future date and time. | | |
382
+
383
+ ## --- A.3 Solution Set definitions
384
+
385
+ ### A.3.1 IDL definition structure
386
+
387
+ Clause A.3.2 defines the constants and types used by the Test management IRP.
388
+
389
+ Clause A.3.3 defines the operations which are performed by the Test management IRP agent.
390
+
391
+ Clause A.3.4 defines the notifications which are emitted by the Test management IRP agent.
392
+
393
+ ### A.3.2 IDL specification "TestManagementIRPConstDefs.idl"
394
+
395
+ ```
396
+ // File: TestManagementIRPConstDefs.idl
397
+
398
+ #ifndef _TESTMANAGEMENTIRPCONSTDEFS_IDL_
399
+ #define _TESTMANAGEMENTIRPCONSTDEFS_IDL_
400
+
401
+ #include "CosNotification.idl"
402
+ #include "ManagedGenericIRPConstDefs.idl"
403
+
404
+ // This statement must appear after all include statements
405
+ #pragma prefix "3gppsa5.org"
406
+
407
+ /* ## Module: TestManagementIRPConstDefs
408
+ This module contains commonly used definitions for Test Management IRP
409
+ =====
410
+ */
411
+ module TestManagementIRPConstDefs
412
+ {
413
+ /*
414
+ This defines the notification type of this Test Management
415
+ IRP.
416
+ */
417
+ const string NOTIFY_TM_TEST_RESULT = "x1";
418
+
419
+ /*
420
+ This enum defines the test state
421
+ */
422
+ enum TestStateType {
423
+ NotInitialized,
424
+ Idle,
425
+ Initializing,
426
+ Testing,
427
+ Terminating,
428
+ Disabled
429
+ };
430
+
431
+ /*
432
+ This enum defines the test outcome
433
+ */
434
+ enum TestOutcomeType {
435
+ Inconclusive,
436
+ Pass,
437
+ Fail,
438
+ TimeOut,
439
+ PrematureTermination
440
+ };
441
+
442
+ /*
443
+ This block defines notification attributes of this IRP.
444
+ These attribute values should not clash with those used
445
+ in Notification header (see IDL of Notification IRP).
446
+ */
447
+ interface AttributeNameValue
448
+ {
449
+ const string TEST_INVOCATION_INITIATOR = "f";
450
+ const string TEST_INVOCATION_ID = "g";
451
+ const string TEST_ACTUAL_START_TIME = "h";
452
+ const string TEST_ACTUAL_STOP_TIME = "i";
453
+ const string TEST_OUTCOME = "j";
454
+ const string MORT = "k";
455
+ const string PROPOSED_REPAIR_ACTIONS = "l";
456
+ const string ADDITIONAL_INFORMATION = "m";
457
+ const string FILE_REFERENCE = "n";
458
+ const string FILE_EXPIRY_DATE = "o";
459
+ const string TEST_SOURCE_ADDRESS = "p";
460
+ const string TEST_DESTINATION_ADDRESS = "q";
461
+ const string TEST_LOOPBACK_ADDRESS = "r";
462
+ const string TEST_PACKET_INFORMATION = "s";
463
+ };
464
+
465
+ typedef string TestInvocationInitiator;
466
+ typedef string ToBeMonitoredTO;
467
+ ```
468
+
469
+ ```
470
+
471
+ typedef CosNotification::PropertySeq NVPairs;
472
+
473
+ /*
474
+ Define a seq of to-be-initiated-test
475
+ */
476
+ struct ToBeInitiatedTest
477
+ {
478
+ unsigned long max_testing_state_duration;//seconds;0->no limit
479
+ string toBeTestedMORT; //MORT DN
480
+ string tOClass; //Tester object class
481
+ string tODN; //Tester object DN
482
+ NVPairs tONVPair; //Tester object attributes in NV pairs
483
+ };
484
+
485
+ typedef sequence <ToBeInitiatedTest> ToBeInitiatedTestSeq;
486
+
487
+ /*
488
+ Define the structure returned by initiate_tests
489
+ */
490
+ struct InitiateTestsResponseElement
491
+ {
492
+ // If failureReason is NULL, the test is initiated successfully and
493
+ // testInvocationId contains the invocation id. In case the tester object name is not
494
+ // provided in the request, it shall be carried by testerObjectDN. In case the tester
495
+ // object name is provided in the request tODN shall be NULL.
496
+ // Else, the test initiation fails and failureReason contains
497
+ // the failure reason and testInvocationId contains garbage.
498
+ string failureReason;
499
+ string testInvocationId;
500
+ string tODN;
501
+ };
502
+
503
+ typedef sequence <InitiateTestsResponseElement> InitiateTestsResponse;
504
+
505
+ /*
506
+ Define a seq of to-be-terminated-test
507
+ */
508
+ typedef string TestInvocationId;
509
+ typedef sequence <TestInvocationId> ToBeTerminatedTestSeq;
510
+
511
+ /*
512
+ Define the structure returned by terminate_tests
513
+ */
514
+ struct TerminateTestsResponseElement
515
+ {
516
+ // If failureReason is NULL, the test has terminated successfully and
517
+ // testInvocationId identifies the terminated invocation.
518
+ // Else, the test termination fails and failureReason contains
519
+ // the failure reason and testInvocationId contains garbage.
520
+ string failureReason;
521
+ string testInvocationId;
522
+ };
523
+
524
+ typedef sequence <TerminateTestsResponseElement> TerminateTestsResponse;
525
+
526
+ /*
527
+ Define the structure of a TOAttributes.
528
+ */
529
+ struct TOAttributes
530
+ {
531
+ TestStateType testState;
532
+ TestOutcomeType testOutcome;
533
+ NVPairs attributesInNVPairs;
534
+ };
535
+
536
+ };
537
+
538
+ #endif // _TESTMANAGEMENTIRPCONSTDEFS_IDL_
539
+
540
+ ```
541
+
542
+ ### A.3.3 IDL specification "TestManagementIRPSystem.idl"
543
+
544
+ ```
545
+ // File: TestManagementIRPSystem.idl
546
+
547
+ #ifndef _TESTMANAGEMENTIRPSYSTEM_IDL_
548
+ #define _TESTMANAGEMENTIRPSYSTEM_IDL_
549
+
550
+ #include "TestManagementIRPConstDefs.idl"
551
+ #include "ManagedGenericIRPSystem.idl"
552
+
553
+ // This statement must appear after all include statements
554
+ #pragma prefix "3gppsa5.org"
555
+
556
+ /* ## Module: TestManagementIRPSystem
557
+ This module contains the specification of all methods of TestManagement IRP Agent.
558
+ =====
559
+ */
560
+ module TestManagementIRPSystem
561
+ {
562
+ /*
563
+ System may fail to complete an operation. System can provide reason
564
+ to qualify the failed reason. The semantics carried in reason
565
+ is outside the scope of this IRP.
566
+ */
567
+ exception GetTestManagementIRPVersions { string reason; };
568
+ exception GetTestManagementIRPOperationsProfile { string reason; };
569
+ exception GetTestManagementIRPNotificationProfile { string reason; };
570
+ exception InitiateTests { string reason; };
571
+ exception TerminateTests { string reason; };
572
+ exception MonitorTest { string reason; };
573
+
574
+ interface TestManagementIRP
575
+ {
576
+ /*
577
+ Return the list of all supported TestManagement IRP versions.
578
+ */
579
+ ManagedGenericIRPConstDefs::VersionNumberSet
580
+ get_Test_Management_IRP_versions (
581
+ )
582
+ raises (GetTestManagementIRPVersions);
583
+
584
+ /*
585
+ Return the list of all supported operations and their supported
586
+ parameters for a specific TestManagement IRP version.
587
+ */
588
+ ManagedGenericIRPConstDefs::MethodList
589
+ get_Test_Management_IRP_operations_profile (
590
+ in ManagedGenericIRPConstDefs::VersionNumber
591
+ test_management_irp_version
592
+ )
593
+ raises (GetTestManagementIRPOperationsProfile,
594
+ ManagedGenericIRPSystem::OperationNotSupported,
595
+ ManagedGenericIRPSystem::InvalidParameter);
596
+
597
+ /*
598
+ Return the list of all supported notifications and their supported
599
+ parameters for a specific TestManagement IRP version.
600
+ */
601
+ ManagedGenericIRPConstDefs::MethodList
602
+ get_Test_Management_IRP_notification_profile (
603
+ in ManagedGenericIRPConstDefs::VersionNumber
604
+ test_management_irp_version
605
+ )
606
+ raises (GetTestManagementIRPNotificationProfile,
607
+ ManagedGenericIRPSystem::OperationNotSupported,
608
+ ManagedGenericIRPSystem::InvalidParameter);
609
+ }
610
+ }
611
+ ```
612
+
613
+ ```
614
+
615
+ /*
616
+ Request to initiate tests.
617
+ */
618
+ TestManagementIRPConstDefs::InitiateTestsResponse
619
+ initiate_tests (
620
+ in TestManagementIRPConstDefs::TestInvocationInitiator
621
+ test_invocation_initiator,
622
+ in TestManagementIRPConstDefs::ToBeInitiatedTestSeq
623
+ to_be_initiated_test_seq
624
+ )
625
+ raises (InitiateTests,
626
+ ManagedGenericIRPSystem::InvalidParameter);
627
+
628
+ /*
629
+ Request to terminate tests.
630
+ */
631
+ TestManagementIRPConstDefs::TerminateTestsResponse
632
+ terminate_tests (
633
+ in TestManagementIRPConstDefs::ToBeTerminatedTestSeq
634
+ to_be_terminated_test_seq
635
+ )
636
+ raises (TerminateTests,
637
+ ManagedGenericIRPSystem::InvalidParameter);
638
+
639
+ /*
640
+ Request test info (to monitor a test).
641
+ */
642
+ ManagedGenericIRPConstDefs::Signal monitor_test (
643
+ in TestManagementIRPConstDefs::ToBeMonitoredTO
644
+ to_be_monitored_TO,
645
+ out TestManagementIRPConstDefs::TOAttributes toO_attributes
646
+ )
647
+ raises (MonitorTest,
648
+ ManagedGenericIRPSystem::InvalidParameter);
649
+
650
+ };
651
+
652
+ };
653
+
654
+ #endif // _TESTMANAGEMENTIRPSYSTEM_IDL_
655
+
656
+ ```
657
+
658
+ ### A.3.4 IDL specification "TestManagementIRPNotifications.idl"
659
+
660
+ ```
661
+ // File: TestManagementIRPNotifications.idl
662
+
663
+ #ifndef _TESTMANAGEMENTIRPNOTIFICATIONS_IDL
664
+ #define _TESTMANAGEMENTIRPNOTIFICATIONS_IDL
665
+
666
+ #include "TestManagementIRPConstDefs.idl"
667
+ #include "NotificationIRPConstDefs.idl"
668
+ #include "NotificationIRPNotifications.idl"
669
+
670
+ // This statement must appear after all include statements
671
+ #pragma prefix "3gppsa5.org"
672
+
673
+ /** Module: TestManagementIRPNotifications
674
+ This module contains the specification of all notifications of Test Management IRP Agent.
675
+ =====
676
+ */
677
+
678
+ module TestManagementIRPNotificationsfDefs
679
+ {
680
+ /**
681
+ * Constant definitions for the notifyTestResult notification
682
+ */
683
+ interface notifyTestResult: NotificationIRPNotifications::Notify
684
+ {
685
+ const string EVENT_TYPE = "notifyTestResult";
686
+
687
+ /**
688
+ * This constant defines the name of the period property,
689
+ * which is transported in the filterable_body fields.
690
+ * The data type for the value of this property
691
+ * is TestManagementIRPConstDefs:: TestInvocationInitiator.
692
+ */
693
+ const string TEST_INVOCATION_INITIATOR =
694
+ TestManagementIRPConstDefs::AttributeNameValue::TEST_INVOCATION_INITIATOR;
695
+
696
+ /**
697
+ * This constant defines the name of the
698
+ * TestInvocationId property,
699
+ * which is transported in the remaining body
700
+ * fields.
701
+ * The data type for the value of this property
702
+ * is TestManagementIRPConstDefs:: TestInvocationId.
703
+ */
704
+ const string TEST_INVOCATION_ID =
705
+ TestManagementIRPConstDefs::AttributeNameValue::TEST_INVOCATION_ID;
706
+
707
+ /**
708
+ * This constant defines the name of the
709
+ * TestActualStartTime property,
710
+ * which is transported in the remaining_body
711
+ * fields.
712
+ * The data type for the value of this property
713
+ * is TestManagementIRPConstDefs:: TestActualStartTime.
714
+ */
715
+ const string TEST_ACTUAL_START_TIME =
716
+ TestManagementIRPConstDefs::AttributeNameValue::TEST_ACTUAL_START_TIME;
717
+
718
+ /**
719
+ * This constant defines the name of the
720
+ * TestActualStopTime property,
721
+ * which is transported in the remaining_body
722
+ * fields.
723
+ * The data type for the value of this property
724
+ * is TestManagementIRPConstDefs:: TestActualStopTime.
725
+ */
726
+ const string TEST_ACTUAL_STOP_TIME =
727
+ TestManagementIRPConstDefs::AttributeNameValue::TEST_ACTUAL_STOP_TIME;
728
+
729
+ /**
730
+ * This constant defines the name of the
731
+ * testOutcome property,
732
+ * which is transported in the remaining_body
733
+ * fields.
734
+ * The data type for the value of this property
735
+ */
736
+ }
737
+ }
738
+ ```
739
+
740
+ ```
741
+
742
+ * is TestManagementIRPConstDefs:: testOutcome.
743
+ */
744
+ const string TEST_OUTCOME = TestManagementIRPConstDefs::AttributeNameValue::TEST_OUTCOME;
745
+
746
+ /*
747
+ * This constant defines the name of the
748
+ * MORT property,
749
+ * which is transported in the remaining_body
750
+ * fields.
751
+ * The data type for the value of this property
752
+ * is TestManagementIRPConstDefs::MORT.
753
+ */
754
+ const string MORT = TestManagementIRPConstDefs::AttributeNameValue::MORT;
755
+
756
+ /*
757
+ * This constant defines the name of the
758
+ * ProposedRepairActions property,
759
+ * which is transported in the remaining_body
760
+ * fields.
761
+ * The data type for the value of this property
762
+ * is TestManagementIRPConstDefs::ProposedRepairActions.
763
+ */
764
+ const string PROPOSED_REPAIR_ACTIONS =
765
+ TestManagementIRPConstDefs::AttributeNameValue::PROPOSED_REPAIR_ACTIONS;
766
+
767
+ /*
768
+ * This constant defines the name of the
769
+ * AdditionalInformation property,
770
+ * which is transported in the remaining_body
771
+ * fields.
772
+ * The data type for the value of this property
773
+ * is TestManagementIRPConstDefs:: AdditionalInformation.
774
+ */
775
+ const string ADDITIONAL_INFORMATION =
776
+ TestManagementIRPConstDefs::AttributeNameValue::ADDITIONAL_INFORMATION;
777
+
778
+ /*
779
+ * This constant defines the name of the
780
+ * FileReference property,
781
+ * which is transported in the remaining_body
782
+ * fields.
783
+ * The data type for the value of this property
784
+ * is TestManagementIRPConstDefs:: FdditionalInformation.
785
+ */
786
+ const string FILE_REFERENCE = TestManagementIRPConstDefs::AttributeNameValue::FILE_REFERENCE;
787
+
788
+ /*
789
+ * This constant defines the name of the
790
+ * FileExpiryDate property,
791
+ * which is transported in the remaining_body
792
+ * fields.
793
+ * The data type for the value of this property
794
+ * is TestManagementIRPConstDefs:: FileExpiryDate.
795
+ */
796
+ const string FILE_EXPIRY_DATE =
797
+ TestManagementIRPConstDefs::AttributeNameValue::FILE_EXPIRY_DATE;
798
+
799
+ };
800
+
801
+ };
802
+
803
+ #endif // _TESTMANAGEMENTIRPNOTIFICATIONS_IDL_
804
+
805
+ ```
806
+
807
+ # --- Annex B (normative): XML Definitions
808
+
809
+ This annex contains the XML Definitions for the Test management Integration Reference Point (Test management IRP) as it applies to Itf-N, in accordance with Test management IRP IS definitions [5] as well as Notification Log IRP XML Definitions [13].
810
+
811
+ Apart from being used for the Notification Log, the XML definitions for Test management IRP notifications are also used by the Test management IRP SOAP SS.
812
+
813
+ ## --- B.1 Architectural Features
814
+
815
+ The overall architectural feature of Test management IRP is specified in 3G TS 32.322 [5]. This clause specifies features that are specific to the XML definitions.
816
+
817
+ ### B.1.1 Syntax for Distinguished Names
818
+
819
+ The syntax of a Distinguished Name is defined in 3GPP TS 32.300 [6].
820
+
821
+ ### B.1.2 Notification Services
822
+
823
+ This annex defines the XML syntax of Test management IRP notifications that is to be used for the Test management IRP SOAP Solution Set and in conjunction with Notification Log IRP XML Definitions for Notification Log IRP XML Data File and the NL IRP XML Notification Format [13].
824
+
825
+ ### B.1.3 IOC Definitions
826
+
827
+ This annex defines the XML syntax for the IOC definitions of the Test management IRP IS [5], which are used by the XML definitions for the Test management IRP notifications and the Test management IRP IS operations.
828
+
829
+ ## --- B.2 Mapping
830
+
831
+ Not present in the current version of this specification.
832
+
833
+ ## --- B.3 Solution Set definitions
834
+
835
+ ### B.3.1 XML definition structure
836
+
837
+ Clause B.3.2 provides a graphical representation of the XML elements.
838
+
839
+ Clause B.3.3 provides XML definitions of Test management IRP notifications as defined in [5]. These definitions are to be used for the Test management IRP SOAP Solution Set and in conjunction with Notification Log IRP XML Definitions for Notification Log IRP XML Data File and the NL IRP XML Notification Format [13], as well as considerations for NL IRP XML File Name Conventions defined therein.
840
+
841
+ ### B.3.2 Graphical Representation
842
+
843
+ ![Diagram of the NotifyTestResults XML schema structure showing header and body components.](365b54f616aff249b4e6c0edafdcb9b3_img.jpg)
844
+
845
+ The diagram shows the structure of the **NotifyTestResults** message. The root element **NotifyTestResults** branches into a sequence containing:
846
+
847
+ - xe:header** [+]
848
+ - xt:body**
849
+ - A sequence containing:
850
+ - xt:TestInvocationId** (optional/dashed)
851
+ - xt:TestInvocationInitiator** (optional/dashed)
852
+ - xt:TestOutcome** (optional/dashed)
853
+ - xt:MORT**
854
+ - xt:ProposedRepairActions** [+] (optional/dashed)
855
+ - xt:AdditionalInformation** [+] (optional/dashed)
856
+ - xt:FileReference**
857
+ - xt:fileExpiryDate**
858
+
859
+ Diagram of the NotifyTestResults XML schema structure showing header and body components.
860
+
861
+ **Figure B.3.2**
862
+
863
+ NOTE: The use of XML schema key word "sequence" to support IS-defined set (not sequence) is for the purpose of XML processor efficiency. This shall not imply the use of "sequence" in other technology.
864
+
865
+ ### B.3.3 XML Schema “tMIRPNotif.xsd”
866
+
867
+ ```
868
+ <?xml version="1.0" encoding="UTF-8"?>
869
+ <!--
870
+ 3GPP TS 32.326 TMIRP Notification XML Schema
871
+ tMIRPNotif.xsd
872
+ -->
873
+ <schema xmlns:xt="http://www.3gpp.org/ftp/specs/archive/32_series/32.326#tMIRPNotif"
874
+ xmlns:xe="http://www.3gpp.org/ftp/specs/archive/32_series/32.306#notification"
875
+ xmlns="http://www.w3.org/2001/XMLSchema"
876
+ targetNamespace="http://www.3gpp.org/ftp/specs/archive/32_series/32.326#tMIRPNotif"
877
+ elementFormDefault="qualified" attributeFormDefault="unqualified">
878
+ <import namespace="http://www.3gpp.org/ftp/specs/archive/32_series/32.306#notification" />
879
+ <simpleType name="TestInvocationId">
880
+ <restriction base="string"/>
881
+ </simpleType>
882
+ <simpleType name="TestOutcome">
883
+ <restriction base="string">
884
+ <enumeration value="pass"/>
885
+ <enumeration value="fail"/>
886
+ <enumeration value="inconclusive"/>
887
+ <enumeration value="timed-out"/>
888
+ <enumeration value="premature-termination"/>
889
+ </restriction>
890
+ </simpleType>
891
+ <complexType name="NotifyTestResults">
892
+ <complexContent>
893
+ <extension base="xe:Notification">
894
+ <sequence>
895
+ <element name="body">
896
+ <complexType>
897
+ <sequence>
898
+ <element name="fileReference" type="string"/>
899
+ <element name="fileExpiryDate" type="dateTime"/>
900
+ <element name="testInvocationId" type="xt:TestInvocationId"
901
+ minOccurs="0"/>
902
+ <element name="testInvocationInitiator" type="string"
903
+ minOccurs="0"/>
904
+ <element name="testOutcome" type="xt:TestOutcome" minOccurs="0"/>
905
+ <element name="mORT" type="string" minOccurs="0"/>
906
+ <element name="proposedRepairActions" type="anyType" minOccurs="0"/>
907
+ <element name="additionalInformation" type="anyType" minOccurs="0"/>
908
+ </sequence>
909
+ </complexType>
910
+ </element>
911
+ </sequence>
912
+ </extension>
913
+ </complexContent>
914
+ </complexType>
915
+ <element name="NotifyTestResults" type="xt:NotifyTestResults"/>
916
+ </schema>
917
+ ```
918
+
919
+ # --- Annex C (normative): SOAP Solution Set
920
+
921
+ This annex specifies the SOAP Solution Set for the IRP whose semantics are specified in Test management IRP: Information Service (3GPP TS 32.322 [5]).
922
+
923
+ ---
924
+
925
+ ## C.1 Architectural features
926
+
927
+ The overall architectural feature of the Test management IRP is specified in 3GPP TS 32.322 [5]. This clause specifies features that are specific to the SOAP Solution Set.
928
+
929
+ ### C.1.1 Syntax for Distinguished Names
930
+
931
+ The syntax of a Distinguished Name is defined in 3GPP TS 32.300 [6].
932
+
933
+ ### C.1.2 Notification Services
934
+
935
+ The Test management IRP SOAP SS uses the Notification IRP SOAP SS of 3GPP TS 32.306 [11]. The IRP Agent shall support the push interface model, which means that the IRP Agent sends notifications to the IRP Manager as soon as new events occur. The IRP Manager does not need to check ("pull") for events.
936
+
937
+ Relevant definitions are imported from the Test management IRP XML definitions in Annex B.
938
+
939
+ ### C.1.3 Supported W3C specifications
940
+
941
+ The SOAP 1.1 specification [7] and WSDL 1.1 specification [9] are supported.
942
+
943
+ The SOAP 1.2 specification [10] is supported optionally.
944
+
945
+ This specification uses "document" style in WSDL file.
946
+
947
+ This specification uses "literal" encoding style in WSDL file.
948
+
949
+ The filter language used in the SS is the XPath Language (see W3C XPath 1.0 specification [8]). IRP Agents may throw a FilterComplexityLimit fault when a given filter is too complex.
950
+
951
+ ### C.1.4 Prefixes and namespaces
952
+
953
+ This specification uses a number of namespace prefixes throughout that are listed in Table C.1.4.
954
+
955
+ **Table C.1.4: Prefixes and Namespaces used in this specification**
956
+
957
+ | PREFIX | NAMESPACE |
958
+ |------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
959
+ | (no prefix) | <a href="http://schemas.xmlsoap.org/wsdl/">http://schemas.xmlsoap.org/wsdl/</a> |
960
+ | soap | <a href="http://schemas.xmlsoap.org/wsdl/soap/">http://schemas.xmlsoap.org/wsdl/soap/</a> |
961
+ | tmIRPSystem | <a href="http://www.3gpp.org/ftp/specs/archive/32_series/32.326#TMIRPSystem">http://www.3gpp.org/ftp/specs/archive/32_series/32.326#TMIRPSystem</a> |
962
+ | tmIRPData | <a href="http://www.3gpp.org/ftp/specs/archive/32_series/32.326#TMIRPData">http://www.3gpp.org/ftp/specs/archive/32_series/32.326#TMIRPData</a> |
963
+ | genericNrm | <a href="http://www.3gpp.org/ftp/specs/archive/32_series/32.626#genericNrm">http://www.3gpp.org/ftp/specs/archive/32_series/32.626#genericNrm</a> |
964
+ | genericIRPSystem | <a href="http://www.3gpp.org/ftp/specs/archive/32_series/32.316#GenericIRPSystem">http://www.3gpp.org/ftp/specs/archive/32_series/32.316#GenericIRPSystem</a> |
965
+ | ntfIRPNtfSystem | <a href="http://www.3gpp.org/ftp/specs/archive/32_series/32.306#NotificationIRPNtfSystem">http://www.3gpp.org/ftp/specs/archive/32_series/32.306#NotificationIRPNtfSystem</a> |
966
+
967
+ ## C.2 Mapping
968
+
969
+ ### C.2.1 Operation and notification mapping
970
+
971
+ The Test management IRP IS (3GPP TS 32.322 [5]) defines semantics of operation and notification visible across the Itf-N. Table C.2.1 indicates mapping of these operations and notifications to their equivalents defined in this SS.
972
+
973
+ **Table C.2.1: Mapping from IS Operation to SS Equivalents**
974
+
975
+ | IS Operations in 3GPP TS 32.322 [5] | SS Operations | SS Port | Qualifier |
976
+ |-------------------------------------|-----------------|----------------------------|-----------|
977
+ | initiateTests | initiateTests | TMIRPControlOperationsPort | M |
978
+ | terminateTests | terminateTests | TMIRPControlOperationsPort | M |
979
+ | monitorTest | monitorTest | TMIRPMonitorOperationsPort | M |
980
+ | notifyFilePreparationError | notify (note 1) | NotificationIRPNtfPort | M |
981
+
982
+ NOTE 1: The IS equivalent maps to an XML definition specified in Annex B, and this being an input parameter to the operation notify under the port type ntfIRPNtfSystem:NotificationIRPNtf and under the binding ntfIRPNtfSystem:NotificationIRPNtf of 3GPP TS 32.306 [11].
983
+
984
+ ### C.2.2 Operation parameter mapping
985
+
986
+ The Test management IRP IS (3GPP TS 32.322 [5]) defines semantics of parameters carried in the operations. The tables below show the mapping of these parameters, as per operation, to their equivalents defined in this SS.
987
+
988
+ **Table C.2.2.1: Mapping from IS `initiateTests` parameters to SS equivalents**
989
+
990
+ | IS Operation parameter | SS Method parameter | Qualifier |
991
+ |-------------------------|-------------------------|-----------|
992
+ | testInvocationInitiator | testInvocationInitiator | M |
993
+ | toBeInitiatedTests | toBeInitiatedTests | M |
994
+ | response | response | M |
995
+
996
+ **Table C.2.2.2: Mapping from IS `terminateTests` parameters to SS equivalents**
997
+
998
+ | IS Operation parameter | SS Method parameter | Qualifier |
999
+ |------------------------|---------------------|-----------|
1000
+ | toBeTerminatedTests | toBeTerminatedTests | M |
1001
+ | response | response | M |
1002
+
1003
+ **Table C.2.2.3: Mapping from IS `monitorTest` parameters to SS equivalents**
1004
+
1005
+ | IS Operation parameter | SS Method parameter | Qualifier |
1006
+ |--------------------------|--------------------------|-----------|
1007
+ | toBeMonitoredTO | toBeMonitoredTO | M |
1008
+ | monitoredAttributeValues | monitoredAttributeValues | M |
1009
+ | error | error | M |
1010
+
1011
+ ### C.2.3 Notification parameter mapping
1012
+
1013
+ The Test management IRP Notifications are defined in Annex B.
1014
+
1015
+ ## C.3 Solution Set definitions
1016
+
1017
+ ### C.3.1 WSDL definition structure
1018
+
1019
+ Clause C.3.2 provides a graphical representation of the Test management IRP service.
1020
+
1021
+ Clause C.3.3 defines the services which are supported the Test management IRP agent.
1022
+
1023
+ ### C.3.2 Graphical Representation
1024
+
1025
+ The WSDL structure is depicted in Figure C.3.2 below, depicting port type, binding and service. The port type contains port type operations, which again contains input, output and fault messages. The binding contains binding operations, which have the same name as the port type operations. The binding connects to a port inside the service.
1026
+
1027
+ ![WSDL structure diagram showing Port Types, Bindings, and Services for the Test management IRP SOAP Solution Set.](705ee99c3c44fd2a1ea6a3348ce8878f_img.jpg)
1028
+
1029
+ The diagram illustrates the WSDL structure for the Test management IRP SOAP Solution Set, organized into three columns: Port Types, Bindings, and Services.
1030
+
1031
+ - Port Types:**
1032
+ - GenericIRPPortType:** Operations include getIRPVersion, getOperationProfile, and getNotificationProfile.
1033
+ - NotificationIRPNTf:** Operation include notify.
1034
+ - TMIRPControlOperations:** Operations include initiateTests and terminateTests.
1035
+ - TMIRPMonitorOperations:** Operation include monitorTest.
1036
+ - Bindings:**
1037
+ - GenericIRPBinding:** Transport: http://schemas.xmlsoap.org/soap/http. Operations: getIRPVersion, getOperationProfile, getNotificationProfile.
1038
+ - NotificationIRPNTf:** Transport: http://schemas.xmlsoap.org/soap/http. Operation: notify.
1039
+ - TMIRPControlOperations:** Transport: http://schemas.xmlsoap.org/soap/http. Operations: initiateTests, terminateTests.
1040
+ - TMIRPMonitorOperations:** Transport: http://schemas.xmlsoap.org/soap/http. Operation: monitorTest.
1041
+ - Services:**
1042
+ - NotificationIRPNTf:** Location: To be defined.
1043
+ - TMIRPService:** Contains four ports:
1044
+ - GenericIRPPort:** Location: http://www.3gpp.org/ftp/specs/archive/32\_series/32.316#GenericIRP
1045
+ - NotificationIRPNTfPort:** Location: http://www.3gpp.org/ftp/specs/archive/32\_series/32.306#NotificationIRPNTf
1046
+ - TMIRPControlOperationsPort:** Location: http://www.3gpp.org/ftp/specs/archive/32\_series/32.326#TMIRPControl
1047
+ - TMIRPMonitorOperationsPort:** Location: http://www.3gpp.org/ftp/specs/archive/32\_series/32.326#TMIRPMonitor
1048
+
1049
+ WSDL structure diagram showing Port Types, Bindings, and Services for the Test management IRP SOAP Solution Set.
1050
+
1051
+ Figure C.3.2: Test management IRP SOAP Solution Set WSDL structure
1052
+
1053
+
1054
+
1055
+ ### C.3.3 WSDL specification “TMIRPSystem.wsdl”
1056
+
1057
+ ```
1058
+
1059
+ <?xml version="1.0" encoding="UTF-8"?>
1060
+ <!--
1061
+ 3GPP TS 32.326 Test Management IRP SOAP Solution Set
1062
+ -->
1063
+ <definitions
1064
+ xmlns="http://schemas.xmlsoap.org/wsdl/"
1065
+ xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
1066
+ xmlns:tMIRPSystem="http://www.3gpp.org/ftp/specs/archive/32_series/32.326#TMIRPSystem"
1067
+ xmlns:tMIRPData="http://www.3gpp.org/ftp/specs/archive/32_series/32.326#TMIRPData"
1068
+ xmlns:genericNrm="http://www.3gpp.org/ftp/specs/archive/32_series/32.626#genericNrm"
1069
+ xmlns:genericIRPSystem="http://www.3gpp.org/ftp/specs/archive/32_series/32.316#GenericIRPSystem"
1070
+ xmlns:ntfIRPNtfSystem="http://www.3gpp.org/ftp/specs/archive/32_series/32.306#NotificationIRPNtfSystem"
1071
+ targetNamespace="http://www.3gpp.org/ftp/specs/archive/32_series/32.326#TMIRPSystem">
1072
+ <import namespace="http://www.3gpp.org/ftp/specs/archive/32_series/32.316#GenericIRPSystem"/>
1073
+ <import
1074
+ namespace="http://www.3gpp.org/ftp/specs/archive/32_series/32.306#NotificationIRPNtfSystem"/>
1075
+ <types>
1076
+ <schema targetNamespace="http://www.3gpp.org/ftp/specs/archive/32_series/32.326#TMIRPData"
1077
+ xmlns="http://www.w3.org/2001/XMLSchema">
1078
+ <import namespace="http://www.3gpp.org/ftp/specs/archive/32_series/32.626#genericNrm"/>
1079
+ <!-- attributeNameValue Type -->
1080
+ <complexType name="attributeNameValueType">
1081
+ <sequence>
1082
+ <element name="attributeName" type="string"/>
1083
+ <element name="attributeValue" type="string"/>
1084
+ </sequence>
1085
+ </complexType>
1086
+ <!-- operationResult Type -->
1087
+ <simpleType name="operationResultType">
1088
+ <restriction base="string">
1089
+ <enumeration value="operationFailedEntirely"/>
1090
+ <enumeration value="operationFailedPartly"/>
1091
+ <enumeration value="operationSucceeded"/>
1092
+ </restriction>
1093
+ </simpleType>
1094
+ <!-- initiateTests Request -->
1095
+ <element name="initiateTestsRequest">
1096
+ <complexType>
1097
+ <sequence>
1098
+ <element name="testInvocationInitiator" type="genericNrm:dn"/>
1099
+ <element name="toBeInitiatedTests">
1100
+ <complexType>
1101
+ <sequence maxOccurs="unbounded">
1102
+ <choice minOccurs="0">
1103
+ <element name="maxTestingStateDuration" type="duration"/>
1104
+ <element name="noLimitTestingStateDuration"/>
1105
+ </choice>
1106
+ <element name="toBeTestedMORT" type="genericNrm:dn" minOccurs="0"/>
1107
+ <element name="testerObjectClass" type="genericNrm:dn"/>
1108
+ <element name="testerObjectName" type="string" minOccurs="0"/>
1109
+ <element name="testerObjectInitialAttributeList" minOccurs="0">
1110
+ <complexType>
1111
+ <sequence maxOccurs="unbounded">
1112
+ <element name="initialAttribute"
1113
+ type="tMIRPData:attributeNameValueType"/>
1114
+ </sequence>
1115
+ </complexType>
1116
+ </element>
1117
+ </sequence>
1118
+ </complexType>
1119
+ </element>
1120
+ </sequence>
1121
+ </complexType>
1122
+ </element>
1123
+ <!-- initiateTests Response -->
1124
+ <element name="initiateTestsResponse">
1125
+ <complexType>
1126
+ <sequence>
1127
+ <element name="initiateTestsResult" type="tMIRPData:operationResultType"/>
1128
+ <element name="response">
1129
+ <complexType>
1130
+ <sequence maxOccurs="unbounded">
1131
+ <choice>
1132
+ <element name="testInitiated">
1133
+
1134
+ ```
1135
+
1136
+ ```
1137
+
1138
+ <complexType>
1139
+ <sequence>
1140
+ <element name="testInvocationId" type="string"/>
1141
+ <element name="testerObjectName" type="string"
1142
+ minOccurs="0"/>
1143
+ </sequence>
1144
+ </complexType>
1145
+ </element>
1146
+ <element name="testNotInitiated">
1147
+ <complexType>
1148
+ <sequence>
1149
+ <element name="failureReason">
1150
+ <simpleType>
1151
+ <restriction base="string">
1152
+ <enumeration value="TOClassNotExisting"/>
1153
+ <enumeration value="MORTNotExisting"/>
1154
+ <enumeration value="MORTNotAvailable"/>
1155
+ <enumeration
1156
+ value="operation_failed_invalid_input_parameter"/>
1157
+ <enumeration
1158
+ value="operation_failed_unsupported_optional_input_parameter_maxTestingStateDuration"/>
1159
+ <enumeration
1160
+ value="operation_failed_unsupported_optional_input_parameter_noLimitTestingStateDuration"/>
1161
+ <enumeration
1162
+ value="operation_failed_unsupported_optional_input_parameter_toBeTestedMORT"/>
1163
+ <enumeration
1164
+ value="operation failed unsupported optional input parameter_testerObjectName"/>
1165
+ <enumeration
1166
+ value="operation_failed_unsupported_optional_input_parameter_testerObjectInitialAttributeList"/>
1167
+ <enumeration
1168
+ value="operation failed internal problem"/>
1169
+ </restriction>
1170
+ </simpleType>
1171
+ </element>
1172
+ </sequence>
1173
+ </complexType>
1174
+ </element>
1175
+ </choice>
1176
+ </sequence>
1177
+ </complexType>
1178
+ </element>
1179
+ </sequence>
1180
+ </complexType>
1181
+ </element>
1182
+ <!-- initiateTests Fault -->
1183
+ <element name="initiateTestsFault">
1184
+ <simpleType>
1185
+ <restriction base="string">
1186
+ <enumeration value="OperationFailed"/>
1187
+ </restriction>
1188
+ </simpleType>
1189
+ </element>
1190
+ <!-- terminateTests Request -->
1191
+ <element name="terminateTestsRequest">
1192
+ <complexType>
1193
+ <sequence maxOccurs="unbounded">
1194
+ <element name="testInvocationId" type="string"/>
1195
+ </sequence>
1196
+ </complexType>
1197
+ </element>
1198
+ <!-- terminateTests Response -->
1199
+ <element name="terminateTestsResponse">
1200
+ <complexType>
1201
+ <sequence>
1202
+ <element name="terminateTestsResult" type="tmIRPData:operationResultType"/>
1203
+ <element name="response">
1204
+ <complexType>
1205
+ <sequence maxOccurs="unbounded">
1206
+ <choice>
1207
+ <element name="testTerminated">
1208
+ <complexType>
1209
+ <sequence>
1210
+ <element name="testInvocationId" type="string"/>
1211
+ </sequence>
1212
+ </complexType>
1213
+ </element>
1214
+ <element name="testNotTerminated">
1215
+ <complexType>
1216
+
1217
+ ```
1218
+
1219
+ ```
1220
+
1221
+ <sequence>
1222
+ <element name="testInvocationId" type="string"/>
1223
+ <element name="failureReason">
1224
+ <simpleType>
1225
+ <restriction base="string">
1226
+ <enumeration value="testInvocationIdNotExisting"/>
1227
+ <enumeration
1228
+ value="operation_failed_invalid_input_parameter"/>
1229
+ <enumeration
1230
+ value="operation_failed_internal_problem"/>
1231
+ </restriction>
1232
+ </simpleType>
1233
+ </element>
1234
+ </sequence>
1235
+ </complexType>
1236
+ </element>
1237
+ </choice>
1238
+ </sequence>
1239
+ </complexType>
1240
+ </element>
1241
+ </sequence>
1242
+ </complexType>
1243
+ </element>
1244
+ </sequence>
1245
+ </complexType>
1246
+ </element>
1247
+ <!-- terminateTests Fault -->
1248
+ <element name="terminateTestsFault">
1249
+ <simpleType>
1250
+ <restriction base="string">
1251
+ <enumeration value="OperationFailed"/>
1252
+ </restriction>
1253
+ </simpleType>
1254
+ </element>
1255
+ <!-- monitorTest Request -->
1256
+ <element name="monitorTestRequest">
1257
+ <complexType>
1258
+ <sequence>
1259
+ <element name="toBeMonitoredTO" type="genericNrm:dn"/>
1260
+ </sequence>
1261
+ </complexType>
1262
+ </element>
1263
+ <!-- monitorTest Response -->
1264
+ <element name="monitorTestResponse">
1265
+ <complexType>
1266
+ <sequence>
1267
+ <element name="monitorTestResult" type="tmIRPData:operationResultType"/>
1268
+ <element name="monitoredAttributeValues" minOccurs="0">
1269
+ <complexType>
1270
+ <sequence>
1271
+ <element name="testState">
1272
+ <simpleType>
1273
+ <restriction base="string">
1274
+ <enumeration value="notInitialized"/>
1275
+ <enumeration value="idle"/>
1276
+ <enumeration value="initializing"/>
1277
+ <enumeration value="testing"/>
1278
+ <enumeration value="terminating"/>
1279
+ <enumeration value="disabled"/>
1280
+ </restriction>
1281
+ </simpleType>
1282
+ </element>
1283
+ <element name="testOutcome">
1284
+ <simpleType>
1285
+ <restriction base="string">
1286
+ <enumeration value="pass"/>
1287
+ <enumeration value="fail"/>
1288
+ <enumeration value="inconclusive"/>
1289
+ <enumeration value="timed-out"/>
1290
+ <enumeration value="premature-termination"/>
1291
+ </restriction>
1292
+ </simpleType>
1293
+ </element>
1294
+ <sequence minOccurs="0" maxOccurs="unbounded">
1295
+ <element name="otherAttribute"
1296
+ type="tmIRPData:attributeNameValueType"/>
1297
+ </sequence>
1298
+ </sequence>
1299
+ </complexType>
1300
+ </element>
1301
+ <element name="error">
1302
+
1303
+ ```
1304
+
1305
+ ```
1306
+
1307
+ <complexType>
1308
+ <sequence>
1309
+ <element name="failureReason">
1310
+ <simpleType>
1311
+ <restriction base="string">
1312
+ <enumeration value="TOInstanceNotExisting"/>
1313
+ <enumeration value="errorReadingAttribute"/>
1314
+ <enumeration value="operation_failed_invalid_input_parameter"/>
1315
+ <enumeration value="operation_failed_internal_problem"/>
1316
+ </restriction>
1317
+ </simpleType>
1318
+ </element>
1319
+ <element name="errorInfo" type="string"/>
1320
+ </sequence>
1321
+ </complexType>
1322
+ </element>
1323
+ </sequence>
1324
+ </complexType>
1325
+ </element>
1326
+ <!-- monitorTest Fault -->
1327
+ <element name="monitorTestFault">
1328
+ <simpleType>
1329
+ <restriction base="string">
1330
+ <enumeration value="OperationFailed"/>
1331
+ </restriction>
1332
+ </simpleType>
1333
+ </element>
1334
+ </schema>
1335
+ </types>
1336
+ <message name="initiateTestsRequest">
1337
+ <part name="parameter" element="tmIRPData:initiateTestsRequest"/>
1338
+ </message>
1339
+ <message name="initiateTestsResponse">
1340
+ <part name="parameter" element="tmIRPData:initiateTestsResponse"/>
1341
+ </message>
1342
+ <message name="initiateTestsFault">
1343
+ <part name="parameter" element="tmIRPData:initiateTestsFault"/>
1344
+ </message>
1345
+ <message name="terminateTestsRequest">
1346
+ <part name="parameter" element="tmIRPData:terminateTestsRequest"/>
1347
+ </message>
1348
+ <message name="terminateTestsResponse">
1349
+ <part name="parameter" element="tmIRPData:terminateTestsResponse"/>
1350
+ </message>
1351
+ <message name="terminateTestsFault">
1352
+ <part name="parameter" element="tmIRPData:terminateTestsFault"/>
1353
+ </message>
1354
+ <message name="monitorTestRequest">
1355
+ <part name="parameter" element="tmIRPData:monitorTestRequest"/>
1356
+ </message>
1357
+ <message name="monitorTestResponse">
1358
+ <part name="parameter" element="tmIRPData:monitorTestResponse"/>
1359
+ </message>
1360
+ <message name="monitorTestFault">
1361
+ <part name="parameter" element="tmIRPData:monitorTestFault"/>
1362
+ </message>
1363
+ <portType name="TMIRPControlOperations">
1364
+ <operation name="initiateTests">
1365
+ <input message="tmIRPSystem:initiateTestsRequest"/>
1366
+ <output message="tmIRPSystem:initiateTestsResponse"/>
1367
+ <fault name="initiateTestsFault" message="tmIRPSystem:initiateTestsFault"/>
1368
+ </operation>
1369
+ <operation name="terminateTests">
1370
+ <input message="tmIRPSystem:terminateTestsRequest"/>
1371
+ <output message="tmIRPSystem:terminateTestsResponse"/>
1372
+ <fault name="terminateTestsFault" message="tmIRPSystem:terminateTestsFault"/>
1373
+ </operation>
1374
+ </portType>
1375
+ <portType name="TMIRPMonitorOperations">
1376
+ <operation name="monitorTest">
1377
+ <input message="tmIRPSystem:monitorTestRequest"/>
1378
+ <output message="tmIRPSystem:monitorTestResponse"/>
1379
+ <fault name="monitorTestFault" message="tmIRPSystem:monitorTestFault"/>
1380
+ </operation>
1381
+ </portType>
1382
+ <binding name="TMIRPControlOperations" type="tmIRPSystem:TMIRPControlOperations">
1383
+ <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
1384
+ <operation name="initiateTests">
1385
+
1386
+ ```
1387
+
1388
+ ```
1389
+
1390
+ <soap:operation
1391
+ soapAction="http://www.3gpp.org/ftp/specs/archive/32_series/32.326#initiateTests" style="document"/>
1392
+ <input>
1393
+ <soap:body use="literal"/>
1394
+ </input>
1395
+ <output>
1396
+ <soap:body use="literal"/>
1397
+ </output>
1398
+ <fault name="initiateTestsFault">
1399
+ <soap:fault name="initiateTestsFault" use="literal"/>
1400
+ </fault>
1401
+ </operation>
1402
+ <operation name="terminateTests">
1403
+ <soap:operation
1404
+ soapAction="http://www.3gpp.org/ftp/specs/archive/32_series/32.326#terminateTests"
1405
+ style="document"/>
1406
+ <input>
1407
+ <soap:body use="literal"/>
1408
+ </input>
1409
+ <output>
1410
+ <soap:body use="literal"/>
1411
+ </output>
1412
+ <fault name="terminateTestsFault">
1413
+ <soap:fault name="terminateTestsFault" use="literal"/>
1414
+ </fault>
1415
+ </operation>
1416
+ </binding>
1417
+ <binding name="TMIRPMonitorOperations" type="tmIRPSystem:TMIRPMonitorOperations">
1418
+ <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
1419
+ <operation name="monitorTest">
1420
+ <soap:operation
1421
+ soapAction="http://www.3gpp.org/ftp/specs/archive/32_series/32.326#monitorTest" style="document"/>
1422
+ <input>
1423
+ <soap:body use="literal"/>
1424
+ </input>
1425
+ <output>
1426
+ <soap:body use="literal"/>
1427
+ </output>
1428
+ <fault name="monitorTestFault">
1429
+ <soap:fault name="monitorTestFault" use="literal"/>
1430
+ </fault>
1431
+ </operation>
1432
+ </binding>
1433
+ <service name="TMIRPService">
1434
+ <port name="TMIRPControlOperationsPort" binding="tmIRPSystem:TMIRPControlOperations">
1435
+ <soap:address
1436
+ location="http://www.3gpp.org/ftp/specs/archive/32_series/32.326#TMIRPControl"/>
1437
+ </port>
1438
+ <port name="TMIRPMonitorOperationsPort" binding="tmIRPSystem:TMIRPMonitorOperations">
1439
+ <soap:address
1440
+ location="http://www.3gpp.org/ftp/specs/archive/32_series/32.326#TMIRPMonitor"/>
1441
+ </port>
1442
+ <port name="GenericIRP" binding="genericIRPSystem:GenericIRPBinding">
1443
+ <soap:address
1444
+ location="http://www.3gpp.org/ftp/specs/archive/32_series/32.316#GenericIRP"/>
1445
+ </port>
1446
+ <port name="NotificationIRPNtfPort" binding="ntfIRPNtfSystem:NotificationIRPNtf">
1447
+ <soap:address
1448
+ location="http://www.3gpp.org/ftp/specs/archive/32_series/32.306#NotificationIRPNtf"/>
1449
+ </port>
1450
+ </service>
1451
+ </definitions>
1452
+
1453
+ ```
1454
+
1455
+ # --- Annex D (informative): Change history
1456
+
1457
+ | Change history | | | | | | | |
1458
+ |----------------|-------|-----------|-----|-----|----------------------------------------------------------------------------------|--------|--------|
1459
+ | Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New |
1460
+ | 2010-09 | SA#49 | SP-100514 | -- | -- | Presentation to SA for Information and Approval | --- | 1.0.0 |
1461
+ | 2010-10 | -- | -- | -- | -- | Publication | 1.0.0 | 10.0.0 |
1462
+ | 2010-12 | SA#50 | SP-100833 | 001 | 1 | Correcting the definition of parameter MORT in XML schema - Align with 32.322 IS | 10.0.0 | 10.1.0 |
1463
+
marked/Rel-10/32_series/32331/raw.md ADDED
@@ -0,0 +1,288 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+ # Keywords UMTS, management, alarm 3GPP TS 32.331 V10.0.0 (2011-03)
4
+
5
+ *Technical Specification*
6
+
7
+ ## <sup>3GPP</sup> **3rd Generation Partnership Project;** **Technical Specification Group Services and System Aspects;** **Telecommunication management;** ~~Notification Leg (NL) Integration Reference Point (IRP);~~
8
+
9
+ ![LTE logo with '4ADVANCED' text above the 'e'](64662465bba247703fdec49c8f3309f9_img.jpg)
10
+
11
+ LTE logo with '4ADVANCED' text above the 'e'
12
+
13
+ ~~3GPP support office address:~~
14
+ ~~655 Route des Lucioles - Sophia Antipolis~~
15
+ ~~Valbonne - FRANCE~~
16
+ ~~Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16~~
17
+
18
+ Internet
19
+ <http://www.3gpp.org>
20
+
21
+ ![3GPP logo with a signal icon below the 'P'](0538daaa5583c23e17db3a12f2281a55_img.jpg)
22
+
23
+ 3GPP logo with a signal icon below the 'P'
24
+
25
+ # **Copyright Notification**
26
+
27
+ No part may be reproduced except as authorized by written permission.
28
+ The copyright and the foregoing restriction extend to reproduction in all media.
29
+
30
+ © 2011, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TTA, TTC).
31
+ All rights reserved.
32
+
33
+ UMTS™ is a Trade Mark of ETSI registered for the benefit of its members
34
+
35
+ 3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
36
+
37
+ LTE™ is a Trade Mark of ETSI currently being registered for the benefit of its Members and of the 3GPP Organizational Partners
38
+
39
+ GSM® and the GSM logo are registered and owned by the GSM Association
40
+
41
+ The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP.
42
+
43
+ The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented.
44
+
45
+ This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification.
46
+
47
+ Specifications and reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices.
48
+
49
+ # --- Contents
50
+
51
+ | | |
52
+ |--------------------------------------------------------------------------------|-----------|
53
+ | Foreword ..... | 4 |
54
+ | Introduction ..... | 4 |
55
+ | 1 Scope..... | 5 |
56
+ | 2 References..... | 5 |
57
+ | 3 Definitions and abbreviations ..... | 5 |
58
+ | 3.1 Definitions..... | 5 |
59
+ | 3.2 Abbreviations ..... | 6 |
60
+ | 4 Notification log Management concept..... | 6 |
61
+ | 4.1 Notification Log Management ..... | 6 |
62
+ | 4.2 Detection of the Notification Log state ..... | 7 |
63
+ | 4.3 Notification Log / Notification Log Record Retrieval ..... | 7 |
64
+ | 4.4 Notification Log Full Action..... | 7 |
65
+ | 5 Notification log IRP requirements ..... | 8 |
66
+ | 5.1 Management of Logging/Log Records ..... | 8 |
67
+ | 5.2 Information contained in Notification Log / Notification Log Records ..... | 8 |
68
+ | 5.3 Notifications emitted by Notification Log IRP ..... | 8 |
69
+ | 5.4 Retrieval of Notification Log Records ..... | 8 |
70
+ | 5.5 Exporting Notification Log Records ..... | 9 |
71
+ | 5.6 Overview of IRPs related to Notification Log IRP ..... | 9 |
72
+ | <b>Annex A (informative): Bibliography .....</b> | <b>10</b> |
73
+ | Annex B (informative): Change history..... | 11 |
74
+
75
+ # --- Foreword
76
+
77
+ This Technical Specification (TS) has been produced for the 3<sup>rd</sup> Generation Partnership Project (3GPP).
78
+
79
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
80
+
81
+ Version x.y.z
82
+
83
+ where:
84
+
85
+ - x the first digit:
86
+ - 1 presented to TSG for information;
87
+ - 2 presented to TSG for approval;
88
+ - 3 or greater indicates TSG approved document under change control.
89
+ - y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
90
+ - z the third digit is incremented when editorial only changes have been incorporated in the document.
91
+
92
+ # --- Introduction
93
+
94
+ The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below:
95
+
96
+ - TS 32.331 "Notification Log (NL) Integration Reference Point (IRP); Requirements"**
97
+ - TS 32.332 "Notification Log (NL) (NL) Integration Reference Point (IRP); Information Service (IS)"
98
+ - TS 32.336 "Notification Log (NL) Integration Reference Point (IRP): Solution Sets (SS)".
99
+
100
+ The present document describes the requirements and information model necessary for Telecommunications Management (TM). The TM principles and TM architecture are specified in 3GPP TS 32.101 [1] and 3GPP TS 32.102 [2] respectively.
101
+
102
+ A communications system is composed of a multitude of Network Elements (NE) of various types and, typically, different vendors, which inter-operate in a co-ordinated manner in order to satisfy the network users' communication requirements.
103
+
104
+ The occurrence of faults in an NE may cause deterioration or loss of this NE's function. Fault Management is the functional area, which allows the operator to detect the occurrence of faults in the network in real-time. Configuration Management and Performance Management are two more functional areas, which require the operator to be alerted to certain conditions in the network.
105
+
106
+ A standard general-purpose mechanism for the management of Notification Logs containing selected or all notifications from the network is required to provide an ability to perform historical analysis on faults and conditions, which occurred in the network. The TS 32.33x-series constituting the Notification Log IRP, sets forth such a mechanism - and the present document contains the concept and IRP requirements definition.
107
+
108
+ # --- 1 Scope
109
+
110
+ The present document specifies overall requirements for Notification Log Management over Itf-N.
111
+
112
+ Clause 4 provides the Notification Log Management concept for the manipulation of Notification Logs and the retrieval of notifications selected for logging.
113
+
114
+ Clause 5 of the present document defines the functional requirements for the Notification Log IRP, for the purpose of Notification Log Management, as seen from a Network Manager (NM) through Itf-N. The Itf-N is fully standardized so as to connect systems of any vendor to an NM via this interface.
115
+
116
+ # --- 2 References
117
+
118
+ The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
119
+
120
+ - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
121
+ - For a specific reference, subsequent revisions do not apply.
122
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
123
+
124
+ - [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements".
125
+ - [2] 3GPP TS 32.102: "Telecommunication management; Architecture".
126
+ - [3] 3GPP TS 32.302: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP): Information Service (IS)".
127
+ - [4] 3GPP TS 32.662: "Telecommunication management; Configuration Management (CM); Kernel CM Information Service (IS)".
128
+ - [5] 3GPP TS 32.111-1: "Telecommunication management; Fault Management; Part 1: 3G fault management requirements".
129
+ - [6] 3GPP TS 32.111-2: "Telecommunication management; Fault Management; Part 2: Alarm Integration Reference Point (IRP): Information Service (IS)".
130
+ - [7] 3GPP TS 32.342: "Telecommunication management; File Transfer (FT) Integration Reference Point (IRP): Information Service (IS)".
131
+ - [8] ITU-T Recommendation X.735: "Information technology - Open Systems Interconnection - Systems Management: Log control function".
132
+
133
+ # --- 3 Definitions and abbreviations
134
+
135
+ ## 3.1 Definitions
136
+
137
+ For the purposes of the present document, the following terms and definitions apply:
138
+
139
+ **Alarm:** defined in 3GPP TS 32.111-1 [5].
140
+
141
+ **Alarm Notification:** defined in 3GPP TS 32.111-1 [5].
142
+
143
+ **Event:** defined in 3GPP TS 32.111-1 [5].
144
+
145
+ **Fault:** defined in 3GPP TS 32.111-1 [5].
146
+
147
+ **Notification:** defined in 3GPP TS 32.111-1 [5].
148
+
149
+ **Notification Log:** managed resource in which the notifications are stored
150
+
151
+ Notifications logs contain Notification Log Records. Notification Log may represent a physical or a logical/virtual storage, and which is not apparent to an IRPManager.
152
+
153
+ **Notification Log Record:** records track information about when a particular notification was entered into the Notification Log and the details of the notification
154
+
155
+ Each Notification Log Record is associated with one notification, where a notification may be an alarm or an event.
156
+
157
+ ## 3.2 Abbreviations
158
+
159
+ For the purposes of the present document, the following abbreviations apply:
160
+
161
+ | | |
162
+ |------|-----------------------------|
163
+ | COTS | Commercial Off The Shelf |
164
+ | EM | Element Manager |
165
+ | IRP | Integration Reference Point |
166
+ | LM | Log Management |
167
+ | NE | Network Element |
168
+ | NM | Network Manager |
169
+ | OS | Operations System |
170
+
171
+ # --- 4 Notification log Management concept
172
+
173
+ A general-purpose Notification Logging mechanism is required to hold notifications related to different functional areas in the network.
174
+
175
+ Any Notification Log must, at any one point in time, be capable of holding fault management alarms, configuration management events, performance management events, and event log management events. A log is capable of capturing all semantics carried in a notification.
176
+
177
+ Only those requirements covered by clause 5 and as applicable to the Notification Log IRP IS shall be considered as valid requirements for compliance to the standard defined by the present document.
178
+
179
+ ## 4.1 Notification Log Management
180
+
181
+ Notification logs are resources in a communications network. An operator needs to be able to create Notification Logs, delete Notification Logs, query Notification Logs and to delete records. To allow an operator to do this a Notification Log management framework needs to be in place.
182
+
183
+ The following aspects for Notification Log Management are derived from ITU-T Recommendation X.735 [8]:
184
+
185
+ - The definition of a flexible Notification Log control service, which will allow selection of Notification Log records that are to be logged by a management system (NMs or EMs) in a Notification Log or a particular Notification Log.
186
+ - The ability for a client system to modify the criteria used in logging notification records.
187
+ - The ability for a client system to determine whether the logging characteristics were modified or whether notifications log records has been lost.
188
+ - Specification of a mechanism to enable Notification Logging to be suspended and subsequently to be resumed.
189
+ - The ability for a client system to retrieve and delete Notification Log records.
190
+ - The ability for a client system to create and delete those Notification Logs.
191
+ - The ability to log partial notifications.
192
+
193
+ Another aspect is listed below:
194
+
195
+ - Ability to export a log to an industry standard format such as XML.
196
+
197
+ Such an export facility would allow the analysis and reporting of logs to be carried out by COTS tools.
198
+
199
+ ## 4.2 Detection of the Notification Log state
200
+
201
+ The Notification Log management system must notify all interested OS about its current state. An event-based approach is used to update OSs on the current state of the Notification Log.
202
+
203
+ To facilitate the notification of attribute or state changes, a Notification Log has the capability to generate such events, which all OSs may subscribe to via the Notification IRP 3GPP TS 32.302 [3].
204
+
205
+ The Notification Log management system may also emit Notification Log creation and log deletion notifications to signal the creation or deletion of a particular log. Again all interested OSs may subscribe via 3GPP TS 32.302 [3] to receive such notifications.
206
+
207
+ To notify OSs about the loss or imminent loss of Notification Log records, the system is able to emit capacity threshold alarms that alert the subscribed OSs that a capacity threshold has been crossed in a particular Notification Log. This threshold value may indicate that the Notification Log is full and incoming notifications shall be dealt with in a predetermined manner set by an operator.
208
+
209
+ The system may emit other events to notify an OS of the completion of an I/O intensive operation, such as deletion of Notification Log records, or the exporting of a Notification Log.
210
+
211
+ ## 4.3 Notification Log / Notification Log Record Retrieval
212
+
213
+ An OS may retrieve Notification Log records either by querying a particular Notification Log with a filter, or by exporting a Notification Log, or a particular section of a Notification Log. Exporting a Notification Log utilizing the File Transfer IRP (3GPP TS 32.342 [7]) allows the OS to retrieve the Notification Log in a standard format such as XML. An XML data format may be used by generic XML utilities and next generation web browsers for analysis and reporting. XML is a widely accepted data interchange format, and its application to Notification Log management provides an ease of use unparalleled in traditional Notification Log systems.
214
+
215
+ ## 4.4 Notification Log Full Action
216
+
217
+ The OS must be able to set the behaviour of a Notification Log that becomes full. ITU-T Recommendation X.735 [8] recommends two actions, halt and wrap.
218
+
219
+ - A Notification Log that halts when full implies the agent should notify the OS by way of generating a capacity threshold alarm. New notifications, which should be logged according to the Notification Log's filter criteria, are discarded. This behaviour implies that the old Notification Log records are more important than new ones.
220
+ - An OS can set the behaviour of the Notification Log to wrap when full. In this case the Notification Log behaves like a circular buffer, replacing the oldest Notification Log records with new ones. This behaviour implies that new Notification Log records are more important than old Notification Log records.
221
+
222
+ # --- 5 Notification log IRP requirements
223
+
224
+ ## 5.1 Management of Logging/Log Records
225
+
226
+ The IRPManager may request the IRPAgent to start or stop logging of notifications, or the IRPAgent may initiate logging by itself (an IRPAgent may log notifications independent from IRPManager initiated logging). Upon start of Notification Logging, the IRPAgent shall generate an identifier for it. All Notification Logging activity identifiers must be unique within the IRPAgent. The IRPAgent may alert all interested IRPManagers about the creation of the new Notification Logging activity. An initiating IRPManager may request the IRPAgent to stop logging of notifications, and the IRPAgent may then alert all interested IRPManagers about the stop of this Notification Logging activity.
227
+
228
+ Deletion of Notification Log Records is in the realm of the IRPAgent, where two methods should apply:
229
+
230
+ - Notification Log Full Action: the IRPAgent should apply the "circular buffer" or "wrap" method (see also clause 4.4); a one-time Notification Log threshold capacity alarm (e.g. at 98 % full) will indicate to IRPManagers that the IRPAgent is applying this method currently, while clearance will be indicated as well (e.g. at 90 % full)
231
+ - Maintenance: the IRPAgent may delete Notification Log Records from a Notification Log.
232
+
233
+ The IRPManager may request a list of all IRPManager initiated or IRPAgent initiated log activities currently managed by the IRPAgent. The IRPAgent returns a list of Notification Log identifiers to the IRPManager. The IRPManager may then use these identifiers to query or export a log or parts of it.
234
+
235
+ ## 5.2 Information contained in Notification Log / Notification Log Records
236
+
237
+ A Notification Log may be created by the IRPAgent upon request of the IRPManager, or by the IRPAgent itself. A Notification Log may represent a physical or a logical/virtual storage, and which is not apparent to an IRPManager.
238
+
239
+ All Notifications available at the IRPAgent for potential transmission over Itf-N shall be logged if requested by a start log request, irrespective of the subscriptions and filter settings of IRPManagers.
240
+
241
+ The Notification Log Record will contain a notification as specified by 3GPP TS 32.302 [3]. The Notification Log Record is time-stamped, allowing the operator to determine the time at which the Notification Log Record was added to the Notification Log.
242
+
243
+ The IRPAgent should avoid logging the following duplicated or recursive notifications
244
+
245
+ - Logging of notifications resulting from asynchronous alarm synchronization (3GPP TS 32.111-2 [6]).
246
+
247
+ ## 5.3 Notifications emitted by Notification Log IRP
248
+
249
+ LM reports are forwarded in real-time to the IRPManager via appropriate filtering located in the IRPAgents. The Notification Log IRP reports consist of:
250
+
251
+ - Notification log starting and stopping reports, upon the activation/deactivation of a Notification Logging activity.
252
+ - Notification log capacity threshold reached report, and notification when logging has resumed.
253
+
254
+ ## 5.4 Retrieval of Notification Log Records
255
+
256
+ The IRPManager will request the IRPAgent to query the notifications log based on filter criteria. The IRPAgent will then return the Notification Log Records that match the IRPManager's filter criteria. Each Notification Log Record returned will contain a notification that the IRPManager is interested in.
257
+
258
+ ## 5.5 Exporting Notification Log Records
259
+
260
+ The IRPManager may request the IRPAgent to export either a Notification Log or part thereof. In this case the IRPManager will supply a filter criteria and Notification Log Records matching that criteria will be exported to a standard format such as XML defined by the Notification Log IRP. The IRPAgent will provide this export file to an IRPManager utilizing the File Transfer IRP (3GPP TS 32.342 [7]).
261
+
262
+ ## 5.6 Overview of IRPs related to Notification Log IRP
263
+
264
+ The Itf-N interface relies on the Notification IRP 3GPP TS 32.302 [3] as well as File Transfer IRP (3GPP TS 32.342 [7]), and serves a number of IRPs. The basic structure of the IRPs is defined in 3GPP TS 32.101 [1] and 3GPP TS 32.102 [2].
265
+
266
+ For the purpose of LM, the following IRPs are served:
267
+
268
+ - Alarm IRP: Information Service 3GPP TS 32.111-2 [6].
269
+ - Kernel CM IRP: Information Service 3GPP TS 32.662 [4].
270
+ - All other IRP's emitting notifications.
271
+
272
+ # --- Annex A (informative): Bibliography
273
+
274
+ - World Wide Web Consortium: [www.w3c.org](http://www.w3c.org).
275
+
276
+ # --- Annex B (informative): Change history
277
+
278
+ | Change history | | | | | | | |
279
+ |----------------|-------|-----------|----|-----|--------------------------------------------------------------------------------------------------------------------|-------|--------|
280
+ | Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New |
281
+ | Sep 2003 | S 22 | SP-030638 | -- | -- | Submitted to TSG SA#22 for Information | 1.0.0 | |
282
+ | Mar 2004 | S 23 | SP-040122 | -- | -- | Submitted to TSG SA#23 for Approval | 2.0.0 | 6.0.0 |
283
+ | Jun 2005 | -- | -- | -- | -- | Introduction update : added 32.335 new TS-family member | 6.0.0 | 6.0.1 |
284
+ | Jun 2007 | SA_36 | -- | -- | -- | Automatic upgrade to Rel-7 (no CR) at freeze of Rel-7. Deleted reference to CMIP SS, discontinued from R7 onwards. | 6.0.1 | 7.0.0 |
285
+ | Dec 2008 | SA 42 | -- | -- | -- | Upgrade to Release 8 | 7.0.0 | 8.0.0 |
286
+ | Dec 2009 | - | - | - | - | Update to Rel-9 version (MCC) | 8.0.0 | 9.0.0 |
287
+ | Mar 2011 | - | - | - | - | Update to Rel-10 version (MCC) | 9.0.0 | 10.0.0 |
288
+
marked/Rel-10/32_series/32332/raw.md ADDED
@@ -0,0 +1,1049 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+ # Keywords UMTS, Management 3GPP TS 32.332 V10.0.0 (2011-03)
4
+
5
+ *Technical Specification*
6
+
7
+ **3GPP**
8
+ **3rd Generation Partnership Project;**
9
+ Postal address
10
+ **Technical Specification Group Services and System Aspects;**
11
+ **Telecommunication management;**
12
+ 3GPP support office address
13
+ 150 Route des Lucioles - 69121 Saint-Fons
14
+ Valbonne - FRANCE
15
+ Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
16
+ **Identification Log (NL) Integration Reference Point (IRP);**
17
+ Informa
18
+
19
+ ![LTE logo with '4 ADVANCED' text above the 'e'](64662465bba247703fdec49c8f3309f9_img.jpg)
20
+
21
+ LTE logo with '4 ADVANCED' text above the 'e'
22
+
23
+ Internet
24
+ <http://www.3gpp.org>
25
+
26
+ ![3GPP logo with a signal icon below the 'P'](390120de4fe440c42fea8154fcaad334_img.jpg)
27
+
28
+ 3GPP logo with a signal icon below the 'P'
29
+
30
+ # **Copyright Notification**
31
+
32
+ No part may be reproduced except as authorized by written permission.
33
+ The copyright and the foregoing restriction extend to reproduction in all media.
34
+
35
+ © 2011, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TTA, TTC).
36
+ All rights reserved.
37
+
38
+ UMTS™ is a Trade Mark of ETSI registered for the benefit of its members
39
+
40
+ 3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
41
+
42
+ LTE™ is a Trade Mark of ETSI currently being registered for the benefit of its Members and of the 3GPP Organizational Partners
43
+
44
+ GSM® and the GSM logo are registered and owned by the GSM Association
45
+
46
+ The present document has been developed within the 3rd Generation Partnership Project (3GPP™) and may be further elaborated for the purposes of 3GPP.
47
+
48
+ The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented.
49
+
50
+ This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification.
51
+
52
+ Specifications and reports for implementation of the 3GPP™ system should be obtained via the 3GPP Organizational Partners' Publications Offices.
53
+
54
+ # --- Contents
55
+
56
+ | | |
57
+ |---------------------------------------------------------------|----|
58
+ | Foreword ..... | 6 |
59
+ | Introduction ..... | 6 |
60
+ | 1 Scope..... | 7 |
61
+ | 2 References..... | 7 |
62
+ | 3 Definitions and abbreviations ..... | 7 |
63
+ | 3.1 Definitions..... | 7 |
64
+ | 3.2 Abbreviations ..... | 8 |
65
+ | 4 System overview ..... | 8 |
66
+ | 4.2 Compliance rules..... | 8 |
67
+ | 5 Information Object Classes (IOCs)..... | 9 |
68
+ | 5.1 Information entities imported and local labels..... | 9 |
69
+ | 5.2 Class diagram ..... | 10 |
70
+ | 5.2.1 Attributes and relationships..... | 10 |
71
+ | 5.2.2 Inheritance ..... | 11 |
72
+ | 5.3 Information Object Class (IOC) definitions..... | 12 |
73
+ | 5.3.1 NLIRP..... | 12 |
74
+ | 5.3.1.1 Definition ..... | 12 |
75
+ | 5.3.1.2 Attributes ..... | 12 |
76
+ | 5.3.2 Log..... | 12 |
77
+ | 5.3.2.1 Definition ..... | 12 |
78
+ | 5.3.2.2 Attributes ..... | 12 |
79
+ | 5.3.2.3 State diagram ..... | 13 |
80
+ | 5.3.3 LogRecord ..... | 13 |
81
+ | 5.3.3.1 Definition ..... | 13 |
82
+ | 5.4 Information relationship definitions..... | 14 |
83
+ | 5.4.1 Relation-nLIRP-log (M)..... | 14 |
84
+ | 5.4.1.1 Definition ..... | 14 |
85
+ | 5.4.1.2 Role..... | 14 |
86
+ | 5.4.1.3 Constraint..... | 14 |
87
+ | 5.4.2 Relation-log-logRecord (M)..... | 14 |
88
+ | 5.4.2.1 Definition ..... | 14 |
89
+ | 5.4.2.2 Role..... | 14 |
90
+ | 5.4.2.3 Constraint..... | 14 |
91
+ | 5.4.3 Relation-logRecord-notificationIRPNotification (M)..... | 15 |
92
+ | 5.4.3.1 Definition ..... | 15 |
93
+ | 5.4.3.2 Role..... | 15 |
94
+ | 5.4.3.3 Constraint..... | 15 |
95
+ | 5.5 Information attribute definition..... | 16 |
96
+ | 5.5.1 Definition and legal values..... | 16 |
97
+ | 5.5.2 Constraints ..... | 17 |
98
+ | 6 Interface definition ..... | 17 |
99
+ | 6.1 Class diagram..... | 17 |
100
+ | 6.2 Generic rules ..... | 18 |
101
+ | 6.3 NLIRPOperations_1 Interface (M) ..... | 18 |
102
+ | 6.3.1 Operation subscribeLog (M) ..... | 18 |
103
+ | 6.3.1.1 Definition ..... | 18 |
104
+ | 6.3.1.2 Input parameters ..... | 18 |
105
+ | 6.3.1.3 Output parameters..... | 19 |
106
+ | 6.3.1.4 Pre-condition..... | 19 |
107
+ | 6.3.1.5 Post-condition ..... | 19 |
108
+ | 6.3.1.6 Exceptions..... | 19 |
109
+ | 6.3.2 Operation unsubscribeLog (M) ..... | 20 |
110
+ | 6.3.2.1 Definition ..... | 20 |
111
+
112
+ | | | |
113
+ |-----------|-----------------------------------------------------------------|----|
114
+ | 6.3.2.2 | Input parameters ..... | 20 |
115
+ | 6.3.2.3 | Output parameters..... | 20 |
116
+ | 6.3.2.4 | Pre-condition..... | 20 |
117
+ | 6.3.2.5 | Post-condition ..... | 20 |
118
+ | 6.3.2.6 | Exceptions..... | 20 |
119
+ | 6.3 | Operation <code>exportLogRecords</code> (O) ..... | 21 |
120
+ | 6.3.3.1 | Definition ..... | 21 |
121
+ | 6.3.3.2 | Input parameters ..... | 21 |
122
+ | 6.3.3.3 | Output parameters..... | 21 |
123
+ | 6.3.3.4 | Pre-condition..... | 21 |
124
+ | 6.3.3.5 | Post-condition ..... | 21 |
125
+ | 6.3.3.6 | Exceptions..... | 21 |
126
+ | 6.3.4 | Operation <code>getLogRecords</code> (O) ..... | 22 |
127
+ | 6.3.4.1 | Definition ..... | 22 |
128
+ | 6.3.4.2 | Input parameters ..... | 22 |
129
+ | 6.3.4.3 | Output parameters..... | 22 |
130
+ | 6.3.4.4 | Pre-condition..... | 22 |
131
+ | 6.3.4.5 | Post-condition ..... | 22 |
132
+ | 6.3.4.6 | Exceptions..... | 22 |
133
+ | 6.4 | NLIRPOperations_2 Interface (O) ..... | 23 |
134
+ | 6.4.1 | Operation <code>getLogSubscriptionIds</code> (M) ..... | 23 |
135
+ | 6.4.1.1 | Definition ..... | 23 |
136
+ | 6.4.1.2 | Input parameters ..... | 23 |
137
+ | 6.4.1.3 | Output parameters..... | 23 |
138
+ | 6.4.1.4 | Pre-condition..... | 23 |
139
+ | 6.4.1.5 | Post-condition ..... | 23 |
140
+ | 6.4.1.6 | Exceptions..... | 23 |
141
+ | 6.4.2 | Operation <code>getLogSubscriptionStatus</code> (M)..... | 24 |
142
+ | 6.4.2.1 | Definition ..... | 24 |
143
+ | 6.4.2.2 | Input parameters ..... | 24 |
144
+ | 6.4.2.3 | Output parameters..... | 24 |
145
+ | 6.4.2.4 | Pre-condition..... | 24 |
146
+ | 6.4.2.5 | Post-condition ..... | 24 |
147
+ | 6.4.2.6 | Exceptions..... | 24 |
148
+ | 6.5 | NLIRPNotifications_1 Interface (M)..... | 25 |
149
+ | 6.5.1 | Notification <code>notifyLogSubscribed</code> (M) ..... | 25 |
150
+ | 6.5.1.1 | Definition ..... | 25 |
151
+ | 6.5.1.2 | Input Parameters ..... | 25 |
152
+ | 6.5.1.3 | Triggering Event..... | 25 |
153
+ | 6.5.1.3.1 | From-state..... | 25 |
154
+ | 6.5.1.3.2 | To-state..... | 25 |
155
+ | 6.5.2 | Notification <code>notifyLogUnsubscribed</code> (M) ..... | 26 |
156
+ | 6.5.2.1 | Definition ..... | 26 |
157
+ | 6.5.2.2 | Input Parameters ..... | 26 |
158
+ | 6.5.2.3 | Triggering Event..... | 26 |
159
+ | 6.5.2.3.1 | From-state..... | 26 |
160
+ | 6.5.2.3.2 | To-state..... | 26 |
161
+ | 6.6 | NLIRPNotifications_2 Interface (O)..... | 27 |
162
+ | 6.6.1 | Notification <code>notifyOccupancyLevelCrossed</code> (M) ..... | 27 |
163
+ | 6.6.1.1 | Definition ..... | 27 |
164
+ | 6.6.1.2 | Input Parameters ..... | 27 |
165
+ | 6.6.1.3 | Triggering Event..... | 27 |
166
+ | 6.6.1.3.1 | From-state..... | 27 |
167
+ | 6.6.1.3.2 | To-state..... | 27 |
168
+ | 6.6.2 | Notification <code>notifyLoggingResumed</code> (O) ..... | 28 |
169
+ | 6.6.2.1 | Definition ..... | 28 |
170
+ | 6.6.2.2 | Input Parameters ..... | 28 |
171
+ | 6.6.2.3 | Triggering Event..... | 28 |
172
+ | 6.6.2.3.1 | From-state..... | 28 |
173
+ | 6.6.2.3.2 | To-state..... | 28 |
174
+
175
+ Annex A (informative): Change history..... 29
176
+
177
+ # --- Foreword
178
+
179
+ This Technical Specification (TS) has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP).
180
+
181
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
182
+
183
+ Version x.y.z
184
+
185
+ where:
186
+
187
+ - x the first digit:
188
+ - 1 presented to TSG for information;
189
+ - 2 presented to TSG for approval;
190
+ - 3 or greater indicates TSG approved document under change control.
191
+ - y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
192
+ - z the third digit is incremented when editorial only changes have been incorporated in the document.
193
+
194
+ # --- Introduction
195
+
196
+ The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below:
197
+
198
+ - TS 32.331 "Notification Log (NL) Integration Reference Point (IRP): Requirements"
199
+ - TS 32.332 "Notification Log (NL) Integration Reference Point (IRP): Information Service (IS)"**
200
+ - TS 32.336 "Notification Log (NL) Integration Reference Point (IRP); Solution Set (SS) definitions"
201
+
202
+ The present document describes the requirements and information model necessary for Telecommunication Management (TM). The TM principles and TM architecture are specified in 3GPP TS 32.101 [1] and 3GPP TS 32.102 [2].
203
+
204
+ A communications system is composed of a multitude of Network Elements (NE) of various types and, typically, different vendors, which inter-operate in a co-ordinated manner in order to satisfy the network users' communication requirements.
205
+
206
+ The occurrence of faults in an NE may cause deterioration or loss of this NE's function. Fault Management is the functional area, which allows the operator to detect the occurrence of faults in the network in real-time. Configuration Management and Performance Management are two more functional areas, which require the operator to be alerted to certain conditions in the network.
207
+
208
+ A standard general-purpose mechanism for the management of logs containing selected notifications from the network is required to provide an ability to perform historical analysis on faults and conditions, which occurred in the network. The TS 32.33x-series, constituting the Notification log IRP, sets forth such a mechanism - and the present document contains the IS definition.
209
+
210
+ # --- 1 Scope
211
+
212
+ The present document specifies the Information Service for the Notification Log Integration Reference Point (NLIRP) as it applies to Itf-N.
213
+
214
+ This IRP IS defines the semantics of operations (and their parameters) visible across the Itf-N in a protocol and technology neutral way. It does not define the syntax or encoding of the operations and their parameters.
215
+
216
+ # --- 2 References
217
+
218
+ The following documents contain provisions, which through reference in this text constitute provisions of the present document.
219
+
220
+ - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
221
+ - For a specific reference, subsequent revisions do not apply.
222
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
223
+
224
+ - [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements".
225
+ - [2] 3GPP TS 32.102: "Telecommunication management; Architecture".
226
+ - [3] 3GPP TS 32.302: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP): Information Service (IS)".
227
+ - [4] 3GPP TS 32.622: "Telecommunication management; Configuration Management (CM); Generic network resources Integration Reference Point (IRP): Network Resource Model (NRM)".
228
+ - [5] 3GPP TS 32.111-2: "Telecommunication management; Fault Management; Part 2: Alarm Integration Reference Point (IRP): Information Service (IS)".
229
+ - [6] 3GPP TS 32.312: "Telecommunication management; Generic Integration Reference Point (IRP) management; Information Service (IS)".
230
+ - [7] 3GPP TS 32.331: "Telecommunication management; Notification Log (NL) Integration Reference Point (IRP): Requirements".
231
+ - [8] 3GPP TS 32.342 "Telecommunication management; File Transfer (FT) Integration Reference Point (IRP): Information Service (IS)".
232
+ - [9] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions".
233
+
234
+ # --- 3 Definitions and abbreviations
235
+
236
+ ## 3.1 Definitions
237
+
238
+ For the purposes of the present document, the terms and definitions given in 3GPP TS 32.101 [1], 3GPP TS 32.102 [2], 3GPP TS 32.111-2 [5] and 3GPP TS 32.331 [7] apply.
239
+
240
+ **notification category:** it refers to the set of notifications of one 3GPP IRP Information Service specification
241
+ A Notification Category is identified by the name of the IRP specification and the IRP specification version number.
242
+
243
+ ## 3.2 Abbreviations
244
+
245
+ For the purposes of the present document, the following abbreviations apply:
246
+
247
+ | | |
248
+ |-------|----------------------------------------------|
249
+ | DN | Distinguished Name |
250
+ | EM | Element Manager |
251
+ | FT | File Transfer |
252
+ | IOC | Information Object Class |
253
+ | IRP | Integration Reference Point |
254
+ | M | Mandatory |
255
+ | NE | Network Element |
256
+ | NL | Notification Log |
257
+ | NLIRP | Notification Log Integration Reference Point |
258
+ | NM | Network Manager |
259
+ | O | Optional |
260
+ | UML | Unified Modelling Language |
261
+
262
+ # 4 System overview
263
+
264
+ The general definition of the System Context for the present IRP is found in 3GPP TS 32.150 [9] clause 4.7.
265
+
266
+ In addition, the set of related IRP(s) relevant to the present IRP is shown in the two diagrams below
267
+
268
+ ![Figure 4.1: System Context A diagram](0236eff05bcb8f3a343ea7933aaa306b_img.jpg)
269
+
270
+ The diagram shows a Network Manager (NM) containing an IRPManager, connected via a solid line to an Element Manager (EM) containing an IRPAgent. The IRPAgent is connected via a dotted line to multiple Network Elements (NEs). A vertical dashed line separates the NM and EM. Below the dashed line, an arrow labeled 'Itf-N' points to a list of three Integration Reference Points: Notification IRP, Notification Log IRP, and File Transfer IRP.
271
+
272
+ Figure 4.1: System Context A diagram
273
+
274
+ Figure 4.1: System Context A
275
+
276
+ ![Figure 4.2: System Context B diagram](9791722d75115ddcc599b07d7bc35d73_img.jpg)
277
+
278
+ The diagram shows a Network Manager (NM) containing an IRPManager, connected via a solid line to a Network Element (NE) containing an IRPAgent. A vertical dashed line separates the NM and NE. Below the dashed line, an arrow labeled 'Itf-N' points to a list of three Integration Reference Points: Notification IRP, Notification Log IRP, and File Transfer IRP.
279
+
280
+ Figure 4.2: System Context B diagram
281
+
282
+ Figure 4.2: System Context B
283
+
284
+ ## 4.2 Compliance rules
285
+
286
+ For general definitions of compliance rules related to qualifiers (Mandatory/Optional/Conditional) for *operations, notifications and parameters* (of operations and notifications) please refer to 3GPP TS 32.102 [2].
287
+
288
+ # 5 Information Object Classes (IOCs)
289
+
290
+ ## 5.1 Information entities imported and local labels
291
+
292
+ | Label reference | Local label |
293
+ |---------------------------------------------------------------------------|-----------------------------|
294
+ | 3GPP TS 32.622 [4], information object class, Top | Top |
295
+ | 3GPP TS 32.312 [6], information object class, ManagedGenericIRP | ManagedGenericIRP |
296
+ | 3GPP TS 32.342 [8], information object class, FileTransferIRP | FileTransferIRP |
297
+ | 3GPP TS 32.302 [3], information object class, NotificationIRP | NotificationIRP |
298
+ | 3GPP TS 32.302 [3], information object class, NotificationIRPNotification | NotificationIRPNotification |
299
+
300
+ ## 5.2 Class diagram
301
+
302
+ ### 5.2.1 Attributes and relationships
303
+
304
+ This clause introduces the set of IOCs that encapsulate information within the IRP Agent. The intent is to identify the information required for NLIRP operations and notification. This clause provides the overview of all support object classes in UML. Subsequent clauses provide more detailed specification of various aspects of these support object classes.
305
+
306
+ ![UML Class diagram showing NLIRP, Log, LogRecord, and NotificationIRPNotification classes and their relationships.](dbe553cf16dd14073b89a8263a428664_img.jpg)
307
+
308
+ ```
309
+ classDiagram
310
+ class NLIRP {
311
+ maxLogs
312
+ }
313
+ class Log {
314
+ logSubscriptionId
315
+ loggingEndTime
316
+ maxSize
317
+ currentSize
318
+ creationTime
319
+ logState
320
+ logRecordCount
321
+ notificationCategories
322
+ filter
323
+ logFullAction
324
+ occupancyLevels
325
+ logManagerToken
326
+ }
327
+ class LogRecord {
328
+ logRecordId
329
+ logRecordContent
330
+ }
331
+ class NotificationIRPNotification {
332
+ notificationId
333
+ eventTime
334
+ systemDN
335
+ notificationType
336
+ }
337
+
338
+ NLIRP "1" *-- "0..*" Log : <<names>>
339
+ Log "1" *-- "0..*" LogRecord : +logRecord
340
+ LogRecord "1" -- "1" NotificationIRPNotification : relation-logRecord-notification
341
+ ```
342
+
343
+ The diagram illustrates the Information Object Class (IOC) structure. It consists of four classes: **NLIRP**, **Log**, **LogRecord**, and **NotificationIRPNotification**. **NLIRP** has an attribute **maxLogs**. **Log** has attributes: **logSubscriptionId**, **loggingEndTime**, **maxSize**, **currentSize**, **creationTime**, **logState**, **logRecordCount**, **notificationCategories**, **filter**, **logFullAction**, **occupancyLevels**, and **logManagerToken**. **LogRecord** has attributes: **logRecordId** and **logRecordContent**. **NotificationIRPNotification** (from TS32.302) has attributes: **notificationId**, **eventTime**, **systemDN**, and **notificationType**. Relationships: **NLIRP** has a composition relationship with **Log** (multiplicity 1 to 0..\*, role name **<<names>>**). **Log** has a composition relationship with **LogRecord** (multiplicity 1 to 0..\*, role name **+logRecord**). **LogRecord** has a bidirectional association with **NotificationIRPNotification** (multiplicity 1 to 1, role name **relation-logRecord-notification**).
344
+
345
+ UML Class diagram showing NLIRP, Log, LogRecord, and NotificationIRPNotification classes and their relationships.
346
+
347
+ Figure 5.1: Information Object Class (IOC) UML diagram
348
+
349
+ To change: change logid, add logrecordcontent, remove logrecordsource.
350
+
351
+ ### 5.2.2 Inheritance
352
+
353
+ ![UML diagram showing Information Object Class (IOC) inheritance. ManagedGenericIRP is the root class. NLIRP inherits from ManagedGenericIRP. Top (from TS32.622) is a base class for Log and LogRecord. Log and LogRecord inherit from Top.](f4fdd410cdb84df81274da55721e56fb_img.jpg)
354
+
355
+ ```
356
+ classDiagram
357
+ class ManagedGenericIRP {
358
+ <<InformationObjectClass>>
359
+ (from TS32.312)
360
+ }
361
+ class NLIRP {
362
+ <<InformationObjectClass>>
363
+ maxLogs
364
+ }
365
+ class Top {
366
+ <<InformationObjectClass>>
367
+ Top
368
+ (from TS32.622)
369
+ objectClass
370
+ objectInstance
371
+ }
372
+ class Log {
373
+ <<InformationObjectClass>>
374
+ Log
375
+ logSubscriptionId
376
+ loggingEndTime
377
+ maxSize
378
+ currentSize
379
+ creationTime
380
+ logState
381
+ logRecordCount
382
+ notificationCategories
383
+ filter
384
+ logFullAction
385
+ occupancyLevels
386
+ logManagerToken
387
+ }
388
+ class LogRecord {
389
+ <<InformationObjectClass>>
390
+ LogRecord
391
+ logRecordId
392
+ logRecordContent
393
+ }
394
+ ManagedGenericIRP <|-- NLIRP
395
+ Top <|-- Log
396
+ Top <|-- LogRecord
397
+ ```
398
+
399
+ The diagram illustrates the inheritance hierarchy for Information Object Classes (IOCs). At the top is the **ManagedGenericIRP** class (from TS32.312). Below it, the **NLIRP** class (an **<<InformationObjectClass>>**) inherits from **ManagedGenericIRP** and has a **maxLogs** attribute. To the right, the **Top** class (an **<<InformationObjectClass>>** from TS32.622) has **objectClass** and **objectInstance** attributes. Below **Top**, the **Log** class (an **<<InformationObjectClass>>**) and the **LogRecord** class (an **<<InformationObjectClass>>**) both inherit from it. The **Log** class has attributes: **logSubscriptionId**, **loggingEndTime**, **maxSize**, **currentSize**, **creationTime**, **logState**, **logRecordCount**, **notificationCategories**, **filter**, **logFullAction**, **occupancyLevels**, and **logManagerToken**. The **LogRecord** class has attributes: **logRecordId** and **logRecordContent**.
400
+
401
+ UML diagram showing Information Object Class (IOC) inheritance. ManagedGenericIRP is the root class. NLIRP inherits from ManagedGenericIRP. Top (from TS32.622) is a base class for Log and LogRecord. Log and LogRecord inherit from Top.
402
+
403
+ Figure 5.2: Information Object Class (IOC) inheritance UML diagram
404
+
405
+ ## 5.3 Information Object Class (IOC) definitions
406
+
407
+ ### 5.3.1 NLIRP
408
+
409
+ #### 5.3.1.1 Definition
410
+
411
+ LogIRP is the representation of the notification log management capabilities specified by the present document. This IOC inherits from ManagedGenericIRP IOC specified in TS 32.312 [6].
412
+
413
+ #### 5.3.1.2 Attributes
414
+
415
+ | Attribute name | Support Qualifier | Read Qualifier | Write Qualifier |
416
+ |----------------|-------------------|----------------|-----------------|
417
+ | maxLogs | O | M | - |
418
+
419
+ ### 5.3.2 Log
420
+
421
+ #### 5.3.2.1 Definition
422
+
423
+ The Log IOC is the representation of a Notification Log.
424
+
425
+ #### 5.3.2.2 Attributes
426
+
427
+ | Attribute name | Support Qualifier | Read Qualifier | Write Qualifier |
428
+ |------------------------|-------------------|----------------|-----------------|
429
+ | logSubscriptionId | M | M | - |
430
+ | loggingEndTime | O | M | - |
431
+ | logManagerToken | O | - | - |
432
+ | maxSize | O | M | - |
433
+ | currentSize | O | M | - |
434
+ | creationTime | O | M | - |
435
+ | logState | M | M | - |
436
+ | logRecordCount | O | M | - |
437
+ | notificationCategories | O | M | - |
438
+ | filter | O | M | - |
439
+ | logFullAction | M | M | - |
440
+ | occupancyLevels | M | M | - |
441
+
442
+ #### 5.3.2.3 State diagram
443
+
444
+ ![State diagram for Notification Log showing four states: logging, logWrapping, logHalted, and stopped. Transitions include startLog, occupancyLevelChanged, logFull (wrap/halt), stopLog (lifeTimeExpired), and logNotFull (notifyLoggingResumed).](007b053fe94a8348f75128a584503fd0_img.jpg)
445
+
446
+ ```
447
+
448
+ stateDiagram-v2
449
+ [*] --> logging : startLog
450
+ logging --> logging : occupancyLevelChanged
451
+ logging --> logWrapping : logFull[ logFullAction==wrap ]
452
+ logging --> stopped : stopLog || logLifeTimeExpired
453
+ logging --> logHalted : logFull[ logFullAction==halt ]
454
+ logWrapping --> logging : stopLog || logLifeTimeExpired
455
+ logWrapping --> stopped : stopLog || logLifeTimeExpired
456
+ logHalted --> logging : logNotFull / notifyLoggingResumed()
457
+ logHalted --> stopped : stopLog || logLifeTimeExpired
458
+ stopped --> [*]
459
+
460
+ ```
461
+
462
+ State diagram for Notification Log showing four states: logging, logWrapping, logHalted, and stopped. Transitions include startLog, occupancyLevelChanged, logFull (wrap/halt), stopLog (lifeTimeExpired), and logNotFull (notifyLoggingResumed).
463
+
464
+ **Figure 5.3: State diagram for Notification Log**
465
+
466
+ The disposition of a log that has been stopped, that is, whether the log remains visible across the Itf-N, is left as vendor specific functionality. The time of the deletion of logs is vendor specific.
467
+
468
+ ### 5.3.3 LogRecord
469
+
470
+ #### 5.3.3.1 Definition
471
+
472
+ The LogRecord IOC is the representation of an individual Notification Log Record.
473
+
474
+ | Attribute name | Support Qualifier | Read Qualifier | Write Qualifier |
475
+ |------------------|-------------------|----------------|-----------------|
476
+ | logRecordId | M | M | – |
477
+ | logRecordContent | O | M | – |
478
+
479
+ ## 5.4 Information relationship definitions
480
+
481
+ ### 5.4.1 Relation-nLIRP-log (M)
482
+
483
+ #### 5.4.1.1 Definition
484
+
485
+ This represents the relationship between `NLIRP` and the `Log`.
486
+
487
+ #### 5.4.1.2 Role
488
+
489
+ | Name | Definition |
490
+ |--------------------|----------------------------------------|
491
+ | <code>nLIRP</code> | It represents the <code>NLIRP</code> . |
492
+ | <code>log</code> | It represents the <code>Log</code> . |
493
+
494
+ #### 5.4.1.3 Constraint
495
+
496
+ | Name | Definition |
497
+ |--------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|
498
+ | <code>uniqueLogSubscriptionId</code> | The log subscription id must be unique amongst all logs managed by a given <code>NLIRP</code> instance. |
499
+ | <code>uniqueLogManagerToken</code> | The log manager token must be unique amongst all managers and logs utilizing logging services from a given <code>NLIRP</code> instance. |
500
+
501
+ ### 5.4.2 Relation-log-logRecord (M)
502
+
503
+ #### 5.4.2.1 Definition
504
+
505
+ This represents the relationship between `Log` and the `LogRecord`.
506
+
507
+ #### 5.4.2.2 Role
508
+
509
+ | Name | Definition |
510
+ |------------------------|--------------------------------------------|
511
+ | <code>log</code> | It represents the <code>Log</code> . |
512
+ | <code>logRecord</code> | It represents the <code>LogRecord</code> . |
513
+
514
+ #### 5.4.2.3 Constraint
515
+
516
+ | Name | Definition |
517
+ |--------------------------------|-------------------------------------------------------------------------------|
518
+ | <code>uniqueLogRecordId</code> | The log record id must be unique amongst all logs records within a given log. |
519
+
520
+ ### 5.4.3 Relation-logRecord-notificationIRPNotification (M)
521
+
522
+ #### 5.4.3.1 Definition
523
+
524
+ This represents the relationship between `LogRecord` and the notification header represented by `NotificationIRPNotification`.
525
+
526
+ #### 5.4.3.2 Role
527
+
528
+ | Name | Definition |
529
+ |---------------------------|--------------------------------------------------------------|
530
+ | <code>logRecord</code> | It represents the <code>LogRecord</code> . |
531
+ | <code>notification</code> | It represents the <code>NotificationIRPNotification</code> . |
532
+
533
+ #### 5.4.3.3 Constraint
534
+
535
+ | Name | Definition |
536
+ |-----------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
537
+ | <code>logRecordIdRelatesNotificationId</code> | Within a given log, there is a one-to-one relationship between <code>Notification Id</code> and <code>Log Id</code> (as each notification can only be recorded once). |
538
+
539
+ ## 5.5 Information attribute definition
540
+
541
+ ### 5.5.1 Definition and legal values
542
+
543
+ | Attribute Name | Definition | Legal Values |
544
+ |------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
545
+ | creationTime | The time when the log is created. | YYYYMMDDhhmmss |
546
+ | currentSize | This attribute provides the number of bytes currently utilized by a given log. When taken in conjunction with maxSize, the amount of space remaining in the log can be determined. | Either:<br><ul style="list-style-type: none"> <li>zero</li> <li>a positive whole number</li> </ul> |
547
+ | filter | It specifies a filter constraint that IRPAgent shall use to filter notification of the category specified in notificationCategories parameter.<br>Support of time based filter is mandatory. Support of other filter constraints is optional. | Filter constraint grammar is SS dependent |
548
+ | logFullAction | Indicate the action that will be taken by this instance of NLIRP when the Log.maxSize has been reached. | An ENUM that can have one of the following values:<br><ul style="list-style-type: none"> <li>wrap: The oldest LogRecord(s) in the Log, based on the log time, will be deleted to free resources for the logging of new LogRecord(s).</li> <li>halt: No more LogRecord(s) will be logged and all incoming events are discarded. LogRecord/s already in the Log will be retained.</li> </ul> |
549
+ | loggingEndTime | Defines the date and time when the log stops logging. | If log is created by IRPManager:<br><ul style="list-style-type: none"> <li>value provided by the IRP Manager - the IRP Agent may reject the value provided by the IRP Manager in case this value is excessive</li> <li>in case no value is provided by the IRP Manager then this value is set by the IRP Agent.</li> </ul><br>If log is created by IRPAgent:<br><ul style="list-style-type: none"> <li>value indicates date and time or</li> <li>value is expressed as "indefinite".</li> </ul> |
550
+ | logManagerToken | This attribute contains the token of a manager utilizing logging services from a given NLIRP instance, assigned by the IRPAgent. | The value of this attribute must be unique amongst all managers and logs utilizing logging services from the given NLIRP instance. |
551
+ | logRecordContent | The notification information of a log record, excluding the notification header information. | The content format varies depending on the type of the notification. |
552
+ | logRecordCount | The number of log records currently logged within a given log. | positive whole number, including zero |
553
+ | logRecordId | This attribute contains the id of a log record within a given log, assigned by the IRPAgent. | The value of this attribute must be unique amongst all log record contained by a given log. |
554
+ | logState | Provides an indication of the current state of a specific log | An ENUM that can have one of the following values:<br><ul style="list-style-type: none"> <li>logging</li> <li>logFull</li> <li>stopped</li> </ul> |
555
+ | logSubscriptionId | This attribute contains the id of a log subscription within a given NLIRP instance, assigned by the IRPAgent. | The value of this attribute must be unique amongst all log subscriptions managed by a given NLIRP instance. |
556
+ | maxLogs | Defines the maximum number of logs that can be supported by a given Notification Log IRP, assigned by the IRPAgent. | Non-zero, positive whole number |
557
+ | maxSize | This attribute defines the maximum number of bytes that may be utilized by a given log, assigned by the IRPAgent. | Either:<br><ul style="list-style-type: none"> <li>Non-zero, positive whole number</li> <li>Zero indicates no limit on the number of records is set by the IRPAgent (log full handling will provide limitation information)</li> </ul> |
558
+ | notificationCategories | Specifies the notification categories that can be recorded within a given log - SET OF (name of IRP, version of IRP) | It identifies one or more Notification Category (see also Definition in clause 3.1) |
559
+ | occupancyLevels | Case Log.logFullAction == 'halt' and Log.maxSize is non-zero:<br><ul style="list-style-type: none"> <li>this attribute contains a list of 3 values fixed (determined by the IRPAgent and never changed) of percentage, of Log.maxLog</li> <li>the NLIRP will generate notifyOccupancyLevelCrossed to alert IRPManagers about the Log capacity currently used.</li> </ul><br>Case Log.logFullAction == 'wrap':<br><ul style="list-style-type: none"> <li>this attribute contains 1 value fixed (determined by the IRPAgent and never changed) of percentage of Log.maxLog</li> <li>the NLIRP will generate notifyOccupancyLevelCrossed to alert IRPManagers that the specified percentage of the capacity has been written to the wrapping Log.</li> </ul> | Case of 'halt': a set of 3 values.<br><br>Case of 'wrap': 1 value. |
560
+
561
+ ### 5.5.2 Constraints
562
+
563
+ | Name | Definition |
564
+ |----------------------|---------------------------------------------------------------|
565
+ | inv_lastModifiedTime | Time indicated shall be greater than or equal to creationTime |
566
+ | inv_logRecordCount | Number indicated shall be less than or equal to maxSize |
567
+
568
+ # 6 Interface definition
569
+
570
+ ## 6.1 Class diagram
571
+
572
+ ![UML Class diagram showing NLIRP class and its interfaces and notifications.](16152cf1d84aea10848758f51a91ff6a_img.jpg)
573
+
574
+ The diagram illustrates the class structure for NLIRP. At the top left is the **NLIRPOperations\_1** interface with methods `subscribeLog()`, `unsubscribeLog()`, `<<optional>> exportLogRecords()`, and `<<optional>> getLogRecords()`. A note above it states: "NLIRPOperations\_1 shall support either operation exportLogRecords or operation getLogRecords as mandatory." Below it is the **NLIRPOperations\_2** interface with methods `getLogSubscriptionIds()` and `getLogSubscriptionStatus()`. The **NLIRP** class (InformationObjectClass) has an attribute `maxLogs` and implements both interfaces. It has a `<<use>>` relationship with the **NLIRPNotifications\_1** notification (methods `notifyLogSubscribed()` and `notifyLogUnsubscribed()`) and a `<<may use>>` relationship with the **NLIRPNotifications\_2** notification (methods `notifyOccupancyLevelCrossed()` and `<<optional>> notifyLoggingResumed()`). The **FileTransferRP** (from TS32.342) and the **NotificationRP** (from TS32.302) are shown as agent-internal usages of the **NLIRP** class.
575
+
576
+ ```
577
+ classDiagram
578
+ class NLIRPOperations_1 {
579
+ <<Interface>>
580
+ subscribeLog()
581
+ unsubscribeLog()
582
+ <<optional>> exportLogRecords()
583
+ <<optional>> getLogRecords()
584
+ }
585
+ class NLIRPOperations_2 {
586
+ <<Interface>>
587
+ getLogSubscriptionIds()
588
+ getLogSubscriptionStatus()
589
+ }
590
+ class NLIRP {
591
+ <<InformationObjectClass>>
592
+ maxLogs
593
+ }
594
+ class NLIRPNotifications_1 {
595
+ <<Notification>>
596
+ notifyLogSubscribed()
597
+ notifyLogUnsubscribed()
598
+ }
599
+ class NLIRPNotifications_2 {
600
+ <<Notification>>
601
+ notifyOccupancyLevelCrossed()
602
+ <<optional>> notifyLoggingResumed()
603
+ }
604
+ class FileTransferRP {
605
+ FileTransferRP (from TS32.342)
606
+ }
607
+ class NotificationRP {
608
+ <<InformationObjectClass>>
609
+ NotificationRP (from TS32.302)
610
+ }
611
+
612
+ NLIRP --|> NLIRPOperations_1
613
+ NLIRP --|> NLIRPOperations_2
614
+ NLIRP --> NLIRPNotifications_1 : <<use>>
615
+ NLIRP --> NLIRPNotifications_2 : <<may use>>
616
+ FileTransferRP --> NLIRP : <<agent-internal-usage>>
617
+ NotificationRP --> NLIRP : <<agent-internal-usage>>
618
+ NotificationRP --> NLIRPNotifications_1 : <<agent-internal-usage>>
619
+ NotificationRP --> NLIRPNotifications_2 : <<agent-internal-usage>>
620
+ ```
621
+
622
+ UML Class diagram showing NLIRP class and its interfaces and notifications.
623
+
624
+ **Figure 6.1: Class diagram**
625
+
626
+ NLIRPOperations\_1 shall support either operation exportLogRecords or operation getLogRecords as mandatory.
627
+
628
+ ## 6.2 Generic rules
629
+
630
+ - Rule 1:** Each operation with at least one input parameter supports a pre-condition `valid_input_parameter` which indicates that all input parameters shall be valid with regards to their information type. Additionally, each such operation supports an exception `operation_failed_invalid_input_parameter` which is raised when pre-condition `valid_input_parameter` is false. The exception has the same entry and exit state.
631
+ - Rule 2:** Each operation with at least one optional input parameter supports a set of pre-conditions `supported_optional_input_parameter_xxx` where "xxx" is the name of the optional input parameter and the pre-condition indicates that the operation supports the named optional input parameter. Additionally, each such operation supports an exception `operation_failed_unsupported_optional_input_parameter_xxx` which is raised when (a) the pre-condition `supported_optional_input_parameter_xxx` is false and (b) the named optional input parameter is carrying information. The exception has the same entry and exit state.
632
+ - Rule 3:** Each operation shall support a generic exception `operation_failed_internal_problem` which is raised when an internal problem occurs and that the operation cannot be completed. The exception has the same entry and exit state.
633
+
634
+ ## 6.3 NLIRPOperations\_1 Interface (M)
635
+
636
+ ### 6.3.1 Operation subscribeLog (M)
637
+
638
+ #### 6.3.1.1 Definition
639
+
640
+ Using this operation, an IRPManager is initiating the logging of notifications. Resulting from this operation an IRPAgent shall start logging of notifications and, if necessary, also create an associated log.
641
+
642
+ #### 6.3.1.2 Input parameters
643
+
644
+ | Parameter Name | Qualifier | Information type | Comment |
645
+ |-------------------------------------|-----------|-------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
646
+ | <code>logSubscriptionId</code> | M | <code>Log.logSubscriptionId</code> | See clause 5.5.1<br>If empty, then IRPAgent shall create a new log and return the <code>logSubscriptionId</code> as output parameter. However not all IRPAgents will provide this capability, i.e. IRPManager must provide an existing <code>logSubscriptionId</code> . |
647
+ | <code>loggingEndTime</code> | O | <code>Log.loggingEndTime</code> | See clause 5.5.1 |
648
+ | <code>notificationCategories</code> | O | <code>Log.notificationCategories</code> | See clause 5.5.1; if <code>notificationCategories</code> is absent than all notifications are logged |
649
+ | <code>filter</code> | O | <code>Log.ntfFilterfilter</code><br>Filter constraint grammar is SS dependent | See clause 5.5.1; if this parameter is absent, then no filter constraint shall be applied. |
650
+
651
+ #### 6.3.1.3 Output parameters
652
+
653
+ | Parameter Name | Qualifier | Matching Information | Comment |
654
+ |-------------------|-----------|-----------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
655
+ | logSubscriptionId | M | Log.logSubscriptionId | See clause 5.5.1<br>This parameter contains either<br><ul style="list-style-type: none"> <li>the logSubscriptionId of the log created resulting from this operation or</li> <li>the value of the input parameter logSubscriptionId.</li> </ul> |
656
+ | logManagerToken | O | Log.logManagerToken | See clause 5.5.1<br>See also comment 6.3.2.2.<br>Note: Security Management IRP may provide capabilities that make this parameter redundant. |
657
+ | loggingEndTime | O | Log.loggingEndTime | See clause 5.5.1<br>If supported by the Log IOC (5.3.2) and not already provided by the IRP Manager then the output of this operation must support this parameter. |
658
+ | status | M | ENUM<br>(OperationSucceeded, OperationFailed) | If loggingEndTime is valid and notificationCategories is valid or absent, status = OperationSucceeded.<br>If operation_failed is true, status = OperationFailed.<br>If loggingEndTime excessive, status = OperationFailed. |
659
+
660
+ #### 6.3.1.4 Pre-condition
661
+
662
+ logsNotMaxed
663
+
664
+ | Assertion Name | Definition |
665
+ |----------------|---------------------------------------------------------------------|
666
+ | logsNotMaxed | The number of logs is less than the maximum number of logs allowed. |
667
+
668
+ #### 6.3.1.5 Post-condition
669
+
670
+ logStarted
671
+
672
+ | Assertion Name | Definition |
673
+ |----------------|--------------------------------------------------------------------------------------------|
674
+ | logStarted | A log is started with the specified characteristics (lifetime and notificationCategories). |
675
+
676
+ #### 6.3.1.6 Exceptions
677
+
678
+ | Exception Name | Definition |
679
+ |----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
680
+ | logSubscriptionId_required | <b>Condition:</b> Pre-condition is true AND post-condition is false.<br><b>Returned Information:</b> The output parameter status.<br><b>Exit state:</b> Entry state. |
681
+ | maxLogs_reached | <b>Condition:</b> Pre-condition is true AND post-condition is false.<br><b>Returned Information:</b> The output parameter status.<br><b>Exit state:</b> Entry state. |
682
+ | operation_failed | <b>Condition:</b> Pre-condition is true AND post-condition is false.<br><b>Returned Information:</b> The output parameter status.<br><b>Exit state:</b> Entry state. |
683
+
684
+ ### 6.3.2 Operation `unsubscribeLog` (M)
685
+
686
+ #### 6.3.2.1 Definition
687
+
688
+ Using this operation, the IRPManager that started a specific log is able to stop this log via unsubscribing. Note stopping a log implies that the log becomes invisible across Itf-N, independent from the `loggingEndTime`; therefore the IRPManager should retrieve log information of interest before using this `unsubscribeLog` operation, e.g. through the `exportLogRecords` operation.
689
+
690
+ The disposition of a log that has been stopped, that is, whether the log remains visible across the Itf-N, is left as vendor specific functionality. The time of the deletion of logs is vendor specific.
691
+
692
+ In consideration of a multi-manager environment, the log can only be stopped by the creating IRPManager if this IRPManager provided a related token while initiating `subscribeLog`.
693
+
694
+ #### 6.3.2.2 Input parameters
695
+
696
+ | Parameter Name | Qualifier | Information type | Comment |
697
+ |--------------------------------|-----------|------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
698
+ | <code>logSubscriptionId</code> | M | <code>Log.logSubscriptionId</code> | See clause 5.5.1 |
699
+ | <code>logManagerToken</code> | O | <code>Log.logManagerToken</code> | See clause 5.5.1<br>If <code>subscribeLog</code> returned a <code>logManagerToken</code> for a log with <code>logSubscriptionId="X"</code> , then <code>logManagerToken</code> must be provided as input parameter of this operation to successfully stop log with <code>logSubscriptionId="X"</code> .<br>If <code>subscribeLog</code> did not return a <code>logManagerToken</code> for a log with <code>logSubscriptionId="X"</code> , then <code>logManagerToken</code> must contain NULL value to successfully stop log with <code>logSubscriptionId="X"</code> . |
700
+
701
+ #### 6.3.2.3 Output parameters
702
+
703
+ | Parameter Name | Qualifier | Matching Information | Comment |
704
+ |---------------------|-----------|-------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
705
+ | <code>status</code> | M | ENUM ( <code>OperationSucceeded</code> , <code>OperationFailed</code> ) | If <code>logSubscriptionId</code> is valid and <code>logManagerToken</code> (if supported) is matching, <code>status = OperationSucceeded</code> .<br>If <code>operation_failed</code> is true, <code>status = OperationFailed</code> . |
706
+
707
+ #### 6.3.2.4 Pre-condition
708
+
709
+ There are no pre-conditions, other than those established by the generic rules (see clause 6.2).
710
+
711
+ #### 6.3.2.5 Post-condition
712
+
713
+ `logStopped`
714
+
715
+ | Assertion Name | Definition |
716
+ |-------------------------|-------------------------------|
717
+ | <code>logStopped</code> | The specified log is stopped. |
718
+
719
+ #### 6.3.2.6 Exceptions
720
+
721
+ | Exception Name | Definition |
722
+ |-------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
723
+ | <code>operation_failed</code> | <b>Condition:</b> Pre-condition is true AND post-condition is false.<br><b>Returned Information:</b> The output parameter <code>status</code> .<br><b>Exit state:</b> Entry state. |
724
+
725
+ ### 6.3.3 Operation `exportLogRecords` (O)
726
+
727
+ Support for this operation is mandatory if `getLogRecords` is not supported.
728
+
729
+ #### 6.3.3.1 Definition
730
+
731
+ Using this operation, an IRPManager can initiate export of all or part of a log into a file. This file then is being transferred to the IRPManager using the File Transfer IRP (note also that the FTIRP is providing the file location to the IRPManager).
732
+
733
+ #### 6.3.3.2 Input parameters
734
+
735
+ | Parameter Name | Qualifier | Information type | Comment |
736
+ |------------------------|-----------|----------------------------|------------------|
737
+ | logSubscriptionId | M | Log.logSubscriptionId | See clause 5.5.1 |
738
+ | notificationCategories | O | Log.notificationCategories | See clause 5.5.1 |
739
+ | filter | O | Log.filterLog.filter | See clause 5.5.1 |
740
+
741
+ #### 6.3.3.3 Output parameters
742
+
743
+ | Parameter Name | Qualifier | Matching Information | Comment |
744
+ |----------------|-----------|----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
745
+ | invocationId | M | -- | <p>This parameter carries an identifier that NLIRP assigns to identify the request if the status is OperationSucceeded. This parameter carries no information if the status is not OperationSucceeded.</p> <p>One identifier can at most identify one request. NLIRP should not reuse identifier values.</p> <p>This identifier shall also appear in the file name of the exported log file as &lt;specificIRP_extension&gt; (as part specified in Appendix A: File Name Convention of [8]).</p> <p>When the exported log file is ready, FTIRP issues notifyFileReady notification which carries the exported log file name.</p> |
746
+
747
+ #### 6.3.3.4 Pre-condition
748
+
749
+ There are no pre-conditions, other than those established by the generic rules (see clause 6.2).
750
+
751
+ #### 6.3.3.5 Post-condition
752
+
753
+ logRecordsExported
754
+
755
+ | Assertion Name | Definition |
756
+ |--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
757
+ | logRecordsExported | The specified log records have been exported as requested. In case the log is empty or in case that all the log records do not satisfy the criteria of input parameters notificationCategories and filter, this post-condition is true. |
758
+
759
+ #### 6.3.3.6 Exceptions
760
+
761
+ | Exception Name | Definition |
762
+ |------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
763
+ | export_failed | The NLIRP was unable to export the specified records. |
764
+ | operation_failed | <b>Condition:</b> Pre-condition is true AND post-condition is false.<br><b>Returned Information:</b> The output parameter status.<br><b>Exit state:</b> Entry state. |
765
+
766
+ ### 6.3.4 Operation getLogRecords (O)
767
+
768
+ Support for these operations is mandatory if exportLogRecords is not supported.
769
+
770
+ #### 6.3.4.1 Definition
771
+
772
+ Using this operation, an IRPManager can retrieve one or more log records from a certain log.
773
+
774
+ Note that this operation might be preferred for retrieval of small amounts of log records, while operation `exportLogRecords` might be preferred for retrieval of medium to large amounts of log records, as providing a more efficient bulk transfer mechanism.
775
+
776
+ #### 6.3.4.2 Input parameters
777
+
778
+ | Parameter Name | Qualifier | Information type | Comment |
779
+ |-------------------------------------|-----------|-----------------------------------------|------------------|
780
+ | <code>logSubscriptionId</code> | M | <code>Log.logSubscriptionId</code> | See clause 5.5.1 |
781
+ | <code>notificationCategories</code> | O | <code>Log.notificationCategories</code> | See clause 5.5.1 |
782
+ | <code>filter</code> | O | <code>Log.filter</code> | See clause 5.5.1 |
783
+
784
+ #### 6.3.4.3 Output parameters
785
+
786
+ | Parameter Name | Qualifier | Matching Information | Comment |
787
+ |----------------------------------|-----------|-------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
788
+ | <code>getLogRecordsResult</code> | M | List of <code>logRecord</code> 's | List of <code>logRecords</code> ; each entry of the list holds all supported attributes of <code>IOC LogRecord</code> (see 5.3.3.2). |
789
+ | <code>status</code> | M | ENUM ( <code>OperationSucceeded</code> , <code>OperationFailed</code> ) | If <code>logSubscriptionId</code> is valid and ( <code>logRecordIdList</code> is empty or <code>logRecordIdList</code> contains valid Id's), <code>status = OperationSucceeded</code> .<br>If <code>operation_failed</code> is true, <code>status = OperationFailed</code> . |
790
+
791
+ #### 6.3.4.4 Pre-condition
792
+
793
+ There are no pre-conditions, other than those established by the generic rules (see clause 6.2).
794
+
795
+ #### 6.3.4.5 Post-condition
796
+
797
+ `logRecordsRetrieved`
798
+
799
+ | Assertion Name | Definition |
800
+ |----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
801
+ | <code>logRecordsRetrieved</code> | The specified log records have been retrieved as requested. If the log is empty or all the log records do not satisfy the criteria of input parameters <code>notificationCategories</code> and <code>filter</code> , this post-condition is true. |
802
+
803
+ #### 6.3.4.6 Exceptions
804
+
805
+ | Exception Name | Definition |
806
+ |-------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
807
+ | <code>operation_failed</code> | <b>Condition:</b> Pre-condition is true AND post-condition is false.<br><b>Returned Information:</b> The output parameter <code>status</code> .<br><b>Exit state:</b> Entry state. |
808
+
809
+ ## 6.4 NLIRPOperations\_2 Interface (O)
810
+
811
+ ### 6.4.1 Operation `getLogSubscriptionIds` (M)
812
+
813
+ #### 6.4.1.1 Definition
814
+
815
+ Using this operation, an `IRPManager` can query the `NLIRP` for all available log subscriptions.
816
+
817
+ #### 6.4.1.2 Input parameters
818
+
819
+ | Parameter Name | Qualifier | Information type | Comment |
820
+ |----------------|-----------|------------------|---------|
821
+ | -- | -- | -- | -- |
822
+
823
+ #### 6.4.1.3 Output parameters
824
+
825
+ | Parameter Name | Qualifier | Matching Information | Comment |
826
+ |--------------------|-----------|--------------------------------------------|--------------------------------------------------------------------------------------------------------------------|
827
+ | logSubscriptionIds | M | List of logSubscriptionId's | See clause 5.5.1 & 6.4.1.2.<br>Note that empty list is a valid value. |
828
+ | status | M | ENUM (OperationSucceeded, OperationFailed) | If operation is successful, status = OperationSucceeded.<br>If operation_failed is true, status = OperationFailed. |
829
+
830
+ #### 6.4.1.4 Pre-condition
831
+
832
+ There are no pre-conditions, other than those established by the generic rules (see clause 6.2).
833
+
834
+ #### 6.4.1.5 Post-condition
835
+
836
+ There are no post-conditions. Querying of log subscription Id's does not result in any changes within the IRP Agent.
837
+
838
+ #### 6.4.1.6 Exceptions
839
+
840
+ | Exception Name | Definition |
841
+ |------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
842
+ | operation_failed | <b>Condition:</b> Pre-condition is true AND post-condition is false.<br><b>Returned Information:</b> The output parameter status.<br><b>Exit state:</b> Entry state. |
843
+
844
+ ### 6.4.2 Operation getLogSubscriptionStatus (M)
845
+
846
+ #### 6.4.2.1 Definition
847
+
848
+ Using this operation, an IRPManager can query the NLIRP for available log status information of an individual log.
849
+
850
+ #### 6.4.2.2 Input parameters
851
+
852
+ | Parameter Name | Qualifier | Information type | Comment |
853
+ |-------------------|-----------|-----------------------|------------------|
854
+ | logSubscriptionId | M | Log.logSubscriptionId | See clause 5.5.1 |
855
+
856
+ #### 6.4.2.3 Output parameters
857
+
858
+ | Parameter Name | Qualifier | Matching Information | Comment |
859
+ |------------------|-----------|------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------|
860
+ | logAttributeList | M | Attributes of related Log IOC except logManagerToken | List of all supported attributes of IOC Log except logManagerToken (see clause 5.3.2.2). |
861
+ | status | M | ENUM (OperationSucceeded, OperationFailed) | If logSubscriptionId is valid status = OperationSucceeded.<br>If operation_failed is true, status = OperationFailed. |
862
+
863
+ #### 6.4.2.4 Pre-condition
864
+
865
+ There are no pre-conditions, other than those established by the generic rules (see clause 6.2).
866
+
867
+ #### 6.4.2.5 Post-condition
868
+
869
+ There are no post-conditions. Querying of log attributes does not result in any changes within the IRPAgent.
870
+
871
+ #### 6.4.2.6 Exceptions
872
+
873
+ | Exception Name | Definition |
874
+ |------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
875
+ | operation_failed | <b>Condition:</b> Pre-condition is true AND post-condition is false.<br><b>Returned Information:</b> The output parameter status.<br><b>Exit state:</b> Entry state. |
876
+
877
+ ## 6.5 NLIRPNotifications\_1 Interface (M)
878
+
879
+ ### 6.5.1 Notification notifyLogSubscribed (M)
880
+
881
+ #### 6.5.1.1 Definition
882
+
883
+ Using this notification, an IRP Agent informs all subscribed IRP Managers that a log subscription has been successfully initiated.
884
+
885
+ #### 6.5.1.2 Input Parameters
886
+
887
+ | Parameter Name | Qualifier | Matching Information | Comment |
888
+ |------------------------|-----------|----------------------------|---------------------------------------------------------------------|
889
+ | objectClass | M,Y | Log.objectClass | Notification header - see [3]. It shall carry the Log class name. |
890
+ | objectInstance | M,Y | Log.objectInstance | Notification header - see [3]. It shall carry the DN of Log. |
891
+ | notificationId | M,N | -- | Notification header - see [3]. |
892
+ | eventTime | M,Y | -- | Notification header - see [3]. |
893
+ | notificationType | M,Y | "notifyLogSubscribed" | Notification header - see [3]. |
894
+ | systemDN | C,Y | -- | Notification header - see [3]. |
895
+ | logSubscriptionId | M,N | Log.logSubscriptionId | See clause 5.5.1 |
896
+ | loggingEndTime | O,N | Log.loggingEndTime | See clause 5.5.1 |
897
+ | notificationCategories | O,N | Log.notificationCategories | See clause 5.5.1; if absent than all notifications are being logged |
898
+ | filter | O,N | Log.filter | See clause 5.5.1 |
899
+
900
+ #### 6.5.1.3 Triggering Event
901
+
902
+ ##### 6.5.1.3.1 From-state
903
+
904
+ subscribeLog
905
+
906
+ | Assertion Name | Definition |
907
+ |----------------|----------------------------------------------------|
908
+ | subscribeLog | An IRP Manager requests that a new log be started. |
909
+
910
+ ##### 6.5.1.3.2 To-state
911
+
912
+ logStarted
913
+
914
+ | Assertion Name | Definition |
915
+ |----------------|-------------------------------------------------------|
916
+ | logStarted | The NLIRP has started the requested logging activity. |
917
+
918
+ ### 6.5.2 Notification `notifyLogUnsubscribed` (M)
919
+
920
+ #### 6.5.2.1 Definition
921
+
922
+ Using this notification, an IRP Agent informs all subscribed IRP Manager that a log subscription has stopped.
923
+
924
+ #### 6.5.2.2 Input Parameters
925
+
926
+ | Parameter Name | Qualifier | Matching Information | Comment |
927
+ |--------------------------------|-----------|----------------------------------------|--------------------|
928
+ | <code>objectClass</code> | M,Y | <code>Log.objectClass</code> | See table 6.5.1.2. |
929
+ | <code>objectInstance</code> | M,Y | <code>Log.objectInstance</code> | See table 6.5.1.2. |
930
+ | <code>notificationId</code> | M,N | -- | See table 6.5.1.2. |
931
+ | <code>eventTime</code> | M,Y | -- | See table 6.5.1.2. |
932
+ | <code>notificationType</code> | M,Y | " <code>notifyLogUnsubscribed</code> " | See table 6.5.1.2. |
933
+ | <code>systemDN</code> | C,Y | --. | See table 6.5.1.2. |
934
+ | <code>logSubscriptionId</code> | M,N | <code>Log.logSubscriptionId</code> | See table 6.5.1.2. |
935
+
936
+ #### 6.5.2.3 Triggering Event
937
+
938
+ ##### 6.5.2.3.1 From-state
939
+
940
+ `unsubscribeLog` OR `loggingEndTimeReached`
941
+
942
+ | Assertion Name | Definition |
943
+ |------------------------------------|-------------------------------------------------------------------------------------------|
944
+ | <code>unsubscribeLog</code> | The IRP Manager that started the log requests that the log be unsubscribed. |
945
+ | <code>loggingEndTimeReached</code> | The logging end time specified for the log in <code>subscribeLog</code> has been reached. |
946
+
947
+ ##### 6.5.2.3.2 To-state
948
+
949
+ `logStopped`
950
+
951
+ | Assertion Name | Definition |
952
+ |-------------------------|-----------------------------------|
953
+ | <code>logStopped</code> | The logging activity has stopped. |
954
+
955
+ ## 6.6 NLIRPNotifications\_2 Interface (O)
956
+
957
+ ### 6.6.1 Notification notifyOccupancyLevelCrossed (M)
958
+
959
+ #### 6.6.1.1 Definition
960
+
961
+ Using this notification, an IRP Agent informs all subscribed IRP Managers about the occupancy level of a certain log according with levels defined in 5.5.1 (in addition also the log full action type of this NLIRP instance is being provided for context purposes).
962
+
963
+ #### 6.6.1.2 Input Parameters
964
+
965
+ | Parameter Name | Qualifier | Matching Information | Comment |
966
+ |-----------------------|-----------|--------------------------------------------------------------------------------|--------------------|
967
+ | objectClass | M,Y | Log.objectClass | See table 6.5.1.2. |
968
+ | objectInstance | M,Y | Log.objectInstance | See table 6.5.1.2. |
969
+ | notificationId | M,N | -- | See table 6.5.1.2. |
970
+ | eventTime | M,Y | -- | See table 6.5.1.2. |
971
+ | notificationType | M,Y | "notifyOccupancyLevelCrossed" | See table 6.5.1.2. |
972
+ | systemDN | C,Y | -- | See table 6.5.1.2. |
973
+ | logSubscriptionId | M,Y | Log.logSubscriptionId | See table 6.5.1.2. |
974
+ | currentOccupancyLevel | M,N | The integer portion of $((\text{Log.currentSize} / \text{Log.maxSize}) * 100)$ | See clause 5.5.1. |
975
+ | logFullAction | O,N | Log.logFullAction | See clause 5.5.1. |
976
+
977
+ #### 6.6.1.3 Triggering Event
978
+
979
+ ##### 6.6.1.3.1 From-state
980
+
981
+ logFull OR occupancyLevelCrossed
982
+
983
+ | Assertion Name | Definition |
984
+ |-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
985
+ | logFull | The log is full, that is, the number of log records contained within the log has exceeded the maximum number of log records that was established at log startup (log capacity has reached 100 %). |
986
+ | occupancyLevelCrossed | The number of log records within the log has crossed one of the threshold boundaries (see 5.5.1 Log.occupancyLevels). |
987
+
988
+ ##### 6.6.1.3.2 To-state
989
+
990
+ logWrapping OR (logHalted OR logging)
991
+
992
+ | Assertion Name | Definition |
993
+ |----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
994
+ | logWrapping | Applicable for case Log.logFullAction='wrap': The number of log records within the log has exceeded the maximum number of allowed log records (100 % capacity has been crossed). The logging of new records will cause the oldest records within the log to be deleted and replaced (first in, first out). The deletion of records may occur in a block, such that the log transitions back to the "started" state prior to any new records being written. |
995
+ | logHalted | Applicable for case Log.logFullAction='halt': The number of log records within the log has exceeded the maximum number of allowed log records (100 % capacity has been crossed). The logging of new records will be discontinued until the deletion of records has occurred (deletion of records is outside the scope of this IRP). |
996
+ | logging | Applicable for case Log.logFullAction='halt': The number of log records within the log is below the maximum number of allowed records. The generation of the notification is done to inform the subscribed IRP Managers that the log is filling up. |
997
+
998
+ ### 6.6.2 Notification notifyLoggingResumed (O)
999
+
1000
+ #### 6.6.2.1 Definition
1001
+
1002
+ Using this notification, an IRP Agent informs all subscribed IRP Managers that the amount of data within a given log has been reduced, allowing logging to resume continue (according to the information provided when the log was created). Note that this notification only applies to Log.logFullAction == 'halt'.
1003
+
1004
+ #### 6.6.2.2 Input Parameters
1005
+
1006
+ | Parameter Name | Qualifier | Matching Information | Comment |
1007
+ |-------------------|-----------|------------------------|--------------------|
1008
+ | objectClass | M,Y | Log.objectClass | See table 6.5.1.2. |
1009
+ | objectInstance | M,Y | Log.objectInstance | See table 6.5.1.2. |
1010
+ | notificationId | M,N | -- | See table 6.5.1.2. |
1011
+ | eventTime | M,Y | -- | See table 6.5.1.2. |
1012
+ | notificationType | M,Y | "notifyLoggingResumed" | See table 6.5.1.2. |
1013
+ | systemDN | C,Y | -- | See table 6.5.1.2. |
1014
+ | logSubscriptionId | M,Y | Log.logSubscriptionId | See table 6.5.1.2. |
1015
+
1016
+ #### 6.6.2.3 Triggering Event
1017
+
1018
+ ##### 6.6.2.3.1 From-state
1019
+
1020
+ logFull
1021
+
1022
+ | Assertion Name | Definition |
1023
+ |-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
1024
+ | logHalted | The log is full, that is, the number of log records contained within the log has exceeded the maximum number of log records that was established at log startup (log capacity has reached 100 % and Log.logFullAction='halt'). |
1025
+ | occupancyLevelCrossed | The number of log records within the log has crossed one of the threshold boundaries (see 5.5.1 Log.occupancyLevels). |
1026
+
1027
+ ##### 6.6.2.3.2 To-state
1028
+
1029
+ | Assertion Name | Definition |
1030
+ |----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
1031
+ | logging | The number of log records within the log is below the maximum number of allowed records. The generation of the notification is done to inform the subscribed IRP Managers that the log is filling up. |
1032
+
1033
+ # Annex A (informative): Change history
1034
+
1035
+ | Change history | | | | | | | | |
1036
+ |----------------|-------|-----------|------|-----|--------------------------------------------------------------------------------------------------------------------|-----|-------|--------|
1037
+ | Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Cat | Old | New |
1038
+ | Mar 2004 | S_23 | SP-040123 | -- | -- | Submitted to SA#23 for Information | -- | 1.0.0 | |
1039
+ | Dec 2004 | S_26 | SP-040798 | -- | -- | Submitted to SA#26 for Approval | -- | 2.0.0 | 6.0.0 |
1040
+ | Jun 2005 | S_28 | SP-050290 | 0001 | -- | Correct mapping info of currentOccupancyLevel and some editorial errors | F | 6.0.0 | 6.1.0 |
1041
+ | Jun 2005 | S_28 | SP-050329 | 0002 | -- | Apply Generic System Context – Align with TS 32.150 | F | 6.0.0 | 6.1.0 |
1042
+ | Mar 2006 | SA_31 | SP-060091 | 0003 | -- | Add invocationId output parameter of exportLogRecords operation | F | 6.1.0 | 6.2.0 |
1043
+ | Mar 2006 | SA_31 | SP-060089 | 0004 | -- | Correct ambiguity of object class and object instance usage in notification | F | 6.1.0 | 6.2.0 |
1044
+ | Dec 2006 | SA_34 | SP-060709 | 0005 | -- | Correct the errors in the definition of occupancyLevels and currentOccupancyLevel | F | 6.2.0 | 6.3.0 |
1045
+ | Jun 2007 | SA_36 | -- | -- | -- | Automatic upgrade to Rel-7 (no CR) at freeze of Rel-7. Deleted reference to CMIP SS, discontinued from R7 onwards. | -- | 6.3.0 | 7.0.0 |
1046
+ | Sep 2007 | SA_37 | SP-070614 | 0006 | -- | Remove the use of visibility symbol | C | 7.0.0 | 8.0.0 |
1047
+ | Dec 2009 | - | - | - | - | Update to Rel-9 version (MCC) | - | 8.0.0 | 9.0.0 |
1048
+ | Mar 2011 | - | - | - | - | Update to Rel-10 version (MCC) | - | 9.0.0 | 10.0.0 |
1049
+
marked/Rel-10/32_series/32336/raw.md ADDED
The diff for this file is too large to render. See raw diff
 
marked/Rel-10/32_series/32341/raw.md ADDED
@@ -0,0 +1,249 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+ # **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; File Transfer (FT) Integration Reference Point (IRP); Requirements (Release 10)**
4
+
5
+ ![3GPP logo](935eed7aa61f7777f62cfc032e11bee9_img.jpg)
6
+
7
+ ---
8
+
9
+ The 3GPP logo, featuring the letters '3GPP' in a stylized, bold font. The '3' is black, 'G' is black, 'P' is black, and 'P' is black. There is a small red signal icon below the 'G'.
10
+
11
+ 3GPP logo
12
+
13
+ Keywords
14
+ UMTS, management, FT
15
+
16
+ ## **3GPP**
17
+
18
+ Postal address
19
+
20
+ ---
21
+
22
+ 3GPP support office address
23
+
24
+ ---
25
+
26
+ 650 Route des Lucioles - Sophia Antipolis
27
+ Valbonne - FRANCE
28
+ Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
29
+
30
+ Internet
31
+
32
+ ---
33
+
34
+ <http://www.3gpp.org>
35
+
36
+ ## **Copyright Notification**
37
+
38
+ No part may be reproduced except as authorized by written permission.
39
+ The copyright and the foregoing restriction extend to reproduction in all media.
40
+
41
+ © 2011, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TTA, TTC).
42
+ All rights reserved.
43
+
44
+ UMTS™ is a Trade Mark of ETSI registered for the benefit of its members
45
+ 3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
46
+ LTE™ is a Trade Mark of ETSI currently being registered for the benefit of its Members and of the 3GPP Organizational Partners
47
+ GSM® and the GSM logo are registered and owned by the GSM Association
48
+
49
+ # --- Contents
50
+
51
+ | | |
52
+ |-------------------------------------------------------------|---|
53
+ | Foreword ..... | 4 |
54
+ | Introduction ..... | 4 |
55
+ | 1 Scope..... | 5 |
56
+ | 2 References..... | 5 |
57
+ | 3 Definitions and abbreviations ..... | 5 |
58
+ | 3.1 Definitions..... | 5 |
59
+ | 3.2 Abbreviations ..... | 6 |
60
+ | 4 File Transfer IRP concept ..... | 6 |
61
+ | 5 File Transfer IRP requirements..... | 6 |
62
+ | 5.1 General requirements for File Transfer IRP..... | 6 |
63
+ | 5.2 File type requirements ..... | 7 |
64
+ | 5.3 File exchange requirements..... | 7 |
65
+ | 5.4 File management/maintenance/security requirements ..... | 7 |
66
+ | 6 Overview of IRP's related to File Transfer (FT)..... | 8 |
67
+ | Annex A (informative): Change history..... | 9 |
68
+
69
+ # --- Foreword
70
+
71
+ This Technical Specification (TS) has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP).
72
+
73
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
74
+
75
+ Version x.y.z
76
+
77
+ where:
78
+
79
+ - x the first digit:
80
+ - 1 presented to TSG for information;
81
+ - 2 presented to TSG for approval;
82
+ - 3 or greater indicates TSG approved document under change control.
83
+ - y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
84
+ - z the third digit is incremented when editorial only changes have been incorporated in the document.
85
+
86
+ # --- Introduction
87
+
88
+ The present document is part the 32.34x-series covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below:
89
+
90
+ - 32.341: "File Transfer (FT) Integration Reference Point (IRP): Requirements"**
91
+ - 32.342: "File Transfer (FT) Integration Reference Point (IRP): Information Service (IS)"
92
+ - 32.346: "File Transfer (FT) Integration Reference Point (IRP); Solution Set (SS) definitions"
93
+
94
+ The Itf-N interface is built up by a number of Integration Reference Points (IRP's) and a related Name Convention, which realize the functional capabilities over this interface. The basic structure of the IRP's is defined in 3GPP TS 32.101 [1] and 3GPP TS 32.102 [2].
95
+
96
+ Network Elements (NEs) under management, element managers as well as network managers generate various management information stored in file format. This IRP is addressing how these file are exchanged through Itf-N as well as certain aspects of file management and maintenance. It is anticipated that all management functions (e.g. PM, Call Trace, CM) as well as associated IRP's making reuse of capabilities provided by this File Transfer IRP.
97
+
98
+ # --- 1 Scope
99
+
100
+ The present document specifies the overall requirements for the File Transfer Integration Reference Point (FT IRP) as it applies to the Itf-N.
101
+
102
+ # --- 2 References
103
+
104
+ The following documents contain provisions that, through reference in this text, constitute provisions of the present document.
105
+
106
+ - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
107
+ - For a specific reference, subsequent revisions do not apply.
108
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document *in the same Release as the present document*.
109
+
110
+ - [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements".
111
+ - [2] 3GPP TS 32.102: "Telecommunication management; Architecture".
112
+ - [3] 3GPP TS 32.111-series: "Telecommunication management; Fault Management; Alarm Integration Reference Point (IRP)".
113
+ - [4] 3GPP TS 32.30x-series: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP)".
114
+ - [5] 3GPP TS 32.33x-series: "Telecommunication management; Notification log Integration Reference Point (IRP)".
115
+ - [6] 3GPP TS 32.32x-series: "Telecommunication management; Test management Integration Reference Point (IRP)".
116
+ - [7] 3GPP TS 32.401: "Telecommunication management; Performance Management (PM); Concept and requirements".
117
+ - [8] 3GPP TS 32.41x-series: "Telecommunication management; Performance Management (PM) Integration Reference Point (IRP)".
118
+ - [9] 3GPP TS 32.421: "Telecommunication management; Subscriber and equipment trace: Trace concepts and requirements".
119
+ - [10] 3GPP TS 32.61x-series: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP)".
120
+ - [11] 3GPP TS 32.240: "Telecommunication management; Charging management; Charging architecture and principles".
121
+
122
+ # --- 3 Definitions and abbreviations
123
+
124
+ ## 3.1 Definitions
125
+
126
+ For the purposes of the present document, the terms and definitions given in 3GPP TS 32.101 [1] and 3GPP TS 32.102 [2] apply.
127
+
128
+ ## 3.2 Abbreviations
129
+
130
+ For the purposes of the present document, the following abbreviations apply:
131
+
132
+ | | |
133
+ |------|-------------------------------|
134
+ | CM | Configuration Management |
135
+ | EM | Element Manager |
136
+ | FT | File Transfer |
137
+ | FTP | File Transfer Protocol |
138
+ | IRP | Integration Reference Point |
139
+ | NE | Network Element |
140
+ | NM | Network Manager |
141
+ | PM | Performance Management |
142
+ | SFTP | Secure File Transfer Protocol |
143
+
144
+ # --- 4 File Transfer IRP concept
145
+
146
+ Network Elements (NEs) under management, element managers as well as network managers generate various management information that is stored in files. This IRP is addressing how these file are exchanged through Itf-N as well as certain aspects of file management and maintenance. It is anticipated that all management functions (e.g. PM, Call Trace, CM) as well as associated IRP's making reuse of capabilities provided by this File Transfer IRP.
147
+
148
+ It should be noted that this File Transfer IRP is not defining a file transfer protocol (applicable file transfer protocols are defined by 3GPP TS 32.101 [1]) but will make reuse of generic concepts defined by these file transfer protocol.
149
+
150
+ # --- 5 File Transfer IRP requirements
151
+
152
+ ## 5.1 General requirements for File Transfer IRP
153
+
154
+ The FT IRP shall ensure preservation of file content:
155
+
156
+ - The used file transfer protocol implementation shall preserve the formatting of the file during exchange.
157
+ - The used file transfer protocol implementation shall preserve the encoding of the file during exchange.
158
+
159
+ NOTE 1: Above requirement(s) are considered as being satisfied by FTP.
160
+
161
+ The FT IRP shall support the following file transfer protocols:
162
+
163
+ - FTP.
164
+ - SFTP
165
+
166
+ NOTE 2: SFTP providing initial security capabilities, which may be complemented by additional security features that might be added in future versions of the present document.
167
+
168
+ The FT IRP shall specify all necessary descriptive file information and parameters, to enable exchange of files between IRPManager and IRPAgent and to ensure respective file management capabilities (such as listing).
169
+
170
+ File Name conventions:
171
+
172
+ - In the context of this File Transfer IRP an overall applicable file name convention should be specified, ensuring the use of meaningful and uniform names of files generated by various IRP's. This convention should reuse the current PM File Naming Conventions to the greatest extent possible [7].
173
+ - This file name convention should address issues with potential Operating System based changes in file names during or after file exchange (e.g. upper case / lower case).
174
+ - The file name shall contain the file expiration date
175
+
176
+ ## 5.2 File type requirements
177
+
178
+ The FT IRP shall support the exchange and management/maintenance of the following file types:
179
+
180
+ - Performance measurement results as defined in [7] and [8].
181
+ - Test results as defined in [6].
182
+ - Bulk CM files as defined in [10].
183
+ - Call trace records as defined in [9].
184
+ - Notification log as defined in [5].
185
+ - Charging files as defined in [11].
186
+ - Vendor-specific files containing management information.
187
+
188
+ Subsequently this File Transfer IRP shall consider requirements from management applications listed above.
189
+
190
+ Future 3GPP management information file types shall be supported as well (e.g. inventory information).
191
+
192
+ ## 5.3 File exchange requirements
193
+
194
+ The IRP Manager shall be able to:
195
+
196
+ - Upload (read) one or more files from the IRP Agent using FTP or SFTP;
197
+ - Download (write) one or more files to the IRP Agent using FTP or SFTP, and indicate to the IRP Agent that files have been downloaded.
198
+
199
+ Subsequently: the IRP Manager will always act as the initiator (client) of file transfer actions, while the IRP Agent shall provide the corresponding server capabilities.
200
+
201
+ This IRP Agent should provide the following notifications to the IRP Manager:
202
+
203
+ - "File Ready", indicating that a file is ready for upload;
204
+ - "File Preparation Error", indicating that an error occurred during or before file preparation and that no file is being made available related to a specific request;
205
+ - "File Deleted", indicating that a file has been made unavailable for access through Itf-N.
206
+
207
+ ## 5.4 File management/maintenance/security requirements
208
+
209
+ The IRP Manager should be able to request the IRP Agent to:
210
+
211
+ - Provide a list of available files, based on file name and file creation date/time filter criteria.
212
+
213
+ In addition the following requirements should be considered:
214
+
215
+ - Security mechanisms supported by applicable file transfer protocols defined in [1] should be supported (e.g. username, password, encryption).
216
+ - File system overload mechanism on IRP Agent side (e.g. automatic deletion of transmitted files, automatic deletion of outdated files, emission of notifications in case of automatic deletion).
217
+ - File deletion is determined by a file expiration date, which is part of the file name.
218
+
219
+ # --- 6 Overview of IRP's related to File Transfer (FT)
220
+
221
+ Itf-N is built up by a number of IRP's. The basic structure of the IRP's is defined in 3GPP TS 32.101 [1] and 3GPP TS 32.102 [2].
222
+
223
+ For the purpose of the File Transfer IRP the following IRP's are needed:
224
+
225
+ - Notification IRP [4].
226
+
227
+ The following IRP/specifications shall consider using this FT IRP for file transfer purposes (future IRP or IRP capabilities not listed here shall also consider reuse of this FT IRP for file transfer purposes):
228
+
229
+ - Performance measurement results as defined in [7] and [8].
230
+ - Test results as defined in [6].
231
+ - Bulk CM files as defined in [10].
232
+ - Call trace records as defined in [9].
233
+ - Notification log exports as defined in [5].
234
+
235
+ Specification changes needed by those IRP's to make reuse of the FT IRP are outside the scope of the present document.
236
+
237
+ # Annex A (informative): Change history
238
+
239
+ | Change history | | | | | | | | | |
240
+ |----------------|-------|-----------|------|-----|--------------------------------------------------------------------------------------------------------------------|---------|-------|--------|--|
241
+ | Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Ca<br>t | Old | New | |
242
+ | Jun 2003 | SA_20 | SP-030295 | -- | -- | Submitted to TSG SA#20 for information | -- | 1.0.0 | | |
243
+ | Mar 2004 | SA_23 | SP-040124 | -- | -- | Submitted to TSG SA#23 for Approval | -- | 2.0.0 | 6.0.0 | |
244
+ | Mar 2005 | SA_27 | SP-050037 | 0001 | -- | Add file type requirements - Align with FTIRP IS in TS 32.342 | F | 6.0.0 | 6.1.0 | |
245
+ | Sep 2006 | SA_33 | SP-060530 | 0002 | -- | Correct the file exchange requirements in File Transfer (FT) Integration Reference Point (IRP) | F | 6.1.0 | 6.2.0 | |
246
+ | Jun 2007 | SA_36 | -- | -- | -- | Automatic upgrade to Rel-7 (no CR) at freeze of Rel-7. Deleted reference to CMIP SS, discontinued from R7 onwards. | -- | 6.2.0 | 7.0.0 | |
247
+ | Mar 2009 | SA_43 | SP-090207 | 0003 | -- | Include reference to SOAP Solution Set specification | D | 7.0.0 | 8.0.0 | |
248
+ | 2009-12 | - | - | - | - | Update to Rel-9 version (MCC) | - | 8.0.0 | 9.0.0 | |
249
+ | 2011-03 | - | - | - | - | Update to Rel-10 version (MCC) | - | 9.0.0 | 10.0.0 | |
marked/Rel-10/32_series/32342/raw.md ADDED
@@ -0,0 +1,715 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
+
3
+ # **3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; 3GPP TS 32.342 V10.0.0 (2011-03) Telecommunication management; File Transfer (FT) Technical Specification Integration Reference Point (IRP); Information Service (IS) (Release 10)** ---
4
+
5
+ ![3GPP logo with TM symbol](935eed7aa61f7777f62cfc032e11bee9_img.jpg)
6
+
7
+ The 3GPP logo, featuring the letters '3GPP' in a stylized, bold, black font. The '3' is slightly larger and positioned to the left of the 'G', 'P', and 'P'. A small 'TM' symbol is located to the upper right of the 'P'.
8
+
9
+ 3GPP logo with TM symbol
10
+
11
+ Keywords
12
+ GSM, UMTS, management
13
+
14
+ ## **3GPP**
15
+
16
+ Postal address
17
+
18
+ ---
19
+
20
+ 3GPP support office address
21
+
22
+ ---
23
+
24
+ 650 Route des Lucioles - Sophia Antipolis
25
+ Valbonne - FRANCE
26
+ Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
27
+
28
+ Internet
29
+
30
+ ---
31
+
32
+ <http://www.3gpp.org>
33
+
34
+ ## **Copyright Notification**
35
+
36
+ No part may be reproduced except as authorized by written permission.
37
+ The copyright and the foregoing restriction extend to reproduction in all media.
38
+
39
+ © 2011, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TTA, TTC).
40
+ All rights reserved.
41
+
42
+ UMTS™ is a Trade Mark of ETSI registered for the benefit of its members
43
+ 3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
44
+ LTE™ is a Trade Mark of ETSI currently being registered for the benefit of its Members and of the 3GPP Organizational Partners
45
+ GSM® and the GSM logo are registered and owned by the GSM Association
46
+
47
+ # Contents
48
+
49
+ | | |
50
+ |----------------------------------------------------------|----|
51
+ | Foreword ..... | 5 |
52
+ | Introduction ..... | 5 |
53
+ | 1 Scope..... | 6 |
54
+ | 2 References..... | 6 |
55
+ | 3 Definitions and abbreviations ..... | 7 |
56
+ | 3.1 Definitions..... | 7 |
57
+ | 3.2 Abbreviations ..... | 7 |
58
+ | 4 System Overview ..... | 8 |
59
+ | 4.1 System context ..... | 8 |
60
+ | 4.2 Compliance rules..... | 8 |
61
+ | 5 Information Object Classes (IOC) ..... | 9 |
62
+ | 5.1 Information entities imported and local labels..... | 9 |
63
+ | 5.2 Class Diagram ..... | 9 |
64
+ | 5.2.1 Attributes and relationships..... | 9 |
65
+ | 5.2.2 Inheritance ..... | 10 |
66
+ | 5.3 Information Object Class (IOC) definitions..... | 11 |
67
+ | 5.3.1 FileTransferIRP ..... | 11 |
68
+ | 5.3.1.1 Definition ..... | 11 |
69
+ | 5.3.2 AvailableFileDescriptor ..... | 11 |
70
+ | 5.3.2.1 Definition ..... | 11 |
71
+ | 5.3.2.2 Attributes ..... | 11 |
72
+ | 5.3.3 AvailableFileList ..... | 11 |
73
+ | 5.3.3.1 Definition ..... | 11 |
74
+ | 5.3.4 File..... | 11 |
75
+ | 5.3.4.1 Definition ..... | 11 |
76
+ | 5.4 Information relationship definitions..... | 12 |
77
+ | 5.4.1 relation-flIRP-availableFileList (M) ..... | 12 |
78
+ | 5.4.1.1 Definition ..... | 12 |
79
+ | 5.4.1.2 Role..... | 12 |
80
+ | 5.4.2 relation-availableFileList-availableFiles (M)..... | 12 |
81
+ | 5.4.2.1 Definition ..... | 12 |
82
+ | 5.4.2.2 Role..... | 12 |
83
+ | 5.4.2.3 Constraint..... | 12 |
84
+ | 5.4.3 relation-availableFileDescriptor-file (M) ..... | 12 |
85
+ | 5.4.3.1 Definition ..... | 12 |
86
+ | 5.4.3.2 Role..... | 12 |
87
+ | 5.5 Information attribute definition..... | 13 |
88
+ | 5.5.1 Definition and legal values..... | 13 |
89
+ | 6 Interface Definition ..... | 14 |
90
+ | 6.1 Class diagram..... | 14 |
91
+ | 6.2 Generic rules ..... | 14 |
92
+ | 6.3 FileTransferIRPOperations_1 Interface ..... | 15 |
93
+ | 6.3.1 Operation listAvailableFiles (M)..... | 15 |
94
+ | 6.3.1.1 Definition ..... | 15 |
95
+ | 6.3.1.2 Input parameters ..... | 15 |
96
+ | 6.3.1.3 Output parameters..... | 15 |
97
+ | 6.3.1.4 Pre-condition..... | 15 |
98
+ | 6.3.1.5 Post-condition ..... | 15 |
99
+ | 6.3.1.6 Exceptions..... | 16 |
100
+ | 6.4 FileTransferIRPOperations_2 Interface ..... | 16 |
101
+ | 6.4.1 Operation fileDownloadIndication (O) ..... | 16 |
102
+ | 6.4.1.1 Definition ..... | 16 |
103
+ | 6.4.1.2 Input parameters ..... | 16 |
104
+ | 6.4.1.3 Output parameters..... | 16 |
105
+
106
+ | | | |
107
+ |-----------------------------|---------------------------------------------------|-----------|
108
+ | 6.4.1.4 | Pre-condition..... | 16 |
109
+ | 6.4.1.5 | Post-condition ..... | 16 |
110
+ | 6.4.1.6 | Exceptions..... | 16 |
111
+ | 6.5 | FileTransferIRPNotifications_1 Interface..... | 17 |
112
+ | 6.5.1 | Notification notifyFileReady (M)..... | 17 |
113
+ | 6.5.1.1 | Definition ..... | 17 |
114
+ | 6.5.1.2 | Input Parameters ..... | 17 |
115
+ | 6.5.1.3 | Triggering Event ..... | 17 |
116
+ | 6.5.1.3.1 | From-state..... | 17 |
117
+ | 6.5.1.3.2 | To-state..... | 17 |
118
+ | 6.5.2 | Notification notifyFilePreparationError (M) ..... | 18 |
119
+ | 6.5.2.1 | Definition ..... | 18 |
120
+ | 6.5.2.2 | Input Parameters ..... | 18 |
121
+ | 6.5.2.3 | Triggering Event ..... | 18 |
122
+ | 6.5.2.3.1 | From-state..... | 18 |
123
+ | 6.5.2.3.2 | To-state..... | 18 |
124
+ | <b>Annex A (normative):</b> | <b>File Naming Convention .....</b> | <b>19</b> |
125
+ | Annex B (informative): | Change history..... | 20 |
126
+
127
+ # --- Foreword
128
+
129
+ This Technical Specification (TS) has been produced by the 3<sup>rd</sup> Generation Partnership Project (3GPP).
130
+
131
+ The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows:
132
+
133
+ Version x.y.z
134
+
135
+ where:
136
+
137
+ - x the first digit:
138
+ - 1 presented to TSG for information;
139
+ - 2 presented to TSG for approval;
140
+ - 3 or greater indicates TSG approved document under change control.
141
+ - y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc.
142
+ - z the third digit is incremented when editorial only changes have been incorporated in the document.
143
+
144
+ # --- Introduction
145
+
146
+ The present document is part of a TS-family covering the 3<sup>rd</sup> Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management, as identified below:
147
+
148
+ - 32.341: "File Transfer (FT) Integration Reference Point (IRP): Requirements"
149
+ - 32.342: "File Transfer (FT) Integration Reference Point (IRP): Information Service (IS)"**
150
+ - 32.346: "File Transfer (FT) Integration Reference Point (IRP); Solution Set (SS) definitions"
151
+
152
+ The present document is part of a TS-family which describe the requirements and information model necessary for the Telecommunication Management (TM) of 3G systems. The TM principles and TM architecture are specified in 3GPP TS 32.101 [1] and 3GPP TS 32.102 [2].
153
+
154
+ Network Elements (NEs) under management, element managers as well as network managers generate various management information stored in file format. This IRP is addressing how these files are exchanged through Itf-N as well as certain aspects of file management and maintenance. It is anticipated that all management functions (e.g. PM, Call Trace, CM) as well as associated IRPs making reuse of capabilities provided by this File Transfer IRP.
155
+
156
+ # --- 1 Scope
157
+
158
+ The present document specifies the Information Service for the File Transfer Integration Reference Point (FileTransferIRP) as it applies to the Itf-N.
159
+
160
+ The present document defines the semantics of operations (and their parameters) visible across the Itf-N in a protocol and technology neutral way. It does not define the syntax or encoding of the operations and their parameters.
161
+
162
+ # --- 2 References
163
+
164
+ The following documents contain provisions, which through reference in this text constitute provisions of the present document.
165
+
166
+ - References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific.
167
+ - For a specific reference, subsequent revisions do not apply.
168
+ - For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document in the same Release as the present document.
169
+
170
+ - [1] 3GPP TS 32.101: "Telecommunication management; Principles and high level requirements".
171
+ - [2] 3GPP TS 32.102: "Telecommunication management; Architecture".
172
+ - [3] 3GPP TS 32.111-2: "Telecommunication management; Fault management; Part 2: Alarm Integration Reference Point (IRP): Information Service (IS)".
173
+ - [4] 3GPP TS 32.302: "Telecommunication management; Configuration Management (CM); Notification Integration Reference Point (IRP): Information Service (IS)".
174
+ - [5] 3GPP TS 32.312: "Telecommunication management; Generic Integration Reference Point (IRP): Information Service (IS)".
175
+ - [6] 3GPP TS 32.321: "Telecommunication management; Test management Integration Reference Point (IRP): Requirements".
176
+ 3GPP TS 32.322: "Telecommunication management; Test management Integration Reference Point (IRP): Information Service (IS)".
177
+ 3GPP TS 32.323: "Telecommunication management; Test management Integration Reference Point (IRP): Common Object Request Broker Architecture (CORBA) Solution Set (SS)".
178
+ 3GPP TS 32.325: "Telecommunication management; Test management Integration Reference Point (IRP); eXtensible Markup Language (XML) definitions".
179
+ - [7] 3GPP TS 32.341 "Telecommunication management; File Transfer (FT) Integration Reference Point (IRP): Requirements".
180
+ - [8] 3GPP TS 32.411: "Telecommunication management; Performance Management (PM) Integration Reference Point (IRP): Requirements".
181
+ 3GPP TS 32.412: "Telecommunication management; Performance Management (PM) Integration Reference Point (IRP): Information Service (IS)".
182
+ 3GPP TS 32.413: "Telecommunication management; Performance Management (PM) Integration Reference Point (IRP): Common Object Request Broker Architecture (CORBA) Solution Set (SS)".
183
+ 3GPP TS 32.415 Telecommunication management; Performance Management (PM) Integration Reference Point (IRP); eXtensible Markup Language (XML) definitions".
184
+
185
+ - [9] 3GPP TS 32.421: "Telecommunication Management; Subscriber and Equipment Trace: Trace Concepts and Requirements".
186
+
187
+ - [10] 3GPP TS 32.611: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP): Requirements".
188
+ - 3GPP TS 32.612: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP): Information Service (IS) ".
189
+ - 3GPP TS 32.613: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP): Common Object Request Broker Architecture (CORBA) Solution Set (SS)".
190
+ - 3GPP TS 32.615: "Telecommunication management; Configuration Management (CM); Bulk CM Integration Reference Point (IRP): eXtensible Markup Language (XML) file format definition".
191
+
192
+ - [11] 3GPP TS 32.331: "Telecommunication management; Notification Log (NL) Integration Reference Point (IRP): Requirements".
193
+ - 3GPP TS 32.332: "Telecommunication management; Notification Log (NL) Integration Reference Point (IRP): Information Service (IS)".
194
+ - 3GPP TS 32.333: "Telecommunication management; Notification Log (NL) Integration Reference Point (IRP): Common Object Request Broker Architecture (CORBA) Solution Set (SS)".
195
+ - 3GPP TS 32.335: "Telecommunication management; Notification Log (NL) Integration Reference Point (IRP): eXtensible Markup Language (XML) solution definitions".
196
+
197
+ - [12] 3GPP TS 32.622: "Telecommunication management; Configuration Management (CM); Generic network resources Integration Reference Point (IRP): Network Resource Model (NRM)".
198
+
199
+ - [13] 3GPP TS 32.240: "Telecommunication management; Charging management; Charging architecture and principles".
200
+
201
+ - [14] 3GPP TS 32.150: "Telecommunication management; Integration Reference Point (IRP) Concept and definitions".
202
+
203
+ # --- 3 Definitions and abbreviations
204
+
205
+ ## 3.1 Definitions
206
+
207
+ For the purposes of the present document, the terms and definitions defined in 3GPP TS 32.101 [1], TS 32.102 [2] and TS 32.341 [7] apply.
208
+
209
+ ## 3.2 Abbreviations
210
+
211
+ For the purposes of the present document, the following abbreviations apply:
212
+
213
+ | | |
214
+ |-----|-----------------------------|
215
+ | CM | Configuration Management |
216
+ | EM | Element Manager |
217
+ | IOC | Information Object Class |
218
+ | IRP | Integration Reference Point |
219
+ | NE | Network Element |
220
+ | PM | Performance Management |
221
+ | UML | Unified Modelling Language |
222
+
223
+ # 4 System Overview
224
+
225
+ ## 4.1 System context
226
+
227
+ The general definition of the System Context for the present IRP is found in 3GPP TS 32.150 [14] subclause 4.7.
228
+
229
+ In addition, the set of related IRP(s) relevant to the present IRP is shown in the two diagrams below.
230
+
231
+ ![Figure 4.1: System Context A](07b17a620c75522d53916a11e12d1bff_img.jpg)
232
+
233
+ Diagram illustrating System Context A. It shows an IRPManager (NM) connected to an IRPAgent (EM), which is connected to NEs. A dashed vertical line labeled 'Itf-N' separates the NM and EM. Below the Itf-N line, a list of IRPs is shown: Notification IRP and File Transfer IRP.
234
+
235
+ Figure 4.1: System Context A
236
+
237
+ Figure 4.1: System Context A
238
+
239
+ ![Figure 4.2: System Context B](731f533b0599c8e42a063f06e4332045_img.jpg)
240
+
241
+ Diagram illustrating System Context B. It shows an IRPManager (NM) connected to an IRPAgent (NE), which is connected to NEs. A dashed vertical line labeled 'Itf-N' separates the NM and NE. Below the Itf-N line, a list of IRPs is shown: Notification IRP and File Transfer IRP.
242
+
243
+ Figure 4.2: System Context B
244
+
245
+ Figure 4.2: System Context B
246
+
247
+ ## 4.2 Compliance rules
248
+
249
+ For general definitions of compliance rules related to qualifiers (Mandatory/Optional/Conditional) for *operations, notifications and parameters* (of operations and notifications) please refer to 3GPP TS 32.150 [14].
250
+
251
+ # 5 Information Object Classes (IOC)
252
+
253
+ ## 5.1 Information entities imported and local labels
254
+
255
+ | Label reference | Local label |
256
+ |------------------------------------------------------------------------------|-------------------|
257
+ | 3GPP TS 32.622 [12], information object class, <code>Top</code> | Top |
258
+ | 3GPP TS 32.622 [12], information object class, <code>IRPAgent</code> | IRPAgent |
259
+ | 3GPP TS 32.622 [12], information object class, <code>GenericIRP</code> | GenericIRP |
260
+ | 3GPP TS 32.312 [5], information object class, <code>ManagedGenericIRP</code> | ManagedGenericIRP |
261
+ | 3GPP TS 32.302 [4], information object class, <code>NotificationIRP</code> | NotificationIRP |
262
+
263
+ ## 5.2 Class Diagram
264
+
265
+ ### 5.2.1 Attributes and relationships
266
+
267
+ This clause introduces the set of information object classes (IOCs) that encapsulate information within the `IRPAgent`. The intent is to identify the information required for the FileTransferIRP Agent implementation of its operations and notification emission. This clause provides the overview of all support object classes in UML. Subsequent clauses provide more detailed specification of various aspects of these support object classes.
268
+
269
+ ![UML Class Diagram showing Information Object Classes (IOCs) and their relationships including ManagedGenericIRP, FileTransferIRP, AvailableFileList, AvailableFileDescriptor, and File.](b28af4985cdef1e519e3aaf26561dcb3_img.jpg)
270
+
271
+ ```
272
+
273
+ classDiagram
274
+ class ManagedGenericIRP["<<Information Object Class>>\nManagedGenericIRP\n(from TS 32.312)"]
275
+ class FileTransferIRP["<<Information Object Class>>\nFileTransferIRP"]
276
+ class AvailableFileList["<<Information Object Class>>\nAvailableFileList"]
277
+ class AvailableFileDescriptor["<<Information Object Class>>\nAvailableFileDescriptor\n+ fileSize\n+ fileCompression\n+ fileReadyTime\n+ fileExpirationTime\n+ fileFormat\n+ fileLocation\n+ managementDataType"]
278
+ class File["<<proxy Object>>\nFile"]
279
+
280
+ ManagedGenericIRP <|-- FileTransferIRP
281
+ FileTransferIRP "1" *-- "1" AvailableFileList : relation-ftIRP-availableFileList
282
+ AvailableFileList "1" *-- "0..n" AvailableFileDescriptor : relation-availableFileList-availableFiles
283
+ AvailableFileDescriptor "1" -- "1" File : relation-availableFileDescriptor-file
284
+
285
+ note for FileTransferIRP "+theFileTransferIRP"
286
+ note for AvailableFileList "+theAvailableFileList"
287
+ note for AvailableFileDescriptor "+theAvailableFileDescriptor"
288
+ note for File "+theFile"
289
+
290
+ ```
291
+
292
+ The diagram illustrates the following classes and relationships:
293
+
294
+ - ManagedGenericIRP** (Information Object Class, from TS 32.312) is the base class for **FileTransferIRP**.
295
+ - FileTransferIRP** (Information Object Class) has a composition relationship with **AvailableFileList** (Information Object Class) labeled *relation-ftIRP-availableFileList*. The multiplicity is 1 at both ends. Role names are `+theFileTransferIRP` and `+theAvailableFileList`.
296
+ - AvailableFileList** (Information Object Class) has a composition relationship with **AvailableFileDescriptor** (Information Object Class) labeled *relation-availableFileList-availableFiles*. The multiplicity is 1 at the list end and 0..n at the descriptor end. Role names are `+theAvailableFileList` and `+theAvailableFileDescriptor`.
297
+ - AvailableFileDescriptor** (Information Object Class) contains attributes: `+ fileSize`, `+ fileCompression`, `+ fileReadyTime`, `+ fileExpirationTime`, `+ fileFormat`, `+ fileLocation`, and `+ managementDataType`. It has an association with **File** (proxy Object) labeled *relation-availableFileDescriptor-file*. The multiplicity is 1 at both ends. Role names are `+theAvailableFileDescriptor` and `+theFile`.
298
+
299
+ UML Class Diagram showing Information Object Classes (IOCs) and their relationships including ManagedGenericIRP, FileTransferIRP, AvailableFileList, AvailableFileDescriptor, and File.
300
+
301
+ Figure 5.1: Information Object Class (IOC) UML Diagram
302
+
303
+ ### 5.2.2 Inheritance
304
+
305
+ ![UML Class Diagram showing Information Object Class (IOC) inheritance. At the top is the class '<<Information Object Class>> Top (from TS 32.622)'. Three classes inherit directly from Top: '<<Information Object Class>> AvailableFileDescriptor' (containing attributes: + fileSize, + fileCompression, + fileReadyTime, + fileExpirationTime, + fileFormat, + fileLocation, + managementDataType), '<<Information Object Class>> GenericRP (from TS 32.622)', and '<<Information Object Class>> AvailableFileList'. Below GenericRP, '<<Information Object Class>> ManagedGenericRP (from TS 32.312)' inherits from it. Finally, '<<Information Object Class>> FileTransferRP' inherits from ManagedGenericRP.](daa4a6fa7e2ba1954258f86b4928eb32_img.jpg)
306
+
307
+ ```
308
+ classDiagram
309
+ class Top["<<Information Object Class>>\nTop\n(from TS 32.622)"]
310
+ class AvailableFileDescriptor["<<Information Object Class>>\nAvailableFileDescriptor"]
311
+ AvailableFileDescriptor : + fileSize
312
+ AvailableFileDescriptor : + fileCompression
313
+ AvailableFileDescriptor : + fileReadyTime
314
+ AvailableFileDescriptor : + fileExpirationTime
315
+ AvailableFileDescriptor : + fileFormat
316
+ AvailableFileDescriptor : + fileLocation
317
+ AvailableFileDescriptor : + managementDataType
318
+ class GenericRP["<<Information Object Class>>\nGenericRP\n(from TS 32.622)"]
319
+ class AvailableFileList["<<Information Object Class>>\nAvailableFileList"]
320
+ class ManagedGenericRP["<<Information Object Class>>\nManagedGenericRP\n(from TS 32.312)"]
321
+ class FileTransferRP["<<Information Object Class>>\nFileTransferRP"]
322
+
323
+ Top <|-- AvailableFileDescriptor
324
+ Top <|-- GenericRP
325
+ Top <|-- AvailableFileList
326
+ GenericRP <|-- ManagedGenericRP
327
+ ManagedGenericRP <|-- FileTransferRP
328
+ ```
329
+
330
+ UML Class Diagram showing Information Object Class (IOC) inheritance. At the top is the class '<> Top (from TS 32.622)'. Three classes inherit directly from Top: '<> AvailableFileDescriptor' (containing attributes: + fileSize, + fileCompression, + fileReadyTime, + fileExpirationTime, + fileFormat, + fileLocation, + managementDataType), '<> GenericRP (from TS 32.622)', and '<> AvailableFileList'. Below GenericRP, '<> ManagedGenericRP (from TS 32.312)' inherits from it. Finally, '<> FileTransferRP' inherits from ManagedGenericRP.
331
+
332
+ Figure 5.2: Information Object Class (IOC) Inheritance UML Diagram
333
+
334
+ ## 5.3 Information Object Class (IOC) definitions
335
+
336
+ ### 5.3.1 FileTransferIRP
337
+
338
+ #### 5.3.1.1 Definition
339
+
340
+ FileTransferIRP is the representation of the file transfer management capabilities specified by the present document. This IOC inherits from `ManagedGenericIRP` IOC specified in 3GPP TS 32.312 [5].
341
+
342
+ ### 5.3.2 AvailableFileDescriptor
343
+
344
+ #### 5.3.2.1 Definition
345
+
346
+ `AvailableFileDescriptor` represents the information about an existing closed file containing management data (performance measurement data, etc.). The file is ready for retrieval by IRPManagers.
347
+
348
+ #### 5.3.2.2 Attributes
349
+
350
+ | <b>Attribute name</b> | <b>Visibility</b> | <b>Support Qualifier</b> | <b>Read Qualifier</b> | <b>Write Qualifier</b> |
351
+ |---------------------------------|-------------------|--------------------------|-----------------------|------------------------|
352
+ | <code>managementDataType</code> | + | M | M | - |
353
+ | <code>fileSize</code> | + | M | M | - |
354
+ | <code>fileCompression</code> | + | M | M | - |
355
+ | <code>fileReadyTime</code> | + | M | M | - |
356
+ | <code>fileExpirationTime</code> | + | M | M | - |
357
+ | <code>fileFormat</code> | + | M | M | - |
358
+ | <code>fileLocation</code> | + | M | M | - |
359
+
360
+ ### 5.3.3 AvailableFileList
361
+
362
+ #### 5.3.3.1 Definition
363
+
364
+ `AvailableFileList` is the representation of a list of files represented by individual `AvailableFileDescriptor(s)`.
365
+
366
+ ### 5.3.4 File
367
+
368
+ #### 5.3.4.1 Definition
369
+
370
+ The Proxy Object File represents the file stored in the managed system.
371
+
372
+ ## 5.4 Information relationship definitions
373
+
374
+ ### 5.4.1 relation-ftIRP-availableFileList (M)
375
+
376
+ #### 5.4.1.1 Definition
377
+
378
+ This represents the relationship between `FileTransferIRP` and `AvailableFileList`.
379
+
380
+ #### 5.4.1.2 Role
381
+
382
+ | Name | Definition |
383
+ |-----------------------------------|----------------------------------------------------|
384
+ | <code>theAvailableFileList</code> | It represents the <code>AvailableFileList</code> . |
385
+ | <code>theFileTransferIRP</code> | It represents the <code>FileTransferIRP</code> . |
386
+
387
+ ### 5.4.2 relation-availableFileList-availableFiles (M)
388
+
389
+ #### 5.4.2.1 Definition
390
+
391
+ This represents the relationship between `AvailableFileDescriptor` and `AvailableFileList`.
392
+
393
+ #### 5.4.2.2 Role
394
+
395
+ | Name | Definition |
396
+ |-----------------------------------------|----------------------------------------------------------|
397
+ | <code>theAvailableFileDescriptor</code> | It represents the <code>AvailableFileDescriptor</code> . |
398
+ | <code>theAvailableFileList</code> | It represents the <code>AvailableFileList</code> . |
399
+
400
+ #### 5.4.2.3 Constraint
401
+
402
+ | Name | Definition |
403
+ |---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
404
+ | <code>uniqueFileLocation</code> | The <code>fileLocation</code> , playing the role of the file within the same <code>FileTransferIRP</code> , must be unique among all <code>AvailableFileDescriptors</code> . |
405
+
406
+ ### 5.4.3 relation-availableFileDescriptor-file (M)
407
+
408
+ #### 5.4.3.1 Definition
409
+
410
+ This represents the relationship between `AvailableFileDescriptor` and `PhysicalFile`.
411
+
412
+ #### 5.4.3.2 Role
413
+
414
+ | Name | Definition |
415
+ |-----------------------------------------|----------------------------------------------------------|
416
+ | <code>theAvailableFileDescriptor</code> | It represents the <code>AvailableFileDescriptor</code> . |
417
+ | <code>theAvailableFile</code> | It represents the <code>PhysicalFile</code> . |
418
+
419
+ ## 5.5 Information attribute definition
420
+
421
+ ### 5.5.1 Definition and legal values
422
+
423
+ | Attribute Name | Definition | Legal Values |
424
+ |--------------------|---------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
425
+ | fileSize | It identifies the size of the file. | Its value is positive Integer (the unit is byte). |
426
+ | fileCompression | It identifies the name of the compression algorithm used for the file. | An empty fileCompression means that there is no compression on the file. Choice of compression algorithm is vendor-specific but is encouraged to use industrial standard algorithm such as GZIP. |
427
+ | fileReadyTime | It identifies the date and time when the file was last closed and made available for upload and the file content will not be changed | All values that indicate valid time. |
428
+ | fileExpirationTime | It identifies the date and time beyond which the file may be deleted. | All values that indicate valid time.<br>It should be later than fileReadyTime.<br>It shall not be empty. |
429
+ | fileFormat | It identifies the encoding technique used by the file. | Its value should indicate the IRPVersion of the file format specification plus to indicate if "ASN1" or "XML-schema" is used. |
430
+ | fileLocation | It identifies the location of the file described by AvailableFileDescriptor in the IRPAgent. The location may be a directory path or a URL. | <ul style="list-style-type: none"> <li>Any valid file directory path.</li> <li>Any valid URL.</li> </ul> E.g.:<br>“\\202.112.101.1\D:\user\performanceFiles\<xxx>” or<br>“ <a href="http://nms.telecom.org.com/datastore/&lt;xxx&gt;">http://nms.telecom.org.com/datastore/&lt;xxx&gt;</a> ”<br>where <xxx> is the filename and the file naming convention is defined in Annex A File Naming Convention. |
431
+ | managementDataType | It identifies the type of the management data in the file. | "CG" for charging files (TS 32.240 [13]),<br>"CM" for configuration files (except inventory) (Bulk CM IRP TS 32.61x [10]),<br>"CT" for call trace files (Subscriber and Equipment Trace TS 32.421 [9]),<br>"IM" for inventory files,<br>"NL" for notification log files (Notification Log IRP TS 32.33x [11]),<br>"OT" for other files,<br>"PM" for performance data files (Performance Management IRP TS 32.41x [8]),<br>"TE" for test files (Test Management IRP TS 32.32x [6]). |
432
+
433
+ # 6 Interface Definition
434
+
435
+ ## 6.1 Class diagram
436
+
437
+ ![UML Class Diagram showing FileTransferIRP as an InformationObjectClass. It has three associations: 1) A generalization/specialization relationship with FileTransferIRPOperations_1 (Interface) labeled '<<may realize>>'. 2) A generalization/specialization relationship with FileTransferIRPOperations_2 (Interface) labeled '<<may realize>>'. 3) A directed association with FileTransferIRPNotifications_1 (Notification) labeled '<<use>>'. FileTransferIRPOperations_1 has an operation + listAvailableFiles(). FileTransferIRPNotifications_1 has operations + notifyFileReady() and + notifyFilePreparationError(). FileTransferIRPNotifications_1 has a directed association with NotificationIRP (InformationObjectClass, from TS 32.302) labeled '<<agent-internal-usage>>'.](a26e142d3df5bef41a84a9dd099d7825_img.jpg)
438
+
439
+ ```
440
+
441
+ classDiagram
442
+ class FileTransferIRP {
443
+ <<InformationObjectClass>>
444
+ }
445
+ class FileTransferIRPOperations_1 {
446
+ <<Interface>>
447
+ +listAvailableFiles()
448
+ }
449
+ class FileTransferIRPOperations_2 {
450
+ <<Interface>>
451
+ +fileDownloadIndication()
452
+ }
453
+ class FileTransferIRPNotifications_1 {
454
+ <<Notification>>
455
+ +notifyFileReady()
456
+ +notifyFilePreparationError()
457
+ }
458
+ class NotificationIRP {
459
+ <<InformationObjectClass>>
460
+ (from TS 32.302)
461
+ }
462
+
463
+ FileTransferIRP --> FileTransferIRPOperations_1 : <<may realize>>
464
+ FileTransferIRP --> FileTransferIRPOperations_2 : <<may realize>>
465
+ FileTransferIRP --> FileTransferIRPNotifications_1 : <<use>>
466
+ FileTransferIRPNotifications_1 --> NotificationIRP : <<agent-internal-usage>>
467
+
468
+ ```
469
+
470
+ UML Class Diagram showing FileTransferIRP as an InformationObjectClass. It has three associations: 1) A generalization/specialization relationship with FileTransferIRPOperations\_1 (Interface) labeled '<>'. 2) A generalization/specialization relationship with FileTransferIRPOperations\_2 (Interface) labeled '<>'. 3) A directed association with FileTransferIRPNotifications\_1 (Notification) labeled '<>'. FileTransferIRPOperations\_1 has an operation + listAvailableFiles(). FileTransferIRPNotifications\_1 has operations + notifyFileReady() and + notifyFilePreparationError(). FileTransferIRPNotifications\_1 has a directed association with NotificationIRP (InformationObjectClass, from TS 32.302) labeled '<>'.
471
+
472
+ Figure 6.1: Class Diagram
473
+
474
+ ## 6.2 Generic rules
475
+
476
+ - **Rule 1:** each operation with at least one input parameter supports a pre-condition `valid_input_parameter` which indicates that all input parameters shall be valid with regards to their information type. Additionally, each such operation supports an exception `operation_failed_invalid_input_parameter` which is raised when pre-condition `valid_input_parameter` is false. The exception has the same entry and exit state.
477
+ - **Rule 2:** each operation with at least one optional input parameter supports a set of pre-conditions `supported_optional_input_parameter_xxx` where "xxx" is the name of the optional input parameter and the pre-condition indicates that the operation supports the named optional input parameter. Additionally, each such operation supports an exception `operation_failed_unsupported_optional_input_parameter_xxx` which is raised when (a) the pre-condition `supported_optional_input_parameter_xxx` is false and (b) the named optional input parameter is carrying information. The exception has the same entry and exit state.
478
+ - **Rule 3:** each operation shall support a generic exception `operation_failed_internal_problem` which is raised when an internal problem occurs and that the operation cannot be completed. The exception has the same entry and exit state.
479
+
480
+ ## 6.3 FileTransferIRPOperations\_1 Interface
481
+
482
+ ### 6.3.1 Operation listAvailableFiles (M)
483
+
484
+ #### 6.3.1.1 Definition
485
+
486
+ This operation allows IRPManager to list all or specified available management data files stored in the IRPAgent.
487
+
488
+ A Solution Set may choose to split this operation in several operations (e.g. operations to get "iterator" which fulfil the criteria and other operations to retrieve the detailed information of the files from the "iterator").
489
+
490
+ #### 6.3.1.2 Input parameters
491
+
492
+ | Parameter Name | Qualifier | Information type | Comment |
493
+ |---------------------------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|
494
+ | <code>managementDataType</code> | M | AvailableFileDescriptor.<br>managementDataType | It specifies the type of the management data stored in the file. |
495
+ | <code>beginTime</code> | M | The IRPManager wants a list of the available file(s) whose ready time(s) are later or equal to this time.<br>This parameter is expressed in UTC time. | This parameter indicates date and time. If this parameter is empty, no beginTime-restriction should be applied on the ready time. |
496
+ | <code>endTime</code> | M | The IRPManager wants to list information about the available file(s) whose ready time(s) are earlier than this time.<br>This parameter is expressed in UTC time. | This parameter indicates date and time. If this parameter is empty, no endTime-restriction should be applied on the ready time. |
497
+
498
+ #### 6.3.1.3 Output parameters
499
+
500
+ | Parameter Name | Qualifie<br>r | Matching Information | Comment |
501
+ |---------------------------|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------|
502
+ | <code>fileInfoList</code> | M | LIST of STRUCT <<br>AvailableFileDescriptor.fileLocation,<br>AvailableFileDescriptor.fileSize<br>AvailableFileDescriptor.fileReadyTime<br>AvailableFileDescriptor.fileExpirationTime<br>AvailableFileDescriptor.fileCompression,<br>AvailableFileDescriptor.fileFormat,<br>> | The output parameter specifies the required file information. |
503
+ | <code>status</code> | M | ENUM (Success, Failure) | |
504
+
505
+ #### 6.3.1.4 Pre-condition
506
+
507
+ validTimes
508
+
509
+ | Assertion Name | Definition |
510
+ |-------------------------|--------------------------------------------------------------------------------------------------|
511
+ | <code>validTimes</code> | The beginTime is before the invocation time of the operation and the endTime is after beginTime. |
512
+
513
+ #### 6.3.1.5 Post-condition
514
+
515
+ requiredFileInfoIsReturned
516
+
517
+ | Assertion Name | Definition |
518
+ |-----------------------------------------|--------------------------------------------|
519
+ | <code>requiredFileInfoIsReturned</code> | The required file information is returned. |
520
+
521
+ #### 6.3.1.6 Exceptions
522
+
523
+ | Exception Name | Definition |
524
+ |---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
525
+ | <code>invalidTimes</code> | <b>Condition:</b> (validTimes) not verified.<br><b>Returned information:</b> output parameter status is set to Failure.<br><b>Exit state:</b> Entry State. |
526
+
527
+ ## 6.4 FileTransferIRPOperations\_2 Interface
528
+
529
+ ### 6.4.1 Operation fileDownloadIndication (O)
530
+
531
+ #### 6.4.1.1 Definition
532
+
533
+ This operation allows IRPManager to indicate IRPAgent about completion of the file exchange procedure and related file descriptive information when IRPManager finish downloading one or more files to IRPAgent.
534
+
535
+ #### 6.4.1.2 Input parameters
536
+
537
+ | Parameter Name | Qualifier | Information type | Comment |
538
+ |----------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|
539
+ | fileInfoList | M | LIST of STRUCT <<br>AvailableFileDescriptor.fileLocation,<br>AvailableFileDescriptor.fileSize<br>AvailableFileDescriptor.fileReadyTime<br>AvailableFileDescriptor.fileExpirationTime<br>AvailableFileDescriptor.fileCompression,<br>AvailableFileDescriptor.fileFormat,<br>> | It carries the information of the files downloaded to the IRPAgent. |
540
+
541
+ #### 6.4.1.3 Output parameters
542
+
543
+ | Parameter Name | Qualifier | Matching Information | Comment |
544
+ |----------------|-----------|-------------------------|---------|
545
+ | status | M | ENUM (Success, Failure) | |
546
+
547
+ #### 6.4.1.4 Pre-condition
548
+
549
+ validFileInfoList
550
+
551
+ | Assertion Name | Definition |
552
+ |-------------------|----------------------------|
553
+ | validFileInfoList | The fileInfoList is valid. |
554
+
555
+ #### 6.4.1.5 Post-condition
556
+
557
+ validFileSize
558
+
559
+ | Assertion Name | Definition |
560
+ |----------------|--------------------------------------------------------------------|
561
+ | validFileSize | The downloaded file exist and the size of it is greater than zero. |
562
+
563
+ #### 6.4.1.6 Exceptions
564
+
565
+ | Exception Name | Definition |
566
+ |---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|
567
+ | InvalidFileInfoList | <b>Condition:</b> (validFileInfoList) not verified.<br><b>Returned information:</b> output parameter status is set to Failure.<br><b>Exit state:</b> Entry State. |
568
+
569
+ ## 6.5 FileTransferIRPNotifications\_1 Interface
570
+
571
+ ### 6.5.1 Notification notifyFileReady (M)
572
+
573
+ #### 6.5.1.1 Definition
574
+
575
+ After the management data files have been prepared ready in the IRPAgent, IRPAgent will emit notification to subscribed IRPManager(s) to notify the availability of the file(s).
576
+
577
+ #### 6.5.1.2 Input Parameters
578
+
579
+ | Parameter Name | Qualifier | Matching Information | Comment |
580
+ |------------------|-----------|-------------------------------------------------------------------------|---------------------------------------------------------------------------|
581
+ | objectClass | M, Y | FTIRP.objectClass | Notification header - see [4]. It shall carry the FTIRP class name. |
582
+ | objectInstance | M, Y | FTIRP.objectInstance | Notification header - see [4]. It shall carry the DN of the FTIRP. |
583
+ | notificationId | M, N | -- | Notification header - see [4]. |
584
+ | eventTime | M, Y | -- | Notification header - see [4]. |
585
+ | systemDN | C, Y | -- | Notification header - see [4]. |
586
+ | notificationType | M, Y | "notifyFileReady " | Notification header - see [4]. |
587
+ | fileInfoList | M, N | See clause 6.3.1.3 (output parameters of listAvailableFiles operation). | It specifies the information of the available file. |
588
+ | additionalText | O, N | String | It carries vendor-specific semantics not defined in the present document. |
589
+
590
+ #### 6.5.1.3 Triggering Event
591
+
592
+ ##### 6.5.1.3.1 From-state
593
+
594
+ *filesAreReadyAndClosed*
595
+
596
+ | Assertion Name | Definition |
597
+ |------------------------|---------------------------------------------------------------------------------------------------------|
598
+ | filesAreReadyAndClosed | IRP Agent has stored the result data into one or more files which corresponds to management operations. |
599
+
600
+ ##### 6.5.1.3.2 To-state
601
+
602
+ *newNotificationReported*
603
+
604
+ | Assertion Name | Definition |
605
+ |-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
606
+ | newNotificationReported | The 'notifyFileReady ' notification is emitted to the subscribed IRP Manager(s). Based on the information contained in the notification, the IRP Manager can get the file(s) through file transfer mechanism. |
607
+
608
+ ### 6.5.2 Notification notifyFilePreparationError (M)
609
+
610
+ #### 6.5.2.1 Definition
611
+
612
+ The subscribed IRPManagers are notified regarding the occurrence of an error during the preparation of the file. This notification is an event and will not be treated as alarms defined in Alarm IRP IS (3GPP TS 32.111-2 [3]).
613
+
614
+ #### 6.5.2.2 Input Parameters
615
+
616
+ | Parameter Name | Qualifier | Matching Information | Comment |
617
+ |------------------|-----------|-------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
618
+ | objectClass | M, Y | FTIRP.objectClass | See Table 6.5.1.2. |
619
+ | objectInstance | M, Y | FTIRP.objectInstance | See Table 6.5.1.2. |
620
+ | notificationId | M, N | -- | See Table 6.5.1.2. |
621
+ | eventTime | M, Y | -- | See Table 6.5.1.2. |
622
+ | systemDN | C, Y | -- | See Table 6.5.1.2. |
623
+ | notificationType | M, Y | "notifyFilePreparationError" | See Table 6.5.1.2. |
624
+ | fileInfoList | M, N | See clause 6.3.1.3 (output parameters of listAvailableFiles operation). | If file is kept, this parameter Identifies the file whose preparation provoked an error. If file is not generated, this parameter is empty. |
625
+ | reason | M, N | -- | The detailed reason is given, including<br>- errorInPreparation<br>- hardDiskFull<br>- hardDiskFailure<br>- tooManyFiles<br>- collectionTimeOut<br>- incompleteTruncatedFile<br>- corruptedFile<br>- lowMemory<br>- dataNotAvailable |
626
+ | additionalText | O, N | -- | See Table 6.5.1.2. |
627
+
628
+ #### 6.5.2.3 Triggering Event
629
+
630
+ ##### 6.5.2.3.1 From-state
631
+
632
+ *errorInPreparation OR hardDiskFull OR hardDiskFailure OR tooManyFiles OR collectionTimeOut OR incompleteTruncatedFile OR corruptedFile OR lowMemory OR dataNotAvailable*
633
+
634
+ | Assertion Name | Definition |
635
+ |-------------------------|--------------------------------------------------------------------------------------------|
636
+ | errorInPreparation | There is unspecified error when IRPAgent prepares the files. |
637
+ | hardDiskFull | The file system is full and no more files can be opened. |
638
+ | hardDiskFailure | The hard disk has failed and normal input/output cannot be performed. |
639
+ | tooManyFiles | The file system lacks resource to open a new file to capture management data. |
640
+ | collectionTimeOut | The collection time of management data into files takes too long. |
641
+ | incompleteTruncatedFile | The file is truncated for unspecified reason. The suspect flag should be set in the files. |
642
+ | corruptedFile | The file is corrupted for unspecified reason. The suspect flag should be set in the files. |
643
+ | lowMemory | The system lacks sufficient memory to open a new file to capture management data. |
644
+ | dataNotAvailable | Management data is not available when the collected management object(s) is being read. |
645
+
646
+ ##### 6.5.2.3.2 To-state
647
+
648
+ *fileIsKept OR fileNotGenerated*
649
+
650
+ | Assertion Name | Definition |
651
+ |------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
652
+ | fileIsKept | The file, whose preparation provokes an error, is kept. And the file naming convention, expiration date, available to be listed, etc. should be treated the same as and be consistent with case when file is prepared successful. |
653
+ | fileNotGenerated | No file was generated and fileInfoList indicates "no file". |
654
+
655
+ # Annex A (normative): File Naming Convention
656
+
657
+ The following convention shall be applied for file naming:
658
+
659
+ <managementData\_type><file\_ready\_date><file\_ready\_time><file\_expiration\_delta\_time>
660
+ [<specificIRP\_extension>][<separator><RC>]
661
+
662
+ - 1) The managementData\_type field is the type of the management data contained in the file, the value of managementData\_type field including
663
+
664
+ "PM" for performance data files,
665
+
666
+ "CM" for configuration files (except inventory),
667
+
668
+ "IM" for inventory files,
669
+
670
+ "TE" for test files,
671
+
672
+ "CT" for call trace files,
673
+
674
+ "NL" for notification log files,
675
+
676
+ "CG" for charging files,
677
+
678
+ "OT" for other files.
679
+
680
+ - 2) The file\_ready\_date field is of the form YYYYMMDD, where:
681
+
682
+ - YYYY is the year in four-digit notation;
683
+ - MM is the month in two digit notation (01 - 12);
684
+ - DD is the day in two digit notation (01 - 31).
685
+
686
+ The file\_ready\_date is the date when the file was last closed and made available for upload and the file content will not be changed.
687
+
688
+ - 3) The file\_ready\_time field is of the form HHMMshhmm, where:
689
+
690
+ - HH is the two digit hour of the day (local time), based on 24 hour clock (00 - 23);
691
+ - MM is the two digit minute of the hour (local time, 00 - 59);
692
+ - s is the sign of the local time differential from UTC (+ or -), in case the time differential to UTC is 0 then the sign may be arbitrarily set to "+" or "-";
693
+ - hh is the two digit number of hours of the local time differential from UTC (00 - 23);
694
+ - mm is the two digit number of minutes of the local time differential from UTC (00 - 59).
695
+
696
+ The file\_ready\_time is the time when the file was last closed and made available for upload and the file content will not be changed.
697
+
698
+ - 4) To reduce length of the file name, the file\_expiration\_delta\_time field could be a delta time interval from file ready time. The unit is hour.
699
+ - 5) The specificIRP\_extension field is used for other IRPs to extend the extra file naming convention which is not covered by the basic file naming convention defined in FileTransferIRP.
700
+ - 6) The RC parameter is a running count, starting with the value of "1", and shall be appended only if the filename is not unique, i.e. more than one file is generated and all other parameters of the file name are identical.
701
+ - 7) The separator field is "\_-\_", which is an underscore character (\_), followed by a minus character (-), followed by an underscore character (\_).
702
+
703
+ # Annex B (informative): Change history
704
+
705
+ | Change history | | | | | | | | |
706
+ |----------------|--------|-----------|------|-----|--------------------------------------------------------------------------------------------------------------------|-----|-------|--------|
707
+ | Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Cat | Old | New |
708
+ | Dec 2003 | SA_2 2 | SP-030637 | -- | -- | Submitted to TSG SA#22 for Information | -- | 1.0.0 | |
709
+ | Jun 2004 | SA_2 4 | SP-040244 | -- | -- | Submitted to TSG SA#24 for Approval | -- | 2.0.0 | 6.0.0 |
710
+ | Jun 2005 | SA_2 8 | SP-050292 | -- | -- | Apply Generic System Context | -- | 6.0.0 | 6.1.0 |
711
+ | Mar 2006 | SA_3 1 | SP-060089 | 0002 | -- | Correct ambiguity of object class and object instance usage in notification | F | 6.1.0 | 6.2.0 |
712
+ | Jun 2007 | SA_3 6 | -- | -- | -- | Automatic upgrade to Rel-7 (no CR) at freeze of Rel-7. Deleted reference to CMIP SS, discontinued from R7 onwards. | -- | 6.2.0 | 7.0.0 |
713
+ | Mar 2009 | SA_4 3 | SP-090207 | 0003 | -- | Include reference to SOAP Solution Set specification | D | 7.0.0 | 8.0.0 |
714
+ | Dec 2009 | - | - | - | - | Update to Rel-9 version (MCC) | - | 8.0.0 | 9.0.0 |
715
+ | Mar 2011 | - | - | - | - | Update to Rel-10 version (MCC) | - | 9.0.0 | 10.0.0 |