hash
stringlengths
32
32
doc_id
stringlengths
5
12
section
stringlengths
4
595
content
stringlengths
0
6.67M
1cc4b09fd057c9a5cf925fb9b5a5f4e7
25.945
9.5.2.1 Simulation results
The results for the relative capacity loss are summarized in the tables below. 1) For the case that the 1.28 Mcps TDD system suffers from adjacent channel, and interference from a 3.84 Mcps TDD system: Table 9.7 Victim (receiver) interferer (transmitter) Relative capacity loss 1.28 Mcps TDD BS (cluster=1) 3.84 Mcps TDD MS < 1% 1.28 Mcps TDD MS (cluster=1) 3.84 Mcps TDD MS < 2% 1.28 Mcps TDD MS (cluster=1) 3.84 Mcps TDD BS < 2% 2) For the case that the 3.84 Mcps TDD system suffers from adjacent channel, and interference from a 1.28 Mcps TDD system: Table 9.8 Victim (receiver) interferer (transmitter) Relative capacity loss 3.84 Mcps TDD BS 1.28 Mcps TDD MS (cluster=1) <2% 3.84 Mcps TDD MS 1.28 Mcps TDD MS (cluster=1) < 1% 3.84 Mcps TDD MS 1.28 Mcps TDD BS (cluster=1) < 2%
1cc4b09fd057c9a5cf925fb9b5a5f4e7
25.945
9.5.2.2 Conclusion
The focus of these investigations is on speech users in macro cells for a vehicular propagation environment. The results show reasonable capacity loss values, even without coordination or time alignment between the victim and the interferer system.
1cc4b09fd057c9a5cf925fb9b5a5f4e7
25.945
9.5.3 1.28 Mcps TDD / 1.28 Mcps TDD
1cc4b09fd057c9a5cf925fb9b5a5f4e7
25.945
9.5.3.1 Simulation results
The results for the relative capacity loss are summarized in the table below. Table 9.9 Victim (receiver) interferer (transmitter) relative capacity loss 1.28 Mcps TDD BS of operator A (cluster=1) 1.28 Mcps TDD MS of operator B (cluster=1) < 2% 1.28 Mcps TDD MS of operator A (cluster=1) 1.28 Mcps TDD MS of operator B (cluster=1) < 2% 1.28 Mcps TDD MS of operator A (cluster=1) 1.28 Mcps TDD BS of operator B (cluster=1) < 1%
1cc4b09fd057c9a5cf925fb9b5a5f4e7
25.945
9.5.3.2 Conclusion
The focus of these investigations is on speech users in macro cells for a vehicular propagation environment. The results show reasonable capacity loss values, even without coordination or time alignment between the victim and the interferer system.
1cc4b09fd057c9a5cf925fb9b5a5f4e7
25.945
9.6 Information and General purpose materials
1cc4b09fd057c9a5cf925fb9b5a5f4e7
25.945
9.6.1 CDMA Definitions and Equations
1cc4b09fd057c9a5cf925fb9b5a5f4e7
25.945
9.6.1.1 CDMA-related definitions
The following CDMA-related abbreviations and definitions are used in various 3GPP WG4 documents. Table 9.10 1.28M chips per second. Average energy per PN chip for DwPTS. The ratio of the received energy per PN chip for DwPTS to the total received power spectral density at the UE antenna connector. The ratio of the average transmit energy per PN chip for DwPTS to the total transmit power spectral density.
1cc4b09fd057c9a5cf925fb9b5a5f4e7
25.945
9.6.1.1.1 Explanation difference
For 1.28 Mcps chip rate TDD option, the frame length is 10ms and the 10ms is divided into 2 sub-frames of 5 ms. Each subframe is composed of 7 normal traffic time slots and two special pilot slots, i.e., DwPTS for downlink and UpPTS for uplink. For 1.28 Mcps chip rate TDD option, the other CDMA related definitions have the same meaning as for 3.84 Mcps TDD.
1cc4b09fd057c9a5cf925fb9b5a5f4e7
25.945
9.6.1.2 CDMA equations
The equations listed below describe the relationship between various parameters under different conditions.
1cc4b09fd057c9a5cf925fb9b5a5f4e7
25.945
9.6.1.2.1 BS Transmission Power
Transmit power of the Base Station is normalized to 1 and can be presented as (Normal downlink timeslots) =1 (Timeslot 0) =1 (DwPTS)
1cc4b09fd057c9a5cf925fb9b5a5f4e7
25.945
9.6.1.2.1.1 Explanations
1.28 Mcps TDD option has special frame structure; its TS0 is only used for downlink so the position of P-CCPCH is fixed. DwPTS and UpPTS are unique slots so separate equations are need for them.
1cc4b09fd057c9a5cf925fb9b5a5f4e7
25.945
9.7 Link Level performances
1cc4b09fd057c9a5cf925fb9b5a5f4e7
25.945
9.7.1 Simulation results for 1.28 Mcps TDD performace
1cc4b09fd057c9a5cf925fb9b5a5f4e7
25.945
9.7.1.1 Simulation assumptions
1cc4b09fd057c9a5cf925fb9b5a5f4e7
25.945
9.7.1.1.1 Simulation chain
1cc4b09fd057c9a5cf925fb9b5a5f4e7
25.945
9.7.1.1.1.1 Downlink
Because joint detection is considered for the low chip rate TDD option, the simulation has to differ from the wideband TDD simulation. An orthogonal channel noise simulator (OCNS) can not be used, instead all intracell interferer have to be modelled individually. The simulation chain is shown in the figure below. Figure 9.4: Downlink simulation chain Ioc represents the intercell interference and other noise contributions, and DPCHoi for i=1 to m are the individual intracell interferer. Each intracell interferer DPCHoi is modelled by one code with Q=16. DPCH1 to DPCHn are the DPCH for the service under investigation. All DPCHi for i=1 to n and DPCHoj for j=1 to m have the same chip energy DPCH_Ec. Note that in the downlink all codes have a spreading factor of 16 for all reference measurement channels. The ratio of Îor to Ioc is varied until the BLER target is reached, and . For the performance requirement test, the ratio of Îor to Ioc is increased by the implementation margin.
1cc4b09fd057c9a5cf925fb9b5a5f4e7
25.945
9.7.1.1.1.2 Uplink
In the uplink the same simulation chain as for wide-band TDD is used. The uplink simulation chain is shown in figure9.5. Figure 9.5: Uplink simulation chain DPCH1 and DPCH2 are the DPCH for the service under investigation. DPCHoi for i=1 to n is one code with the spreading factor 8. The ratio of Îor to Ioc is varied until the BLER target is reached. For the reference measurement channel one or two codes with different spreading factors are used. The following equations apply for the chip energy: and , where Q1 and Q2 refer to the spreading factors of DPCH1 and DPCH2 and . If only a single code is used for the service under investigation, DPCH2_Ec is null. In this case the following formula applies: The implementation margin is encountered in the intercell interference ratio Îor/Ioc.
1cc4b09fd057c9a5cf925fb9b5a5f4e7
25.945
9.7.1.1.2 Simulation Assumptions
1cc4b09fd057c9a5cf925fb9b5a5f4e7
25.945
9.7.1.1.2.1 General
Table 9.11 Parameter Explanation/Assumption Chip Rate 1.28 Mcps Duration of TDMA sub-frame 5 ms Number of time slots per sub-frame 7 Closed loop power control OFF AGC OFF Number of samples per chip 1 sample per chip Propagation Conditions See Tdoc R400TDD051 Numerical precision Floating point simulations BLER target 10E-1; 10E-2; 10E-3 BLER calculation BLER will be calculated by comparing with transmitted and received bits. DCCH model Random symbols transmitted, not evaluated in the receiver TPC and SS model Random symbols transmitted, not evaluated in the receiver TFCI model Random symbols, not evaluated in the receiver but it is assumed that receiver gets error free reception of TFCI information Turbo decoding Max Log Map with 4 iterations Measurement Channels See Tdoc R400TDD052 Other L1 parameters As Specified in latest L1 specifications Cell parameter 0 (this determines the scrambling and basic midamble code)
1cc4b09fd057c9a5cf925fb9b5a5f4e7
25.945
9.7.1.1.2.2 Additional downlink parameters
Table 9.12 Parameter Value Îor/Ioc Ratio to meet the required BLER target # of DPCHoi Bit rate Static Case 1 Case 2 Case 3 12.2 kbps 8 8 8 8 64 kbps 2 2 2 2 144 kbps 2 2 2 2 384 kbps 0 0 0 0 Number of timeslots per sub-frame per user 12.2 kbps: TS=1 64 kbps: TS=1 144 kbps: TS=2 384 kbps: TS=4 Transmit diversity, “TxAA”, “TSTD” OFF Receiver antenna diversity OFF Midamble Common midamble (See TR25.928v1.1.0 chapter 7.2.5) Channelisation codes C(k; Q) (see TR25.928v1.1.0 chapter 9.2.2) 12.2 kbps 64 kbps 144 kbps 384 kbps DPCHi C(i; 16) C(i; 16) C(i; 16) C(i; 16) DPCHoj C(j+2; 16) C(j+8; 16) C(j+8; 16) - Receiver Joint Detector (ZF-BLE) Channel Estimation Ideal multipath delay estimation and joint channel estimator according to article from Steiner and Baier in Freq., vol. 47, 1993, pp.292-298, based on correlation to obtain the complex amplitudes for the path.
1cc4b09fd057c9a5cf925fb9b5a5f4e7
25.945
9.7.1.1.2.3 Additional uplink parameters
Table 9.13 Parameter Value Channel Estimation Ideal multipath delay estimation and joint channel estimator according to article from Steiner and Baier in Freq., vol. 47, 1993, pp.292-298, based on correlation to obtain the complex amplitudes for the path. Receiver antenna diversity ON (2 antennas) Îor/Ioc [dB] Parameter to meet the required BLER # of DPCHoi Bit rate Static Case 1 Case 2 Case 3 12.2 kbps 4 4 4 4 64 kbps 1 1 1 1 144 kbps 1 1 1 1 384 kbps 0 0 0 0 Number of timeslots per frame per user 12.2 kbps: TS=1 64 kbps: TS=1 144 kbps: TS=2 384 kbps: TS=4 Channelisation codes C(k; Q) (see TR25.928v1.1.0 chapter 9.2.2) 12.2 kbps 64 kbps 144 kbps 384 kbps DPCH1 C(1; 8) C(1; 2) C(1; 2) C(1; 2) DPCH2 - - - C(5; 8) DPCHoi C(i+1; 8) C(i+4; 8) C(i+4; 8) - Midamble UE specific (See TR25.928v1.1.0 chapter 7.2.5) Receiver Multi-User Detection (ZF-BLE)
1cc4b09fd057c9a5cf925fb9b5a5f4e7
25.945
9.7.1.2 Simulation results
1cc4b09fd057c9a5cf925fb9b5a5f4e7
25.945
9.7.1.2.1 12.2kps service
1cc4b09fd057c9a5cf925fb9b5a5f4e7
25.945
9.7.1.2.1.1 Graphical Presentation of 12.2kbps service UL Simulation Results
Figure 9.6 Figure 9.7 Figure 9.8 Figure 9.9
1cc4b09fd057c9a5cf925fb9b5a5f4e7
25.945
9.7.1.2.1.2 Graphical Presentation of 12.2kbps service DL Simulation Results
Figure 9.10 Figure 9.11 Figure 9.12 Figure 9.13
1cc4b09fd057c9a5cf925fb9b5a5f4e7
25.945
9.7.1.2.2 64kps Service
1cc4b09fd057c9a5cf925fb9b5a5f4e7
25.945
9.7.1.2.2.1 Graphical Presentation of 64kbps service UL Simulation Results
Figure 9.14 Figure 9.15 Figure 9.16 Figure 9.17
1cc4b09fd057c9a5cf925fb9b5a5f4e7
25.945
9.7.1.2.2.2 Graphical Presentation of 64kbps service DL Simulation Results
Figure 9.18 Figure 9.19 Figure 9.20 Figure 9.21
1cc4b09fd057c9a5cf925fb9b5a5f4e7
25.945
9.7.1.2.3 144kps Service
1cc4b09fd057c9a5cf925fb9b5a5f4e7
25.945
9.7.1.2.3.1 Graphical Presentation of 144kbps service UL Simulation Results
Figure 9.22 Figure 9.23 Figure 9.24 Figure 9.25
1cc4b09fd057c9a5cf925fb9b5a5f4e7
25.945
9.7.1.2.3.2 Graphical Presentation of 144kbps service DL Simulation Results
Figure 9.26 Figure 9.27 Figure 9.28 Figure 9.29
1cc4b09fd057c9a5cf925fb9b5a5f4e7
25.945
9.7.1.2.4 384kps Service
1cc4b09fd057c9a5cf925fb9b5a5f4e7
25.945
9.7.1.2.4.1 Graphical Presentation of 384kbps service UL Simulation Results
Figure 9.30 Figure 9.31 Figure 9.32 Figure 9.33
1cc4b09fd057c9a5cf925fb9b5a5f4e7
25.945
9.7.1.2.4.2 Graphical Presentation of 384kbps service DL Simulation Results
Figure 9.34 Figure 9.35 Figure 9.36 Figure 9.37
1cc4b09fd057c9a5cf925fb9b5a5f4e7
25.945
9.7.2 1.28 Mcps TDD and FDD link level simulation
(void) Annex A (informative): The key physical layer parameters for low chip rate TDD option Table A.1 Support of : Difference to high chiprate TDD option Further details Support of different radio frame structure 1.Different frame structure to high chiprate TDD option 2.Different basic midamble sequences, maximum channel impulse response is scalable (W=8, 9, 12, 16, 21, 32, 64), depending on number of users and environment, including the association between midambles and channelisation codes 3.Use of only one burst type for physical channels except special bursts in DwPTS/UpPTS 4.Support of different timeslot formats due to different number of bits and L1 control signals and midamble length 5.Support of use of 8PSK for special timeslots/all timeslots per cell 6.Beacon function is provided by DwPTS and P-CCPCH Segmentation of the radio frame into 2 subframes Each subframe consists of 7 traffic slots (864 chips length) and two special timeslots for synchronisation and initial access which are separated by an extra guard period 5. Including TFCI, SS, and TPC coding (8PSK) Modified Power Control 1.Closed Loop PC in uplink and downlink 2.Open loop PC on the SYNC1 Code while initial access 3.P-CCPCH and DwPTS power can be used as a beacon 4.number of TPC symbols can take 2 values 1. TPC bits also in downlink 3. transmit power level reported on BCH 4. none, one symbol, 16/SF TPC symbols per radio frame, number of TPC symbols is always the same like number of SS symbols Modified RACH procedure 1.Random Access carried out in 2 steps 1. Send SYNC1, Receive FPACH 2. Send power controlled, timing advanced PRACH in traffic timeslot (code associated to received FPACH. There is another association between the PRACH and the FACH. These associations are broadcast by the BCH.) Due to the two-step approach a collision most likely happens on the UpPTS. The RACH RUs are virtually collision free. There are no dedicated RACH time slots, the RACH resources share the time slot with dedicated resources, a two step procedure ensures that the actual RACH. Cell search operation 1.One synchronisation channel only (DwPTS) and different frame duration Step 1: Search for DwPTS Step 2: Scrambling- and basic midamble code identification Step 3: searches for the head of multi-frame indicated Step 4: Read the BCH Uplink synchronisation 1.Special Layer1-SS symbols 2.Number of used SS symbols can take 2 values 3.SS-symbols are transmitted once per subframe 1.SS symbols command an incremental change of timing 2.none, one symbol, 16/SF SS symbols per radio frame, number of SS symbols is always the same like number of TPC symbols 3.Frequency and step size are configured by UTRAN (“k” and “M” parameters) Beamforming Beamforming applies to the dedicated channels and may also be used for some common channels like FPACH Physical channels P-CCPCH and S-CCPCH require two channelisation codes; FPACH is a new physical channel which always uses one channelisation code at SF 16. Mapping of transport channels to physical channels PCH; PICH and FACH can be time multiplexed with the BCH on the P-CCPCH. PCH, PICH and FACH can be time multiplexed on the S-CCPCH. Therefore these transport channels are using two channelisation codes of SF 16. The PICH carries a different number of PIs than in the high chip rate option, because of the different burst structure. Measurements Ranges and accuracy have to be adapted for the low chip rate option. Service mapping Due to the different payload size and subframe segmentation the service mapping for the low chip rate differs from that of the high chip rate option. Annex B (informative): Test Cases B.a Purpose of Annex Same contents as TS 25.123 section A.1. B.b Requirement classification for statistical testing Same contents as TS 25.123 section A.2. B.b.1 Types of requirements in TS 25.123 Same contents as TS 25.123 section A.2.1. B.1 Idle Mode B.1.1 Cell selection This section is included for consistency in the numbering. B.1.2 Cell Re-Selection For each of the re-selection scenarios in section 4.2 a test is proposed. For NTDD/NTDD re-selection two scenarios are considered: Scenario 1: Single carrier case Scenario 2: Multi carrier case B.1.2.1 Single carrier case NTDD/NTDD cell re-selection B.1.2.1.1 Test Purpose and Environment This test is to verify the requirement for the cell re-selection delay in the single carrier case reported in section 4.2. This scenario implies the presence of 1 carrier and 6 cells as given in Table B.1 and B.2. Cell 1 and cell2 shall belong to different Location Areas. Table B.1: General test parameters for Single carrier NTDD/NTDD cell re-selection Parameter Unit Value Comment Initial condition Active cell Cell1 Neighbour cells Cell2, Cell3,Cell4, Cell5, Cell6 Final condition Active cell Cell2 Access Service Class (ASC#0) ‑ Persistence value 0..1 1 Selected so that no additional delay is caused by the random access procedure. The value shall be used for all cells in the test. DRX cycle length s 1.28 The value shall be used for all cells in the test. T1 s 15 T2 s 15 Table B.2: Cell re-selection single carrier multi-cell case Parameter Unit Cell 1 Cell 2 Cell 3 Timeslot Number 0 DWPTS 0 DWPTS 0 DWPTS T1 T2 T1 T2 T1 T2 T1 T2 T1 T2 T1 T2 UTRA RF Channel Number Channel 1 Channel 1 Channel 1 PCCPCH_Ec/Ior dB -3 -3 -3 -3 -3 -3 DwPCH_Ec/Ior dB 0 0 0 0 0 0 dB [9] [7] [9] [7] [7] [9] [7] [9] [-1] [-1] [-1] [-1] PCCPCH RSCP dBm [-64] [-66] [-66] [-64] [-74] [-74] Qoffset [ 0] [0 ] [0] [ 0] [ 0] [ 0] Qhyst [0 ] [ 0] [0] [0 ] [ 0] [ 0] Treselection s [ 0] [ 0] [0] [ 0] [ 0] [ 0] Sintrasearch dB not sent not sent not sent not sent not sent not sent Cell 4 Cell 5 Cell 6 Timeslot 0 DWPTS 0 DWPTS 0 DWPTS T1 T2 T1 T2 T1 T2 T1 T2 T1 T2 T1 T2 UTRA RF Channel Number Channel 1 Channel 1 Channel 1 PCCPCH_Ec/Ior dB -3 -3 -3 -3 -3 -3 DwPCH_Ec/Ior dB 0 0 0 0 0 0 dB [-1] [-1] [-1] [-1] [-1] [-1] [-1] [-1] [-1] [-1] [-1] [-1] PCCPCH RSCP dBm [-74] [-74] [-74] [-74] [-74] [-74] Qoffset [ 0] [ 0] [ 0] [ 0] [ 0] [ 0] Qhyst [ 0] [ 0] [ 0] [ 0] [ 0] [ 0] Treselection s [ 0] [ 0] [ 0] [ 0] [ 0] [ 0] Sintrasearch dB [ not sent] [ not sent] [ not sent] [ not sent] [ not sent] [ not sent] dBm/1.28 MHz -70 Propagation Condition AWGN B.1.2.1.2 Test Requirements The cell re-selection delay is defined as the time from the beginning of time period T2, to the moment when the UE camps on Cell 2, and starts to send the RRC CONNECTION REQUEST message to perform a Location Registration on cell 2. The cell re-selection delay shall be less than 8 s. NOTE: The cell re-selection delay can be expressed as: TevaluateNTDD + TSI, where: TevaluateNTDD A DRX cycle length of 1280ms is assumed for this test case, this leads to a Tevaluate NTDD of 6.4s according to Table 4.1 in section 4.2.2.7. TSI Maximum repetition rate of relevant system info blocks that needs to be received by the UE to camp on a cell. 1280 ms is assumed in this test case. This gives a total of 7.68 s, allow 8s in the test case. B.1.2.2 NTDD/NTDD cell re-selection multi carrier case B.1.2.2.1 Test Purpose and Environment This test is to verify the requirement for the cell re-selection delay in the multi carrier case reported in section 4.1.2 This scenario implies the presence of 2 carriers and 6 cells as given in Table B-3 and B-4. Cell 1 and cell 2 shall belong to different Location Areas. Table B.3: General test parameters for Cell Re-selection in Multi carrier case Parameter Unit Value Comment Initial condition Active cell Cell1 Neighbour cells Cell2, Cell3,Cell4, Cell5, Cell6 Final condition Active cell Cell2 Access Service Class (ASC#0) – Persistence value 1 Selected so that no additional delay is caused by the random access procedure. The value shall be used for all cells in the test. DRX cycle length s 1.28 The value shall be used for all cells in the test. T1 s 15 T2 s 15 Table B.4: Cell re-selection multi carrier multi cell case Parameter Unit Cell 1 Cell 2 Cell 3 Timeslot Number 0 DWPTS 0 DWPTS 0 DWPTS T1 T2 T1 T2 T1 T2 T1 T2 T1 T2 T1 T2 UTRA RF Channel Number Channel 1 Channel 2 Channel 1 PCCPCH_Ec/Ior dB -3 -3 -3 -3 -3 -3 DwPCH_Ec/Ior dB 0 0 0 0 0 0 dB [9] [7] [9] [7] [7] [9] [7] [9] [-1] [-1] [-1] [-1] PCCPCH RSCP dBm [-64] [-66] [-66] [-64] [-74] [-74] Qoffset [ 0] [ 0] [ 0] [ 0] [ 0] [ 0] Qhyst [ 0] [ 0] [ 0] [ 0] [ 0] [ 0] Treselection s [ 0] [ 0] [ 0] [ 0] [ 0] [ 0] Qintrasearch dB [not sent] [not sent ] [not sent] [not sent] [not sent ] [not sent] Cell 4 Cell 5 Cell 6 Timeslot 0 DWPTS 0 DWPTS 0 DWPTS T1 T2 T1 T2 T1 T2 T1 T2 T1 T2 T1 T2 UTRA RF Channel Number Channel Channel 2 Channel PCCPCH_Ec/Ior dB -3 -3 -3 -3 -3 -3 DwPCH_Ec/Ior dB 0 0 0 0 0 0 dB [-1] [-1] [-1] [-1] [-1] [-1] [-1] [-1] [-1] [-1] [-1] [-1] PCCPCH RSCP dBm [-74] [-74] [-74] [-74] [-74] [-74] Qoffset [ 0] [ 0] [ 0] [ 0] [ 0] [ 0] Qhyst [ 0] [ 0] [ 0] [ 0] [ 0] [ 0] Treselection s [ 0] [ 0] [ 0] [ 0] [ 0] [ 0] Qintrasearch dB [not sent] [not sent] [not sent] [not sent] [not sent] [not sent] dBm/3.84 MHz -70 Propagation Condition AWGN B.1.2.2.2 Test Requirements The cell re-selection delay is defined as the time from the beginning of time period T2, to the moment when the UE camps on Cell 2, and starts to send the RRC CONNECTION REQUEST message to perform a Location Registration on cell 2. The cell re-selection delay shall be less than 8 s. NOTE: The cell re-selection delay can be expressed as: TevaluateNTDD + TSI, where: TevaluateNTDD A DRX cycle length of 1280ms is assumed for this test case, this leads to a Tevaluate NTDD of 6.4s according to Table 4.1 in section 4.1.5. TSI Maximum repetition rate of relevant system info blocks that needs to be received by the UE to camp on a cell. 1280 ms is assumed in this test case. This gives a total of 7.68 s, allow 8s in the test case. B.1.2.3 High chip rate TDD cell re-selection B.1.2.3.1 Test Purpose and Environment This test is to verify the requirement for the NTDD/TDD cell re-selection delay reported in section 4.1.2.3. This scenario implies the presence of 1 low chip rate (NTDD) and 1 high chip rate (TDD) cell as given in Table B-5 and B-6. The ranking of the cells shall be made according to the cell reselection criteria specified in TS 25.304. For this test environment the ranking/mapping function indicated in the broadcast of cell 1 shall be in such a way as to enable the UE to evaluate that the NTDD cell 1 is better ranked as the TDD cell 2 during T1 and the TDD cell 2 is better ranked than the NTDD cell 1 during T2. Cell 1 and cell 2 shall belong to different Location Areas. Table B.5: General test parameters for TDD low chip rate to TDD high chip rate cell re-selection Parameter Unit Value Comment Initial condition Active cell Cell1 NTDD cell Neighbour cell Cell2 TDD cell Final condition Active cell Cell2 Access Service Class (ASC#0) ‑ Persistence value 1 Selected so that no additional delay is caused by the random access procedure. The value shall be used for all cells in the test. DRX cycle length s 1.28 T1 s 15 Cell 1 better ranked than cell 2 T2 s 15 Cell2 better ranked than cell 1 Table B.6: Test parameters for TDD low chip rate to TDD high chip rate cell re-selection Parameter Unit Cell 1 Cell 2 Timeslot Number 0 DwPts 0 8 T1 T2 T 1 T 2 T1 T2 T 1 T 2 UTRA RF Channel Number Channel 1 Channel 2 PCCPCH_Ec/Ior dB -3 -3 -3 -3 DwPCH_Ec/Ior dB 0 0 n.a. n.a. SCH_Ec/Ior dB n.a. n.a. -9 -9 -9 -9 SCH_toffset n.a. n.a. 0 0 0 0 PICH_Ec/Ior -3 -3 OCNS dB n.a. n.a. -4,28 -4,28 -4,28 -4,28 dB [10] [7] [7] [10] [7] [10] dBm/3.84 MHz -70 PCCPCH_RSCP dBm [-63] [-66] [-66] [-63] Treselection s 0 0 Propagation Condition AWGN AWGN B.1.2.3.2 Test Requirements The cell re-selection delay is defined as the time from the beginning of time period T2, to the moment when the UE camps on Cell 2, and starts to send the RRC CONNECTION REQUEST message to perform a Location Registration on cell 2. The cell re-selection delay shall be less than 8 s. Note: The re-selection delay equals TTDDevaluate + Trep repetition period of the broadcast information of the selected cell B.1.2.4 FDD cell re-selection B.1.2.4.1 Test Purpose and Environment This test is to verify the requirement for the NTDD/FDD cell re-selection delay reported in section 4.1.2.4. This scenario implies the presence of 1 low chip rate TDD and 1 FDD cell as given in Table B-5 and B-6. The ranking of the cells shall be made according to the cell reselection criteria specified in TS 25.304. For this test environment the ranking/mapping function indicated in the broadcast of cell 1 shall be in such a way as to enable the UE to evaluate that the NTDD cell 1 is better ranked as the FDD cell 2 during T1 and the FDD cell 2 is better ranked than the NTDD cell 1 during T2. Cell 1 and cell 2 shall belong to different Location Areas. Table B.7: General test parameters for the TDD/FDD cell re-selection Parameter Unit Value Comment Initial condition Active cell Cell1 NTDD cell Neighbour cells Cell2 FDD cell Final condition Active cell Cell2 Access Service Class (ASC#0) ‑ Persistence value 1 Selected so that no additional delay is caused by the random access procedure. The value shall be used for all cells in the test. DRX cycle length s 1.28 The value shall be used for all cells in the test. T1 s 15 T2 s 15 Table B.8: Test parameters for the NTDD/FDD cell re-selection Parameter Unit Cell 1 Cell 2 Timeslot Number 0 DwPts n.a. T1 T2 T 1 T 2 T1 T2 UTRA RF Channel Number Channel 1 Channel 2 PCCPCH_Ec/Ior dB -3 -3 -12 -12 DwPCH_Ec/Ior dB 0 0 n.a. CPICH_Ec/Ior dB n.a. n.a. -10 -10 SCH_Ec/Ior dB n.a. n.a. -12 -12 PICH_Ec/Ior -15 -15 OCNS dB n.a. n.a. -0,941 -0,941 dB [ ] [ ] [ ] [ ] dBm/1.28 MHz -70 PCCPCH_RSCP dBm [ ] [ ] n.a. n.a. CPICH_Ec/Io n.a. [ ] [ ] Treselection s 0 0 Propagation Condition AWGN B.1.2.4.2 Test Requirements The cell re-selection delay is defined as the time from the beginning of time period T2, to the moment when the UE camps on Cell 2, and starts to send preambles on the PRACH for sending the RRC CONNECTION REQUEST message to perform a Location Registration on cell 2. The cell re-selection delay shall be less than 8 s. NOTE: The cell re-selection delay can be expressed as: TevaluateFDD + TSI, where: TevaluateFDD See Table 4.1 in section 4.1.5. TSI Maximum repetition rate of relevant system info blocks that needs to be received by the UE to camp on a cell. 1280 ms is assumed in this test case. This gives a total of 7.68 s, allow 8s in the test case. B.1.3 Inter-RAT( GSM) cell re-selection B.1.3.1 Scenario B.1.3.1.1 Test Purpose and Environment This test is to verify the requirement for the UTRAN to GSM cell re-selection delay reported in section 4.1.3 This scenario implies the presence of 1 UTRAN serving cell, and 1 GSM cell to be re-selected. Test parameters are given in Table, B-9, B-10, B-11. The ranking of the cells shall be made according to the cell reselection criteria specified in TS 25.304. For this test environment the ranking/mapping function indicated in the broadcast of cell 1 shall be in such a way as to enable the UE to evaluate that the NTDD cell 1 is better ranked as the GSM cell 2 during T1 and the GSM cell 2 is better ranked than the NTDD cell 1 during T2. Table B.9: General test parameters for UTRAN (NTDD) to GSM Cell Re-selection Parameter Unit Value Comment Initial condition Active cell Cell1 Neighbour cell Cell2 Final condition Active cell Cell2 DRX cycle length s 1.28 T1 s 15 T2 s 15 Table B.10: Cell re-selection UTRAN to GSM cell case (cell 1) Parameter Unit Cell 1 (UTRA) Timeslot Number 0 DwPTS T1 T2 T1 T2 UTRA RF Channel Number Channel 1 Channel 1 PCCPCH_Ec/Ior dB -3 -3 DwPCH_Ec/Ior dB 0 0 dB [9] [7] [9] [7] dBm/1.28 MHz –70 –70 PCCPCH RSCP dBm [-64] [-66] Propagation Condition AWGN AWGN Cell_selection_and_ reselection_quality_measure P-CCPCH RSCP Treselection s [ ] SsearchRAT dB [ ] Table B.11: Cell re-selection UTRAN to GSM cell case (cell 2) Parameter Unit Cell 2 (GSM) T1 T2 Absolute RF Channel Number ARFCN 1 RXLEV dBm -80 -70 RXLEV_ACCESS_ MIN dBm [-100 MS_TXPWR_MAX_ CCH dBm 30 B.1.3.1.2 Test Requirements The cell re-selection delay is defined as the time from the beginning of time period T2, to the moment when the UE camps on Cell 2, and starts to send LOCATION UPDATING REQUEST message to perform a Location update. The cell re-selection delay shall be less than [8] s. NOTE: The UE shall keep a running average of 4 measurements, thus gives 4*1280ms (TmeasureGSM Table 4.1), means 5.12 seconds can elapse from the beginning of time period T2 before the UE has finished the measurements to evaluate that the GSM cell fulfils the re-selection criteria. The cell selection parameters in the BCCH of the GSM cell in system info 3 and 4 are transmitted at least every second. B.2 UTRAN Connected Mode Mobility B.2.1 1.28 Mcps TDD/TDD Handover (void) B.2.2 1.28 Mcps TDD/FDD Handover NOTE: This section is included for consistency with numbering with section 4.2, currently no test covering requirements in sections 4.2.2.2.1 and 4.2.2.2.2 exists. B.2.3 1.28 Mcps TDD/GSM Handover NOTE: This section is included for consistency with numbering with section 4.2 currently no test covering requirements in sections 4.2.3.2.1 and 4.2.3.2.2 exists. B.2.4 Cell Re-selection in CELL_FACH B.2.4.1 One frequency present in neighbour list B.2.4.1.1 Test Purpose and Environment Note: Cell reselection in Cell-fach is still under discussion. The purpose of this test is to verify the requirement for the cell re-selection delay in CELL_FACH state in the single carrier case reported in section 4.2.4.2.1.1. The test parameters are given in Table B.12 and B.13 Table B.12: General test parameters for Cell Re-selection in CELL_FACH Parameter Unit Value Comment initial condition Active cell Cell1 Neighbour cells Cell2, Cell3,Cell4, Cell5, Cell6 final condition Active cell Cell2 T1 s T1 need to be defined so that cell re-selection reaction time is taken into account. T2 s T2 need to be defined so that cell re-selection reaction time is taken into account. Table B.13: Cell specific test parameters for Cell Re-selection in CELL_FACH Parameter Unit Cell 1 Cell 2 Cell 3 Timeslot Number 0 DWPTS 0 DWPTS 0 DWPTS T1 T2 T1 T2 T1 T2 T1 T2 T1 T2 T1 T2 UTRA RF Channel Number Channel 1 Channel 1 Channel 1 PCCPCH_Ec/Ior DB -3 -3 -3 -3 -3 -3 DwPCH_Ec/Ior DB 0 0 0 0 0 0 DB [9] [7] [9] [7] [7] [9] [7] [9] [-1] [-1] [-1] [-1] PCCPCH RSCP DBm -64 -66 -66 -64 -74 -74 Qoffset [ ] [ ] [ ] [ ] [ ] [ ] Qhyst DBm [ ] [ ] [ ] [ ] [ ] [ ] Treselection [ ] [ ] [ ] [ ] [ ] [ ] Qintrasearch DB [ ] [ ] [ ] [ ] [ ] [ ] Cell 4 Cell 5 Cell 6 Timeslot 0 DWPTS 0 DWPTS 0 DWPTS T1 T2 T1 T2 T1 T2 T1 T2 T1 T2 T1 T2 UTRA RF Channel Number Channel 1 Channel 1 Channel 1 PCCPCH_Ec/Ior DB -3 -3 -3 -3 -3 -3 DwPCH_Ec/Ior DB 0 0 0 0 0 0 DB [-1] [-1] [-1] [-1] [-1] [-1] [-1] [-1] [-1] [-1] [-1] [-1] PCCPCH RSCP DBm -74 -74 -74 -74 -74 -74 Qoffset [ ] [ ] [ ] [ ] [ ] [ ] Qhyst DBm [ ] [ ] [ ] [ ] [ ] [ ] Treselection [ ] [ ] [ ] [ ] [ ] [ ] Qintrasearch DB [ ] [ ] [ ] [ ] [ ] [ ] dBm/1.28 MHz -70 Propagation Condition AWGN B.2.4.1.2 Test Requirements The UE shall select cell 2 within a cell re-selection delay specified in 4.2.4.2.1.1 B.2.4.2 Two frequencies present in the neighbour list B.2.4.2.1 Test Purpose and Environment The purpose of this test is to verify the requirement for the cell re-selection delay in CELL_FACH state in section 4.2.4.2.1.2.The test parameters are given in Table B.14 and B.15. Table B.14: General test parameters for Cell Re-selection in CELL_FACH Parameter Unit Value Comment initial condition Active cell Cell1 Neighbour cells Cell2, Cell3,Cell4, Cell5, Cell6 final condition Active cell Cell2 T1 s T1 need to be defined so that cell re-selection reaction time is taken into account. T2 s T2 need to be defined so that cell re-selection reaction time is taken into account. Table B.15: Cell specific test parameters for Cell re-selection in CELL_FACH state Parameter Unit Cell 1 Cell 2 Cell 3 Timeslot Number 0 DWPTS 0 DWPTS 0 DWPTS T1 T2 T1 T2 T1 T2 T1 T2 T1 T2 T1 T2 UTRA RF Channel Number Channel 1 Channel 2 Channel 1 PCCPCH_Ec/Ior DB -3 -3 -3 -3 -3 -3 DwPCH_Ec/Ior DB 0 0 0 0 0 0 DB [9] [7] [9] [7] [7] [9] [7] [9] [-1] [-1] [-1] [-1] PCCPCH RSCP DBm [-64] [-66] [-66] [-64] [-74] [-74] Qoffset [ ] [ ] [ ] [ ] [ ] [ ] Qhyst DBm [ ] [ ] [ ] [ ] [ ] [ ] Treselection [ ] [ ] [ ] [ ] [ ] [ ] Qintrasearch DB [ ] [ ] [ ] [ ] [ ] [ ] Cell 4 Cell 5 Cell 6 Timeslot 0 DWPTS 0 DWPTS 0 DWPTS T1 T2 T1 T2 T1 T2 T1 T2 T1 T2 T1 T2 UTRA RF Channel Number Channel Channel 2 Channel PCCPCH_Ec/Ior DB -3 -3 -3 -3 -3 -3 DwPCH_Ec/Ior DB 0 0 0 0 0 0 DB [-1] [-1] [-1] [-1] [-1] [-1] [-1] [-1] [-1] [-1] [-1] [-1] PCCPCH RSCP DBm [-74] [-74] [-74] [-74] [-74] [-74] Qoffset [ ] [ ] [ ] [ ] [ ] [ ] Qhyst DBm [ ] [ ] [ ] [ ] [ ] [ ] Treselection [ ] [ ] [ ] [ ] [ ] [ ] Qintrasearch DB [ ] [ ] [ ] [ ] [ ] [ ] dBm/1.28 MHz -70 Propagation Condition AWGN NOTE: PCCPCH_RSCP is the quality measure for cell selection and re-selection. B.2.4.2.2 Test Requirements The UE shall select cell 2 within a cell re-selection delay specified in 4.2.4.2.1. B.2.5 Cell Re-selection in CELL_PCH Same requirements and test cases valid as for cell re-selection in idle mode. B.2.6 Cell Re-selection in URA_PCH Same requirements and test cases valid as for cell re-selection in idle mode. B.3 Dynamic Channel Allocation (void) B.4 Timing characteristics (void) B.5 UE Measurements Procedures B.5.1 1.28 Mcps TDD measurements B.5.1.1 Event triggered reporting in AWGN propagation conditions B.5.1.1.1 Test Purpose and Environment This test will derive that the terminal makes correct reporting of an event Cell 1 is the active cell, Cell 2 is a neighbour cell on the used frequency. The power level on Cell 1 is kept constant and the power level of Cell 2 is changed using "change of best cell event" as illustrated in Figure B.1. The test parameters are shown in Table B.16. Hysteresis, absolute Threshold and Time to Trigger values are given in the table below and they are signalled from test device. In the measurement control information it is indicated to the UE that event-triggered reporting with Event 1G shall be used. P-CCPCH RSCP of the best cell has to be reported together with Event 1G reporting. New measurement control information, which defines neighbour cells etc., is always sent before the event starts. Figure B.1: Illustration of parameters for handover measurement reporting test case Table B.16 Parameter Unit Cell 1 Cell 2 Timeslot Number 0 DwPTS 0 DwPTS T1 T2 T1 T2 T1 T2 T1 T2 UTRA RF Channel Number Channel 1 Channel 2 PCCPCH_Ec/Ior dB -3 -3 DwPCH_Ec/Ior dB 0 0 dB [3] [3] -Infinity [6] dBm/1.28 MHz -70 PCCPCH_RSCP dBm [-70] [-70] -Infinity [-67] Absolute Threshold (SIR) dB [ ] Hysteresis dB [ ] Time to Trigger msec [ ] Propagation Condition AWGN NOTE: The DPCH of all cells are located in a timeslot other than 0. B.5.1.1.1.1 Explanation difference In 1.28 Mcps TDD the PICH is mapped onto P-CCPCH as describe in TR25.928. So the PICH-Ec/Ior is no longer used. The function of the SCH is achieved by DwPTS in 1.28 Mcps TDD and it is allocated to a dedicated timeslot. And the P-CCPCH is always mapped onto time slot 0, so time slot 8 is not considered in 1.28 Mcps TDD. The parameter Îor/Ioc is measured to report to UE for its handover or cell selection and reselection. B.5.1.1.2 Test Requirements The UE shall send one Event 1G triggered measurement report, with a measurement reporting delay less than [480] ms from the beginning of time period T2. The UE shall not send event triggered measurement reports, as long as the reporting criteria are not fulfilled. B.5.2 FDD measurements B.5.2.1 Correct reporting of neighbours in AWGN propagation condition B.5.2.1.1 Test Purpose and Environment The purpose of this test is to verify that the UE makes correct reporting of an event when doing inter frequency measurements. The test will partly verify the requirements in section 4.5.1.2.2. This test will derive that the terminal makes correct reporting of an event Cell 1 is the active cell, Cell 2 is a neighbour cell on the used frequency. The power level on Cell 1 is kept constant and the power level of Cell 2 is changed using "change of best cell event" as illustrated in Figure B.5.1. The test parameters are shown in Table B.5.2. Hysteresis, absolute Threshold and Time to Trigger values are given in the table below and they are signalled from test device. In the measurement control information it is indicated to the UE that event-triggered reporting with Event 2C shall be used. P-CCPCH RSCP of the best cell has to be reported together with Event 2C reporting. New measurement control information, which defines neighbour cells etc., is always sent before the event starts. The test parameters are shown in Table B.17. Table B.17: Cell Specific Parameters for Correct Reporting of Neighbours in AWGN Propagation Condition Parameter Unit Cell 1 Cell 2 Timeslot Number 0 DwPTS 0 DwPTS T1 T2 T1 T2 T1 T2 T1 T2 UTRA RF Channel Number Channel 1 Channel 2 PCCPCH_Ec/Ior dB -3 -3 DwPCH_Ec/Ior dB 0 0 dB [3] [3] -Infinity [6] dBm/1.28 MHz -70 PCCPCH_RSCP dBm [-70] [-70] -Infinity [-67] Absolute Threshold (SIR) dB [ ] Hysteresis dB [ ] Time to Trigger msec [ ] Propagation Condition AWGN NOTE: The DPCH of all cells are located in a timeslot other than 0. B.5.2.1.1.1 Explanation difference In 1.28 Mcps TDD the PICH is mapped onto P-CCPCH as describe in TR25.928. So the PICH-Ec/Ior is no longer used. The function of the SCH is achieved by DwPTS in 1.28 Mcps TDD and it is allocated to a dedicated timeslot. And the P-CCPCH is always mapped onto time slot 0, so time slot 8 is not considered in 1.28 Mcps TDD. B.5.2.1.2 Test Requirements The UE shall send one Event 2C triggered measurement report, with a measurement reporting delay less than [5] s from the beginning of time period T2. The UE shall not send any measurement reports, as long as the reporting criteria are not fulfilled. B.6 Measurement Performance Requirements B.6.1 Measurement Performance for UE If not otherwise stated, the test parameters in table B.6.1 should be applied for UE RX measurements requirements in this clause. B.6.1.1 TDD intra frequency measurements If not otherwise stated, the test parameters in table B.18 should be applied for UE RX measurements requirements in this section. Table B.18: Intra frequency test parameters for UE RX Measurements Parameter Unit Cell 1 Cell 2 Timeslot Number 0 DwPTS 0 DwPTS T1 T2 T1 T2 T1 T2 T1 T2 UTRA RF Channel Number Channel 1 Channel 2 PCCPCH_Ec/Ior dB -3 -3 DwPCH_Ec/Ior dB 0 0 dB [3] [3] -Infinity [6] dBm/1.28 MHz -70 Range 1:Io Range 2:Io dBm -94..-70 –94..-50 -94..-70 –94..-50 Propagation condition AWGN NOTE 1: P-CCPCH_RSCP1,2  -[102] dBm. NOTE 2: | P-CCPCH_RSCP1 – PCCPCH_RSCP2 | 20 dB. NOTE 3: | Io – P-CCPCH_RSCP|  [20] dB. NOTE 4: Ioc level shall be adjusted according the total signal power Io at receiver input and the geometry factor Îor/Ioc. NOTE 5: The DPCH of all cells are located in a timeslot other than 0 B.6.1.1.1 Explanation difference In 1.28 Mcps TDD the PICH is mapped onto P-CCPCH as describe in TR25.928. So the PICH-Ec/Ior is no longer used. The function of the SCH is achieved by DwPTS in 1.28 Mcps TDD and it is allocated to a dedicated timeslot. And the P-CCPCH is always mapped onto time slot 0, so time slot 8 is not considered in 1.28 Mcps TDD. The parameter Îor/Ioc is measured to report to UE for its handover or cell selection and reselection. B.6.1.2 TDD inter frequency measurements If not otherwise stated, the test parameters in table B.19 should be applied for UE RX measurements requirements in this section. Table B.19: Intra frequency test parameters for UE RX Measurements Parameter Unit Cell 1 Cell 2 Timeslot Number 0 DwPTS 0 DwPTS T1 T2 T1 T2 T1 T2 T1 T2 UTRA RF Channel Number Channel 1 Channel 2 PCCPCH_Ec/Ior dB -3 -3 DwPCH_Ec/Ior dB 0 0 dB [3] [3] -Infinity [6] dBm/1.28 MHz -70 Range 1:Io Range 2:Io dBm -94..-70 –94..-50 -94..-70 –94..-50 Propagation condition AWGN NOTE 1: P-CCPCH_RSCP1,2  -[102] dBm. NOTE 2: | P-CCPCH_RSCP1 – PCCPCH_RSCP2 | 20 dB. NOTE 3: | Io –P-CCPCH_RSCP1,2|  [20] dB. NOTE 4: Ioc level shall be adjusted according the total signal power Io at receiver input and the geometry factor Îor/Ioc. NOTE 5: The DPCH of all cells are located in a timeslot other than 0 B.6.1.2.1 Explanation difference In 1.28 Mcps TDD the PICH is mapped onto P-CCPCH as describe in TR25.928. So the PICH-Ec/Ior is no longer used. The function of the SCH is achieved by DwPTS in 1.28 Mcps TDD and it is allocated to a dedicated timeslot. And the P-CCPCH is always mapped onto time slot 0, so time slot 8 is not considered in 1.28 Mcps TDD. The parameter Îor/Ioc is measured to report to UE for its handover or cell selection and reselection. B.6.1.3 UTRA carrier RSSI inter frequency measurements The table B.20 and notes 1,2 define the limits of signal strengths, where the requirement is applicable. Table B.20: UTRA carrier RSSI Inter frequency test parameters Parameter Unit Cell 1 Cell 2 UTRA RF Channei number - Channel 1 Channel 2 Îor/Ioc DB -1 -1 Ioc dBm/1.28 MHz Note 2 Note 2 Range 1: Io Range 2: Io dBm/1.28 MHz -94…-70 -94…-50 -94…-70 -94…-50 Propagation condition - AWGN NOTE 1: For relative accuracy requirement | Channel 1_Io –Channel 2_Io | < 20 dB. NOTE 2: Ioc level shall be adjusted according the total signal power Io at receiver input and the geometry factor Îor/Ioc. B.6.2 Measurement Performance for UTRAN If not otherwise stated, the test parameters in table B.21 should be applied for UTRAN RX measurements requirements in this section. Table B.21: Intra frequency test parameters for UTRAN RX Measurements Parameter Unit Cell 1 UTRA RF Channel number Channel 1 Timeslot [ ] DPCH Ec/Ior dB [ ] Îor/Ioc dB [ ] Ioc dBm/1.28 MHz -89 Range: Io dBm -105..-74 Propagation condition AWGN Annex C (informative): Measurement Channels C.1 General (void) C.2 Reference Measurement Channels (Downlink) C.2.0 UL reference measurement channel (12.2 kbps, for definition of UE Tx parameters) Table C.0 Parameter Value Information data rate 12.2 kbps RU's allocated 1TS (1*SF8) = 2RU/5ms Midamble 144 Interleaving 20 ms Power control (TPC) 4 Bit/user/10ms TFCI 16 Bit/user/10ms 4 Bit reserved for future use (place of SS) 4 Bit/user/10ms Inband signalling DCCH 2.4 kbps Puncturing level at Code rate 1/3: DCH / DCCH 33% / 33% Figure C.0 C.2.0.1 Rationale There is only one burst type for normal time slot in the low chip rate option. It provides the possibility for transmission of TFCI and TPC both in up- and downlink. The SS information will be used only in down link but in order to have the same burst structure for both directions the place of the SS bits are also reserved for up link and may be used in a future enhancement. Taking the mentioned features into consideration the up link multicode reference measurement channel can be the same as the down link 12.2kBit/s reference measurement channel (aligned to 3.84 Mcps TDD Option) with the exception that the SS bits are not used. The following example will be used from WG1 with 3.4kBit/sec signalling (signalling can be varied between 1.7kBit/sec and 3.4kBit/sec): NOTE: This example can be applied to multiplexing AMR speech and DCCH. Figure C.0A: Channel coding and multiplexing example for multiplexing of 12.2 kbps data and 3.4 kbps data Table C.0A: Physical channel parameters for multiplexing of 12.2 kbps data and 3.4 kbps data Codes and time slots SF8 x 1 code x 1 time slot TFCI 16 bits per user TPC + SS 2 bit + 2bit In WG4 the performance simulations have been done with a signalling of 2.4kBit/sec (as an average signalling rate). So the mapping above will be modified for the 2.4kbit/sec signalling rate also. C.2.1 DL reference measurement channel (12.2 kbps) Table C.1 Parameter Value Information data rate 12.2 kbps RU's allocated 1TS (2*SF16) = 2RU/5ms Midamble 144 Interleaving 20 ms Power control (TPC) 4 Bit/user/10ms TFCI 16 Bit/user/10ms Synchronisation Shift (SS) 4 Bit/user/10ms Inband signalling DCCH 2.4 kbps Puncturing level at Code rate 1/3: DCH / DCCH 33% / 33% Figure C.1 C.2.2 DL reference measurement channel (64 kbps) Table C.2 Parameter Value Information data rate 64 kbps RU's allocated 1TS (8*SF16) = 8RU/5ms Midamble 144 Interleaving 20 ms Power control (TPC) 4 Bit/user/10ms TFCI 16 Bit/user/10ms Synchronisation Shift (SS) 4 Bit/user/10ms Inband signalling DCCH 2.4 kbps Puncturing level at Code rate: 1/3 DCH / ½ DCCH 32% / 0 Figure C.2 C.2.3 DL reference measurement channel (144 kbps) Table C.3 Parameter Value Information data rate 144 kbps RU's allocated 2TS (8*SF16) = 16RU/5ms Midamble 144 Interleaving 20 ms Power control (TPC) 8 Bit/user/10ms TFCI 32 Bit/user/10ms Synchronisation Shift (SS) 8 Bit/user/10ms Inband signalling DCCH 2.4 kbps Puncturing level at Code rate: 1/3 DCH / ½ DCCH 38% / 7% Figure C.3 C.2.4 DL reference measurement channel (384 kbps) Table C.4 Parameter Value Information data rate 384 kbps RU's allocated 4TS (10*SF16) = 40RU/5ms Midamble 144 Interleaving 20 ms Power control (TPC) 16 Bit/user/10ms TFCI 64 Bit/user/10ms Synchronisation Shift (SS) 16 Bit/user/10ms Inband signalling DCCH Max.2 kbps Puncturing level at Code rate: 1/3 DCH / ½ DCCH 41% / 12% Figure C.4 C.2.4.1 Explanation difference For the 1.28 Mcps chip rate TDD option, one frame (10ms) consists of two sub-frames(5ms), and one Sub-frame consists of 7 timeslots. The structure of timeslot in 1.28 Mcps chip rate TDD (shown inTR25.928) is different from the structure of timeslot in 3.84 Mcps TDD. So the service mapping of variance data rate of 1.28 Mcps chip rate TDD option is different from that of 3.84 Mcps chip rate TDD option. C.2.5 BCH reference measurement channel [mapped to 2 code SF16] Table C.5 Parameter Value Information data rate: 12.3 kbps RU´s allocated 2 RU Midamble 144 chips Interleaving 20 ms Power control 0 bit TFCI 0 bit Puncturing level 13% Figure C.5 C.2.5.1 Rationale A test procedure was introduced for testing the UE BCH decoding performance. In WG1 the following service mapping for BCH was proposed: Table C.6 : Parameters for BCH Transport block size 246 bits CRC 16 bits Coding CC, coding rate = 1/3 TTI 20 ms Codes and time slots SF = 16 x 2 codes x 1 time slot TFCI 0 bit TPC 0 bit Figure C.6: Channel coding for BCH According to that service mapping the following BCH reference measurement channel will be proposed. C.2.6 UL multi code reference measurement channel (12.2 kbps) Table C.7 Parameter Value Information data rate 12.2 kbps RU's allocated 1TS (2*SF16) = 2RU/5ms Midamble 144 Interleaving 20 ms Power control (TPC) 4 Bit/user/10ms TFCI 16 Bit/user/10ms 4 Bit reserved for future use (place of SS) 4 Bit/user/10ms Inband signalling DCCH 2.4 kbps Puncturing level at Code rate 1/3: DCH / DCCH 33% / 33% Figure C.7 C.2.6.1 Rationale A test procedure was introduced for testing the UE PA linearity. For that purpose two codes will be transmitted from the UE and will be analyzed (peak code domain error). There is only one burst type for normal time slot in the low chip rate option. It provides the possibility for transmission of TFCI and TPC both in up- and downlink. The SS information will be used only in down link but in order to have the same burst structure for both directions the place of the SS bits are also reserved for up link and may be used in a future enhancement. Taking the mentioned features into consideration the up link multicode reference measurement channel can be the same as the down link 12.2kBit/s reference measurement channel (requirement is aligned to 3.84 Mcps TDD option) with the exception that the SS bits are not used. C.3 Reference measurement channels (Uplink) C.3.1 UL reference measurement channel (12.2 kbps) Table C.8 Parameter Value Information data rate 12.2 kbps RU's allocated 1TS (1*SF8) = 2RU/5ms Midamble 144 Interleaving 20 ms Power control (TPC) 4 Bit/user/10ms TFCI 16 Bit/user/10ms Synchronisation Shift (SS) 4 Bit/user/10ms Inband signalling DCCH 2.4 kbps Puncturing level at Code rate 1/3: DCH / DCCH 33% / 33% Figure C.8 C.3.2 UL reference measurement channel (64 kbps) Table C.9 Parameter Value Information data rate 64 kbps RU's allocated 1TS (1*SF2) = 8RU/5ms Midamble 144 Interleaving 20 ms Power control (TPC) 4 Bit/user/10ms TFCI 16 Bit/user/10ms Synchronisation Shift (SS) 4 Bit/user/10ms Inband signalling DCCH 2.4 kbps Puncturing level at Code rate: 1/3 DCH / ½ DCCH 32% / 0 Figure C.9 C.3.3 UL reference measurement channel (144 kbps) Table C.10 Parameter Value Information data rate 144 kbps RU's allocated 2TS (1*SF2) = 16RU/5ms Midamble 144 Interleaving 20 ms Power control (TPC) 8 Bit/user/10ms TFCI 32 Bit/user/10ms Synchronisation Shift (SS) 8 Bit/user/10ms Inband signalling DCCH 2.4 kbps Puncturing level at Code rate: 1/3 DCH / ½ DCCH 38% / 7% Figure C.10 C.3.4 UL reference measurement channel (384 kbps) Table C.11 Parameter Value Information data rate 384 kbps RU's allocated 4TS (1*SF2 + 1*SF8) = 40RU/5ms Midamble 144 Interleaving 20 ms Power control (TPC) 16 Bit/user/10ms TFCI 64 Bit/user/10ms Synchronisation Shift (SS) 16 Bit/user/10ms Inband signalling DCCH Max.2 kbps Puncturing level at Code rate: 1/3 DCH / ½ DCCH 41% / 12% Figure C.11 C.3.5 RACH reference measurement channel Table C.12 Parameter Value Information data rate: SF16 (RU’s allocated:1): 0% puncturing rate at CR=1/2 ~10% puncturing rate at CR=1/2 SF8 (RU’s allocated:2): 0% puncturing rate at CR=1/2 ~10% puncturing rate at CR=1/2 SF4 (RU’s allocated:4): 0% puncturing rate at CR=1/2 ~10% puncturing rate at CR=1/2 BRACH =1 CRC length = 16 Tail Bits = 8 20 bits per frame and TB 24 bits per frame and TB 64 bits per frame and TB 73 bits per frame and TB 152 bits per frame and TB 170 bits per frame and TB TTI 5msec Midamble 144 chips Power control 0 bit TFCI 0 bit NRACH = number of bits per TB BRACH = number of TBs NRM =puncturing rate C.3.5.1 RACH mapped to 1 code SF16 Figure C.12 C.3.5.2 RACH mapped to 1 code SF8 Figure C.13 C.3.5.3 RACH mapped to 1 code SF4 Figure C.14 C.3.5.3.1 Explanation difference For the 1.28 Mcps chip rate TDD option, one frame (10ms) consists of two sub-frames(5ms), and one Sub-frame consists of 7 timeslots. The structure of timeslot in 1.28 Mcps chip rate TDD (shown inTR25.928) is different from the structure of timeslot in 3.84 Mcps TDD. So the service mapping of variance data rate of 1.28 Mcps chip rate TDD option is different from that of 3.84 Mcps chip rate TDD option. Annex D (informative): Propagation conditions D.1 Static Propagation conditions The propagation for the static performance measurement is an Additive White Gaussian Noise (AWGN) environment. No fading and multi-path exist for the propagation model. D.2 Multi-path fading propagation conditions Table D.1 shows propagation conditions that are used for the performance measurements in multi-path fading environment. All taps have classical Doppler spectrum. Table D.1: Propagation Conditions for Multi-Path Fading Environments Case 1, speed 3km/h Case 2, speed 3km/h Case 3, speed 120km/h Relative Delay [ns] Average Power [dB] Relative Delay [ns] Average Power [dB] Relative Delay [ns] Average Power [dB] 0 0 0 0 0 0 2928 -10 2928 0 781 -3 12000 0 1563 -6 2344 -9 D.2.1 Rationale The channel estimation can only resolve paths which are separated by at least one chip in delay. Otherwise the paths fall into the same tap. Even though this happens in realistic environments, it is not useful to base the propagation models for the performance requirements on a scenario with a delay spread of less than 1 chip, because the baseband is not tested in this case. Therefore, it is proposed to keep the same delay for the path in units of chips for the 1.28 Mcps chip rate TDD-mode as for the 3.84 Mcps chip rate TDD-mode. The tap delays in units of time are changed accordingly to take into account the difference in the chip rate. Due to the request to have the same maximum delay spread for 1.28 Mcps chip rate TDD as for 3.84 Mcps chip rate TDD, the delay spread of tap 3rd for the case 2 propagation conditions is set to 12 ms. Annex E (informative): Environmental conditions E.1 General This normative annex specifies the environmental requirements of the UE. Within these limits the requirements of this specifications shall be fulfilled. E.2 Environmental requirements for the UE The requirements in this clause apply to all types of UE(s) E.2.1 Temperature The UE shall fulfil all the requirements in the full temperature range of: Table E.1 +15C – +35 C for normal conditions (with relative humidity of 25 % to 75 %); -10C ‑ +55C for extreme conditions (see IEC publications 68‑2‑1 and 68‑2‑2) Outside this temperature range the UE, if powered on, shall not make ineffective use of the radio frequency spectrum. In no case shall the UE exceed the transmitted levels as defined in TR25.945 UE Section for extreme operation. E.2.2 Voltage The UE shall fulfil all the requirements in the full voltage range, i.e. the voltage range between the extreme voltages. The manufacturer shall declare the lower and higher extreme voltages and the approximate shutdown voltage. For the equipment that can be operated from one or more of the power sources listed below, the lower extreme voltage shall not be higher, and the higher extreme voltage shall not be lower than that specified below. Table E.2 Power source Lower extreme voltage Higher extreme voltage Normal conditions voltage AC mains 0,9 * nominal 1,1 * nominal nominal Regulated lead acid battery 0,9 * nominal 1,3 * nominal 1,1 * nominal Non regulated batteries: Leclanché/lithium Mercury/nickel cadmium 0,85 * nominal 0,90 * nominal Nominal Nominal Nominal Nominal Outside this voltage range the UE if powered on, shall not make ineffective use of the radio frequency spectrum. In no case shall the UE exceed the transmitted levels as defined inTR25.945 UE section for extreme operation. In particular, the UE shall inhibit all RF transmissions when the power supply voltage is below the manufacturer declared shutdown voltage. E.2.3 Vibration The UE shall fulfil all the requirements when vibrated at the following frequency/amplitudes: Table E.3 Frequency ASD (Acceleration Spectral Density) random vibration 5 Hz to 20 Hz 0,96 m2/s3 20 Hz to 500 Hz 0,96 m2/s3 at 20 Hz, thereafter ‑3 dB/Octave Outside the specified frequency range the UE, if powered on, shall not make ineffective use of the radio frequency spectrum. In no case shall the UE exceed the transmitted levels as defined in TR25.945 UE section for extreme operation. E.2.4 Rationale The environmental conditions of UE specification is kept in line with 3.84 Mcps TDD, because these specification do not consider the bandwidth of the signal nor any other difference between 3.84 Mcps TDD and 1.28 Mcps TDD. Annex F (informative): Terminal capabilities (TDD) This section provides the UE capabilities related to this report. Notes: This section shall be aligned with TS 25.306 [15] regarding TDD RF parameters. These RF UE Radio Access capabilities represent options in the UE, that require signalling to the network. Table F.1 provides the list of UE radio access capability parameters and possible values for this report. Table F.1: RF UE Radio Access Capabilities UE radio access capability parameter Value range UE power class (TR25.945 section 5.2.2.1) 2, 3 NOTE: Only power classes 2 and 3 are part of R99 Radio frequency bands (TR25.945 section 5.1.2) a), b), c), a+b), a+c), a+b+c) Chip rate capability (25.945) 1.28 Mcps This section shall be aligned with TS 25.306 now, which includes the related chapters discussing both 3.84 Mcps TDD Option and 1.28 Mcps TDD Option UE Radio Access Capabilities. Therefore it is proposed to change some word descriptions in TR25.945. Annex G (informative): Methods of measurement G.1 Emission G.1.1 Methods of measurement and limits for EMC emissions Common with 3.84 Mcps Chip rate TDD option. G.1.2 Test configurations Common with 3.84 Mcps Chip rate TDD option. G.1.3 Radiated spurious emission from Base station and ancillary equipment G.1.3.1 Radiated spurious emission, Base stations G.1.3.1.1 Definition Common with 3.84 Mcps Chip rate TDD option. G.1.3.1.2 Test method a) Common with 3.84 Mcps TDD option. b) The BS shall transmit with maximum power declared by the manufacturer with all transmitters active. Set the base station to transmit a signal as stated in Table 8.3.2-1 of TR25.945. c) The received power shall be measured over the frequency range 30 MHz to 12.75 GHz, excluding 4MHz below the first carrier frequency to 4 MHz above the last carrier frequency used. The measurement bandwidth shall be 100 kHz between 30 MHz and 1 GHz and 1 MHz above 1 GHz as given in ITU-R SM.329 [16]. The video bandwidth shall be approximately three times the resolution bandwidth. If this video bandwidth is not available on the measuring receiver, it shall be the maximum available and at least 1 MHz. At each frequency at which a component is detected, the maximum effective radiated power of that component shall be determined, as described in step a). G.1.3.1.2.1 Explanation difference To identify responses on receivers or duplex transceivers occurring during the test at discrete frequencies which are narrow band responses, the test shall be repeated with the unwanted signal frequency increased, and then decreased by several bandwidths. Due to the different bandwidth of the low chip rate TDD option from that of the high chip rate TDD option, the frequency increased and/or decreased is changed from 10MHz to 3.2MHz, from 12.5MHz to 4MHz. G.1.3.1.3 Limits Common with 3.84 Mcps Chip rate TDD option. G.1.3.2 Radiated spurious emission, Ancillary equipment Common with 3.84 Mcps Chip rate TDD option. G.1.4 Conducted emission DC power input/output port Common with 3.84 Mcps Chip rate TDD option. G.1.5 Conducted emissions, AC mains power input/output port Common with 3.84 Mcps Chip rate TDD option. G.1.6 Harmonic Current emissions (AC mains input port) Common with 3.84 Mcps Chip rate TDD option. G.1.7 Voltage fluctuations and flicker (AC mains input port) Common with 3.84 Mcps Chip rate TDD option. G.2 Immunity Common with 3.84 Mcps Chip rate TDD option. Annex H (informative): Global in-channel Tx test H.1 General Description is common with 3.84 Mcps TDD option. H.2 Definition of the process H.2.1 Basic principle Description is common with 3.84 Mcps TDD option. H.2.2 Output signal of the Tx under test Description is common with 3.84 Mcps TDD option H.2.3 Reference signal Description is common with 3.84 Mcps TDD option H.2.4 Classification of measurement results Description is common with 3.84 Mcps H.2.5 Process definition to achieve results of type “deviation” Description is common with 3.84 Mcps TDD option. H.2.6 Process definition to achieve results of type “residual” Description is common with 3.84 Mcps TDD option. H.2.7 Error Vector Magnitude (EVM) Description is common with 3.84 Mcps TDD option. H.2.8 Peak Code Domain Error (PCDE) Description is common with 3.84 Mcps TDD option. H.3 Applications This process may be applied in the measurements defined in the following subclauses: 8.3.3 Frequency Stability 8.3.4 Output Power Dynamics
1cc4b09fd057c9a5cf925fb9b5a5f4e7
25.945
8.3.8.2 Peak Code Domain Error
H.4 Notes NOTE: Symbol length Description is common with 3.84 Mcps TDD option NOTE: Deviation Description is common with 3.84 Mcps TDD option. NOTE: Residual Description is common with 3.84 Mcps TDD option. NOTE: Scrambling code Description is common with 3.84Mpcs TDD option. NOTE: TDD Description is common with 3.84 Mcps TDD option. H.5 Rationale The global in-channel Tx test enables the measurement of all relevant parameters that describe the in-channel quality of the output signal of the Tx under test in a single measurement process, not only FDD and all options of TDD. Annex I (informative): Change History Table I.1: Change History TSG / Date Doc CR R Title Cat Curr New Work Item RP-15 Rel-5 version created by TSG RAN decision, no CRs 5.0.0 RP-23 RP-040038 0002 Correction of references to ITU recommendations F 5.0.0 5.1.0 TEI5 RP-35 RP-070081 0004 CR on Changing SEM for LCR TDD F 5.1.0 5.2.0 TEI5
7d3783c93dcb97023753560f1c6e0f1f
25.936
1 Scope
The purpose of the present document is to help the relevant 3GPP groups to specify the changes to existing specifications, needed for the introduction of the “Handover for real-time services from PS domain” Building Block for Release 2000. The purpose of this R00 work task is to define the relocation procedure to be used when real time services are supported in the PS domain. The intention with this work item is to provide support for services such as voice over IP and multimedia over IP. This TR focuses on the requirements for the solution. Possible solutions have been further studied and they are also described in this TR for comparison and evaluation against the requirements. In doing this work, RAN3 has identified some areas of study that are not primarily under RAN3’s responsibility. These are mentioned here so that work can be coordinated with the other 3GPP groups. Changes to the signalling protocols in UTRAN and CN interfaces have also been studied at a high level. This document is a ‘living’ document, i.e. it is permanently updated and presented to all TSG-RAN meetings.
7d3783c93dcb97023753560f1c6e0f1f
25.936
2 References
The following documents contain provisions which, through reference in this text, constitute provisions of the present document. • References are either specific (identified by date of publication, edition number, version number, etc.) or non‑specific. • For a specific reference, subsequent revisions do not apply. • 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. [1] UMTS 23.009: "3rd Generation Partnership Project (3GPP) Technical Specification Group Core Network; Handover Procedures". [2] UMTS 23.060: "3rd Generation Partnership Project (3GPP) Technical Specification Services and System Aspects; GPRS; Service Description". [3] Handovers for real-time services from PS domain, Work Item Description, TSG-RAN#7, submitted as RP-000127rev [4] UMTS 25.413: "3rd Generation Partnership Project (3GPP) Technical Specification Radio Access Network; UTRAN Iu interface RANAP signalling". [5] UMTS 21.905: "3rd Generation Partnership Project (3GPP) Technical Specification Services and System Aspects; Vocabulary for 3GPP specifications".
7d3783c93dcb97023753560f1c6e0f1f
25.936
3 Definitions, symbols and abbreviations
7d3783c93dcb97023753560f1c6e0f1f
25.936
3.1 Definitions
For the purposes of the present document, the following terms and definitions apply. SRNS relocation: The definition of [5] applies. Handover: The definition of [5] applies. Hard handover: The definition of [5] applies. Relocation, or Relocation of SRNS: The definition of [4] applies. Bi-casting: The capability of a node to receive original data, and send this data in its original form over two different paths. Duplication: The capability of a node to receive original data, and send this data over one path in its original form, as well as duplicating it and sending it in a different form over a different path. The duplicated data is in a different form than the original data received. RNC: When the procedures described in this document are applied in a GERAN context, the functions described as being part of an RNC, are part of a BSS. Therefore in this document, “RNC” should be understood as “RNC/BSS”.
7d3783c93dcb97023753560f1c6e0f1f
25.936
3.2 Symbols
None.
7d3783c93dcb97023753560f1c6e0f1f
25.936
3.3 Abbreviations
For the purposes of the present document, the following abbreviations apply: DL Downlink GGSN Gateway GPRS Support Node GTP GPRS Tunnelling Protocol N-PDU Network PDU PDCP Packet Data Convergence Protocol PDU Protocol Data Unit RLC Radio Link Protocol RNC Radio Network Controller RRC Radio Resource Control SGSN Serving GPRS Support Node UE User Equipment UL Uplink
7d3783c93dcb97023753560f1c6e0f1f
25.936
4 GSM and UMTS R99 status
None.
7d3783c93dcb97023753560f1c6e0f1f
25.936
4.1 GSM solution
Inter-BSC handovers in GSM are described in ref. [1]. The 2G systems have been optimised to minimize the interruption of speech during handovers. In DL the standards allow bi-casting from the MSC. In UL this is achieved by fast radio resynchronisation by the UE. Typical values are in the range of 60 to 120 ms in UL.
7d3783c93dcb97023753560f1c6e0f1f
25.936
4.2 UMTS R99 status
Relocation in UMTS R99 for the CS domain is described in ref. [1]. Similarly to the GSM solution, the interruption of speech during relocation has been minimised. In DL the standards allow bi-casting from the MSC. In UL this is achieved by fast radio resynchronisation by the UE. In UMTS R99, relocation for the PS domain is described in ref. [2]. It only specifies lossless relocation for non real-time services with high reliability. The basic principle of the release 99 data forwarding is described as follows: 1) At a given point of time before execution of Relocation of SRNS, source RNC stops to transmit DL data to UE, 2) Source RNC starts to forward to the target RNC, via an GTP tunnel between the RNCs, all the GTP-PDUs which were not transmitted to UE and which continue to arrive from source SGSN to source RNC. 3) Source RNC should store all forwarded data also within source RNC, which ensures lossless operation in Relocation of SRNS failure cases. 4) Target RNC stores all GTP data forwarded from source RNC and when Serving RNC operation is started, target RNC starts the DL data transmission from the first forwarded GTP-PDU. The R99 mechanism was originally designed for non-real-time services. The principle is that the N-PDUs are forwarded from the source RNC buffers to the target RNC. Data buffering is not adapted to real-time services, and means that interruption may exceed the requirement for real-time services.
7d3783c93dcb97023753560f1c6e0f1f
25.936
5 Requirements
None.
7d3783c93dcb97023753560f1c6e0f1f
25.936
5.1 General
General requirement is to minimise disruption to the user.
7d3783c93dcb97023753560f1c6e0f1f
25.936
5.2 Packet loss
Frame loss can already occur over the radio. Therefore when relocation occurs, any frame loss happens in addition to the frames lost over the radio. Therefore frame loss should be minimised. As a reference, in CS wireless speech, the FER must not be greater than 1%. The packet loss should be similar to what is achieved currently in 2G systems for CS wireless speech, or smaller.
7d3783c93dcb97023753560f1c6e0f1f
25.936
5.3 Round-trip delay
- The round-trip delay should be minimised in real-time conversational services. - The round-trip delay should be similar to what is achieved currently in 2G systems for CS wireless speech, or smaller. - The global delay variation should be minimised.
7d3783c93dcb97023753560f1c6e0f1f
25.936
5.4 Speech interruption
The speech interruption should be similar to what is achieved currently in 2G systems for CS wireless speech, or smaller.
7d3783c93dcb97023753560f1c6e0f1f
25.936
5.5 Frequency of interruption
The number and frequency of interruption perceived by the user should be minimised.
7d3783c93dcb97023753560f1c6e0f1f
25.936
5.6 Security
Editor’s Note: This section is intended to list any security requirements for the real-time handover solution.
7d3783c93dcb97023753560f1c6e0f1f
25.936
5.7 Inter-system operation
It is required that the real-time relocation solution for PS domain works with a rel4 Core Network and a GERAN. The assumption is that the GERAN will be connected to the rel4 Core Network via the Iu-PS.
7d3783c93dcb97023753560f1c6e0f1f
25.936
5.8 Backwards compatibility
The real-time relocation solution shall be backwards compatible with UMTS R99 UEs.
7d3783c93dcb97023753560f1c6e0f1f
25.936
5.9 General applicability of the selected solution
It is required, that a unique solution will be finally selected supporting - hard handover (“UE involved”) - SRNS Relocation (“UE not involved”) - inter-system operation (GERAN<->UTRAN) and - intra-system operation (GERAN, UTRAN). The solution shall, additionally, take care of an optimum support for intra-SGSN relocation as well as for the inter-SGSN case.
7d3783c93dcb97023753560f1c6e0f1f
25.936
5.10 Alignment of selected solution with transport mechanisms within Rel4 CN
It is required that the selected solution takes into consideration transport mechanisms selected for the Rel4 PS CN. If the Rel4 transport protocols for the PS domain utilises/requires resource reservation or initialisation of transport characteristics (like is done in CS domain), it shall be ensured that these mechanisms / initialisations / set-up are performed prior to the execution of relocation, as subsequent, delayed bearer setup [Note: whatever “bearer setup” will be called in an Rel4 PS domain] would cause an additional recognisable delay on the overall relocation process, which should be avoided.
7d3783c93dcb97023753560f1c6e0f1f
25.936
5.11 Support for multiple simultaneous RABs with different QoS
It shall be capable to relocate/handover multiple RABs belonging to the same UE with the same signalling transaction on the Iu interface. These RABs, including the RAB for call control signalling, may belong to different QoS classes, and some of them may require lossless relocation/handover.
7d3783c93dcb97023753560f1c6e0f1f
25.936
6 Study areas
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.1 Solution 1: Reuse of release 99 Packet Duplication mechanism
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.1.1 General
The idea of Solution 1 is to reuse the release 99 Data forwarding mechanism also for real time services requiring seamless Relocation of SRNS. Seamless Relocation of SRNS means that the interruptions to the data stream flow are minimised and are basically unnoticeable by the users. The basic principle of SRNC duplication mechanism would be as follows: 1) At a given point of time before execution of Relocation, source RNC starts to duplicate DL GTP-PDUs: one copy is sent to local PDCP/RLC/MAC, and the other copy is forwarded to the target RNC. 2) Source RNC continues processing and sending DL data normally towards the UE. 3) Target RNC discards all forwarded GTP-PDUs arriving to target RNC until Serving RNC operation is started. 4) When target RNC takes over the serving RNC role, it starts to process the arriving DL GTP-PDUs and send DL data to the UE. Figure 1: Packet flows during relocation, solution 1 The uplink flow is routed as in R99. The only addition compared to R99 solution is that the source RNC would, during an interim state, duplicate downlink flow to both the UE directly and to the forwarding tunnel.
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.1.2 The main steps of Relocation for data forwarding
[Note: Since for the solution 1 the procedures and mechanisms of performing Relocation of SRNS for all RABs from PS domain are the same, both the handling of lossless and Seamless RABs during Relocation of SRNS are described in this chapter.]
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.1.2.1 Preparation of Relocation of SRNS and Resource allocation
In this phase the UTRAN reserves resources for the relocation. Specifically for Solution 1, it is assumed that lossless and seamless existing RABs are set to be "subject to data forwarding" in Relocation Command. At the end of the preparation phase source RNC should: - for lossless RABs; stop processing DL GTP-PDUs data - for seamless RABs; continue to process and transmit DL data normally towards UE - for lossless and seamless RABs; start duplicating all arrived and not acknowledged & arriving DL GTP-PDUs towards target RNC - for lossless RABs; store all buffered & arriving DL GTP-PDUs When data forwarding is started, target RNC should: - for lossless RABs; store all arriving DL GTP-PDUs - for seamless RABs: discard all arriving DL GTP-PDUs Figure 2: Control Plane - Preparation of Relocation of SRNS and Resource allocation phase Figure 3: User Plane - Preparation of Relocation of SRNS and Resource allocation (SRNS Relocation) Figure 4: User Plane - Preparation of Relocation of SRNS and Resource allocation (Hard Handover) 1.1.1.1 Moving the Serving RNC role to target RNC When source RNC is ready for Relocation of SRNS Execution, it issues the SRNS Relocation Commit or commands the UE to make Hard Handover by appropriate Radio interface procedure. For lossless RABs source RNC should forward the Sequence number information to target RNC as defined in Release 99. After the reception of Relocation Commit from Iur, or when UEs access to target RL is detected by target RNC, target RNC takes over the Serving RNC role. At this point of time target RNC should: for all lossless and seamless RABs; start UL reception of data and start transmission of UL GTP-PDUs towards CN via the new GTP tunnels. The radio interface protocols may need to be reset in order to start radio interface reception. - for seamless RABs; start processing the arriving DL GTP-PDUs and start DL transmission towards the UE. The radio interface protocols may need to be reset in order to start radio interface transmission. for lossless RABs: start processing the buffered and arriving DL GTP-PDUs and start DL transmission towards UE. The radio interface protocols are reset as specified for Release 99 by R2. Figure 5: Control Plane - Moving the Serving RNC role to target RNC Figure 6: User Plane - Moving the Serving RNC role to target RNC (SRNS Relocation) Figure 7: User Plane - Moving the Serving RNC role to target RNC (Hard Handover)
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.1.2.3 Switching of DL flow in CN and Completion
In this phase, the DL GTP tunnel is updated between the SGSN and the GGSN so that the DL flow can use the new route. The mechanism shown assumes that the DL GTP port used for a given RAB in target RNC is the same for all arriving GTP-PDUs regardless of their arrival route. Only effect to the UTRAN may be the slightly earlier arrival time of DL-GTP PDUs from SGSN to target RNC. This is handled, as normal arrival time variation, by user plane buffering mechanisms existing in RNC. The additional buffering can be utilised and gradually reduced when the UE moves further from the new serving RNC and the Iur+Iub delays thus increase. Figure 8: Control Plane - Switching of DL flow in CN phase Figure 9: User Plane - Switching of DL flow in CN The forwarding tunnel(s) is released with timer supervision as in R99.
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.1.3 Specifications Impact
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.1.3.1 Impacts on RAN3 specifications
The Solution 1 reuses the Release 99 data forwarding mechanisms also for the seamless RABs from PS domain. Solution 1 does not require any new procedures, messages nor information elements to be introduced to any RAN 3 specification. In R99, there is a clear indication in the RAB parameters used at RAB assignment that a RAB is to be treated in a “lossless” or “other” way. Therefore a new value for that Information Element is needed to indicate “seamless” to the source RNC. When specifying the release 99 RANAP it was decided by RAN3 to not specify the handling of user plane in application part specifications. This was decided to keep complete independence of user and control plane handling from the stage 3 specification point of view. This independence should be preserved, and the handling of the control and user plane should be specified in appropriate stage 2 specifications (23.060). RANAP specification should be updated to include a new value "real-time" for the Relocation Requirement IE, and a reference to 23.060 for the User Plane Handling in each case.
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.1.3.2 Impacts on other groups’ specifications
Depending on RAN 2 opinion, maybe addition of one parameter to RRC container could ensure the unambiguous operation of the solution 1. (See the chapter describing the Open Issues). Stage 2 specification TS 23.060 has to be aligned with the selected solution for RT PS domain Relocation of SRNS. The consistent handling of User Plane and Control Plane together is a matter for stage 2 specifications. The following information should be included, in the form that is most appropriate: After Relocation Preparation is successfully terminated and before Relocation of SRNS execution is triggered the Source RNC should: - for lossless RABs; stop processing DL GTP-PDUs data - for seamless RABs; continue to process and transmit DL data normally towards UE - for lossless and seamless RABs; start duplicating all arrived and not acknowledged & arriving DL GTP-PDUs towards target RNC - for lossless RABs; store all buffered & arriving DL GTP-PDUs After Relocation Resource Allocation procedure is successfully terminated but the serving RNC role is not yet taken over by target RNC and when DL user plane data starts to arrive to target RNC the target RNC should: - for lossless RABs; store all arriving DL GTP-PDUs - for seamless RABs: discard all arriving DL GTP-PDUs When triggering the execution of Relocation of SRNS, source RNC should forward the Sequence number information to target RNC for all lossless RABs as defined in Release 99. After reception of Relocation Commit from Iur, or in UE involved case when UEs access to target cell is detected by target RNC, target RNC takes over the Serving RNC role. At this point of time the new Serving RNC should: - for all lossless and seamless RABs; start UL reception of data and start transmission of UL GTP-PDUs towards CN via the new GTP tunnels. The radio interface protocols may need to be reset in order to start air interface reception. - for seamless RABs; start processing the arriving DL GTP-PDUs and start DL transmission towards the UE. The radio interface protocols may need to be reset in order to start air interface transmission. - for lossless RABs: start processing the buffered and arriving DL GTP-PDUs and start DL transmission towards UE. The radio interface protocols are reset as specified for Release 99 by RAN2. No other impacts to any 3GPP specification in any other 3GPP groups are seen.
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.1.4 Interaction with other systems
This section is intended to explain how this solution will work with other systems such as GERAN, UTRAN R99, GSM and GPRS. This is subject to information availability for these other systems.
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.1.5 Summary: solution 1
This solution is based on making some procedure enhancements to the R99 mechanisms. During an interim state, the processing of the real time data is done at the source RNC so that the source RNC both sends the traffic to the UE, and forwards it to the target RNC. This solution also assumes that considering the nature of RT services, there is no need to buffer any DL or UL traffic in the involved nodes. The Solution 1 reuses the Release 99 data forwarding mechanisms also for the seamless RABs from PS domain. Solution 1 does not require any new procedures, messages nor information elements to be introduced to any RAN 3 specification. In any relocation case (all scenarios described in 5.9), for DL data of seamless RABs there are two possible situations when frame gap or overlapping may happen: 1. The frame overlap/gap may be introduced when target RNC takes the Serving RNC role and starts to produce the DL data from forwarded GTP-PDUs. In this case the estimated gap/overlap is equal to: - For SRNS relocation: the delay difference between the transport bearer used for Iur DCH data stream and the transport bearer used for data forwarding GTP tunnel both of which are setup between the same source and target RNCs. - For hard handover: the delay of the GTP tunnel used for data forwarding. This first instance of frame overlap coincides with radio hard handover. If the transport bearer delay difference is smaller than the air interface Transmission Time Interval (TTI) (10, 20, 40 or 80 ms depending on the service) the amount of gap/overlap is most likely non existent. 2. The additional frame gap may be introduced when the CN transport is optimised. In this case the gap will exist only if the delay via the optimised route is larger than the delay via the forwarding route.
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.1.6 Open issues
None.
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.2 Solution 2: Core Network bi-casting
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.2.1 General
The Core Network bi-casting mechanism handles real-time data from the GGSN/SGSN based on the model from GSM and the CS domain in UMTS R99. The principle is that the packet anchor is at the GGSN/SGSN which acts as the equivalent of the three-party bridge in the CS domain MSC. During the relocation, real-time downlink N-PDUs are duplicated at the GGSN and sent to the source RNC as well as to the target RNC. Additionally, at the moment the target RNC takes the role of serving RNC, it immediately begins sending uplink N-PDUs towards GGSN via the new SGSN. The uplink flow is routed as in R99. Figure 10: Packet flows during relocation, solution 2
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.2.2 Relocation involving 2 SGSNs
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.2.2.1 Preparation
In this phase the UTRAN reserves resources for the relocation. Then the source SGSN and source RNC are informed when the target RNC is ready. The GGSN is also instructed to start bi-casting downlink N-PDUs as part of the Relocation preparation process. As an implementation choice in the SGSN, this can happen in parallel with the signalling over the Iu interface, as shown in the picture below. This is because there is no need to get any information from the Relocation Request Acknowledge before initiating the Update PDP context. This means that at the SGSN2, the Update PDP context response and the Relocation Request Ack can be received in any order, but have to be received by SGSN2 so that it can send a Forward Relocation Response to SGSN1. The Update PDP context request/response is applicable to one PDP context only, therefore one will be done for each RAB. Each request can include the instruction to start bi-casting (seamless RAB), or not (lossless or other RAB). Should the GGSN reject the bi-casting request, the entire relocation procedure shall be aborted. The original RAB/PDP Context continues unaffected by this abort. Likewise, any PDP Contexts which have begun bi-casting must be updated to revert back to the original configuration. This behaviour is described in more depth in the error handling procedure definition below. Figure 11 : Control Plane – Preparation involving 2 SGSNs In the Forward Relocation Response, the RAB setup information is conditional because it is only applicable to lossless RABs. For seamless RABs, this RAB setup information is not included. For lossless RABs, this RAB setup information is included and it instructs SGSN1 of the RNC TEID and RNC IP address for data forwarding from source RNC to target RNC. Figure 12: User Plane – Bi-casting of DL flow with 2 SGSNs involved (SRNS Relocation) Figure 13: User Plane – Bi-casting of DL flow with 2 SGSNs involved (Hard Handover) Handling of error cases in the Preparation phase: If the SGSN1 decides to not accept the relocation from the source RNC after reception of message RELOCATION REQUIRED, the SGSN1 shall send a RELOCATION PREPARATION FAILURE message to the source RNC. If the SGSN2 decides to not accept the relocation, it shall deactivate the PDP context and send a Forward Relocation Response to the SGSN1 as a response of the Forward Relocation Request, with a cause value other than ‘Request accepted’. The SGSN1 can then send a RELOCATION PREPARATION FAILURE message to the source RNC. In case the GGSN is not able to accept the request for the bi-casting, the Update PDP context response message shall be sent from the GGSN to the SGSN2 as a response of the Update PDP Context Request, with a new cause value ‘Bi-casting not supported’, or ‘Bi-casting not possible’. In this case the SGSN2 shall deactivate the PDP context and send a Forward Relocation Response to the SGSN1 as a response of the Forward Relocation Request, with the cause value from the GGSN (‘Bi-casting not supported’, or ‘Bi-casting not possible’). The SGSN1 can then decide to: 1. send a RELOCATION PREPARATION FAILURE message to the source RNC. This cancels the relocation for all RABs 2. In the case that there are other RABs that do not need seamless treatment, the SGSN1 can send a RAB assignment request modifying the (new parameter) in the RAB parameters to be “other” In case one of the GGSNs involved decide not to accept the request for relocation, the GGSN that can not accept the relocation will trigger the same process. The source RNC, when it receives RELOCATION PREPARATION FAILURE from the CN, shall initiate the Relocation Cancel procedure on the other Iu signalling connection for the UE if the other Iu signalling connection exists and if the Relocation Preparation procedure is still ongoing or the procedure has terminated successfully in that Iu signalling connection. In case any of the SGSNs or GGSNs involved decide not to accept the relocation, and if the Iu signalling connection has been established or later becomes established, the SGSN2 shall also initiate the Iu Release procedure towards the target RNC with the cause value "Relocation Cancelled". If the target RNC can not accept the relocation of SRNS or a failure occurs during the Relocation Resource Allocation procedure in the target RNC, the target RNC shall send RELOCATION FAILURE message to the SGSN2. The SGSN2 shall then deactivate the PDP context and send a Forward Relocation Response to the SGSN1 as a response of the Forward Relocation Request, with a cause value other than ‘Request accepted’. The SGSN1 shall then send RELOCATION PREPARATION FAILURE message to the source RNC. If the source RNC decides to cancel the relocation, it shall send RELOCATION CANCEL to SGSN1. The SGSN1 shall then terminate the possibly ongoing Relocation Preparation procedure towards the target RNC by sending Relocation Cancel Request to the SGSN2 which then initiate the Iu Release procedure towards the target RNC with the cause value "Relocation Cancelled". Also if the GGSN had already been instructed to start bi-casting then the SGSN1 sends an Update PDP context request to the GGSN. This instructs the GGSN to stop bi-casting, and releases the newly created GTP tunnel between target SGSN and GGSN.
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.2.2.2 Bi-casting of DL flow and switching of UL flow
In this phase, DL traffic is bi-casted from the GGSN to the target RNC (as well as to the source RNC). Also at this point in both the hard handover and SRNS relocation cases, the UE sends UL traffic to the target RNC and UL traffic needs to be switched to the target SGSN and GGSN, using the new route. Figure 14: Control Plane - Bi-casting of DL flow and switching of UL flow phase with 2 SGSNs involved Handling of abnormal conditions in the Bi-casting phase: If the RELOCATION DETECT message is not received by the SGSN before reception of RELOCATION COMPLETE message, the SGSN shall handle the RELOCATION COMPLETE message normally. Figure 15: Moving the serving RNC role to target RNC with 2 SGSNs involved (SRNS Relocation) Figure 16: Moving the serving RNC role to target RNC with 2 SGSNs involved (Hard Handover)
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.2.2.3 Completion
This is the completion of the signalling. Also, the GGSN is instructed to stop bi-casting downlink N-PDUs. At this stage, the relocation has effectively already been completed. Note that SGSN2 informs SGSN1 that the relocation is complete once all of the GGSNs involved have stopped the bi-casting. Then it informs SGSN1 to release the Iu connection towards the Source RNC. Figure 17: Control Plane – Completion with 2 SGSNs involved Figure 18: User Plane – Completion with 2 SGSNs involved
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.2.3 Relocation involving only one SGSN
In the case that the relocation involves only one SGSN, the flow of N-PDUs across the Gn interface does not need to be changed. Indeed, the tunnel switching point in the SGSN can serve as the anchor for the tunnel instead of the GGSN as proposed above. Figure 19: Packet flows during relocation with only one SGSN involved, solution 2 As illustrated in the above figure, the SGSN forwards N-PDUs from either the source RNC or the target RNC allowing the N-PDUs to start flowing from the DRNC as soon as possible after the switchover. The procedure is explained below with the change in operation when the GGSN is not involved.
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.2.3.1 Preparation
In this phase the UTRAN reserves resources for the relocation. Then the source SGSN and source RNC are informed when the target RNC is ready. The SGSN starts bi-casting downlink N-PDUs as part of the Relocation preparation process. Figure 20: Control Plane – Preparation phase with only one SGSN Handling of abnormal conditions in the Preparation phase: If the SGSN decides to not accept the relocation from the source RNC after reception of message RELOCATION REQUIRED, the SGSN shall stop timer TRELOCalloc and send a RELOCATION PREPARATION FAILURE message to the source RNC. If the Iu signalling connection has been established or later becomes established, the SGSN shall also initiate the Iu Release procedure towards the target RNC with the cause value "Relocation Cancelled". If the target RNC can not accept the relocation of SRNS or a failure occurs during the Relocation Resource Allocation procedure in the target RNC, the target RNC shall send RELOCATION FAILURE message to the SGSN. The SGSN shall then send RELOCATION PREPARATION FAILURE message to the source RNC. If the source RNC decides to cancel the relocation, it shall send RELOCATION CANCEL to SGSN. The SGSN shall then terminate the possibly ongoing Relocation Preparation procedure towards the target RNC by initiating the Iu Release procedure towards the target RNC with the cause value "Relocation Cancelled". EMBED Word.Picture.8 Figure 21: User Plane - Bi-casting of DL flow with only one SGSN (SRNS Relocation) Figure 22: User Plane - Bi-casting of DL flow with only one SGSN (Hard Handover)
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.2.3.2 Bi-casting of DL flow and switching of UL flow
In this phase, DL traffic is bi-casted from the SGSN to the target RNC (as well as to the source RNC). Also at this point in both the hard handover and SRNS relocation cases, the UE sends UL traffic to the target RNC and UL traffic needs to be switched to the SGSN and using the new route. Figure 23: Control Plane - Bi-casting of DL flow and switching of UL flow phase with only one SGSN Figure 24: Moving the serving RNC to target RNC with only one SGSN (SRNS Relocation) Figure 25: Moving the serving RNC to target RNC with only one SGSN (Hard Handover)
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.2.3.3 Completion
This is the completion of the signalling. Also, the SGSN is instructed to stop bi-casting downlink N-PDUs. At this stage, the relocation has effectively already been completed. Figure 26: Control Plane – Completion phase with only one SGSN Handling of abnormal conditions in the Completion phase: If the RELOCATION DETECT message is not received by the SGSN before reception of RELOCATION COMPLETE message, the SGSN shall handle the RELOCATION COMPLETE message normally. Figure 27: User Plane – Completion phase with only one SGSN
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.2.4 Specifications Impact
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.2.4.1 Impacts on RAN3 specifications
Solution 2 does not require any new procedures or messages to be introduced to any RAN 3 specification. In R99, there is a clear indication in the RAB parameters used at RAB assignment that a RAB is to be treated in a “lossless” or “other” way. Therefore a new value for that Information Element is needed to indicate “seamless” to the source RNC.
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.2.4.2 Impacts on other groups’ specifications
The impacts to other groups' specifications relate to inclusion of bi-casting from GGSN to the Gn interface specification and corresponding stage 2 specifications. Procedures to initialise and terminate the GGSN bicasting from SGSN including error cases needs to be defined by TSG CN WG4. 29.060 example changes: The Bi-cast request indicates to the GGSN the requirement for real-time relocation. Information Elements in an SGSN-Initiated Update PDP Context Request Information element Presence requirement Reference Recovery Optional 7.7.11 Tunnel Endpoint Identifier for Data (I) Mandatory 7.7.13 Tunnel Endpoint Identifier Control Plane Conditional 7.7.14 NSAPI Mandatory 7.7.17 Trace Reference Optional 7.7.24 Trace Type Optional 7.7.25 SGSN Address for Control Plane Mandatory GSN Address 7.7.32 SGSN Address for User Traffic Mandatory GSN Address 7.7.32 Quality of Service Profile Mandatory 7.7.34 TFT Optional 7.7.36 Trigger Id Optional 7.7.41 OMC Identity Optional 7.7.42 Bi-cast request Conditional New reference Private Extension Optional 7.7.44 Bi-casting Request Information Element Bits Octets 8 7 6 5 4 3 2 1 1 Type=? (Decimal) 2 1 1 1 1 Spare 1 1 1 Bi-cast Req Bi-casting Request Values Bi-casting request Value (Decimal) Stop 0 Start 1 New cause value response rej Bi-casting not supported New Bi-casting not possible New When creating a new PDP context, an indication is needed to indicate that the RAB is to be treated in a seamless way. GTP-U changes to flag packets as bi-casted are needed. The spare bit (bit 4) of octet 1 in the GTP header (defined in Figure 2 of section 6 of 29.060) could be utilized to indicate if a packet was bi-casted. Stage 2 specification TS 23.060 has to be aligned with the selected solution for RT PS domain Relocation of SRNS.
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.2.5 Interaction with other systems
The Core Network bi-casting solution will work with a GERAN connected via the Iu-PS in exactly the same way as with a UTRAN connected via the Iu-PS. Therefore all the description above is applicable to GERAN, with the RNC being replaced by a BSS (can contain BSCs or not). There is no other functionality required at the BSS other than supporting the messaging for the Iu-PS (release 4). If a release 4 Core Network is connected to a GPRS BSS, since there is no Iu-PS, no relocation can be provided. If a release 4 Core Network is connected to a R99 UTRAN, then for lossless RABs, the Core Network can request data forwarding. For seamless RABs, the Core Network can not request data forwarding, and won’t do bi-casting either since R99 UTRAN does not support real-time services. The SGSN will request handover treatment from the RNC as follows: Rel 99 CN Rel 4 CN Rel 99 UTRAN Will only request lossless or other Will request lossless, other or seamless (which will fail) Rel 4 UTRAN Will only request lossless or other Will request lossless, seamless or other – can all be supported by UTRAN If the handover is between UMTS Rel 4 and UMTS R99, we will have the following: To From Rel 99 UTRAN + Rel 99 CN Rel 99 UTRAN + Rel 4 CN Rel 4 UTRAN + Rel 99 CN Rel 4 UTRAN + Rel 4 CN Rel 99 UTRAN + Rel 99 CN Lossless or other Lossless or other Lossless or other Lossless or other Rel 99 UTRAN + Rel 4 CN Lossless or other Lossless or other Lossless or other Lossless or other Rel 4 UTRAN + Rel 99 CN Lossless or other Lossless or other Lossless or other Lossless or other Rel 4 UTRAN + Rel 4 CN Lossless or other Lossless or other Lossless or other Lossless, seamless or other If the handover is inter-system from UMTS Rel 4 to GPRS, then the same principle of Core Network bi-casting can be applied. This means real-time support could be provided for that type of handover, assuming that the SGSN in the GPRS network can use the latest version of GTP-C. There is no requirement for the GPRS SGSN to support an Iu interface for real-time support. If the handover is inter-system from GPRS to UMTS Rel 4, then no relocation is triggered.
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.2.6 Summary: solution 2
In the Core Network bi-casting solution, handling of the real time data is done at the GGSN. Real time support requires that the GGSN is able to bi-cast the DL traffic to the target RNC. In the case of relocation involving only one SGSN, the SGSN may perform the bi-casting without involving the GGSN. In any relocation case (all scenarios described in 5.9), for DL data of seamless RABs there is one possible situation when frame gap or overlapping may happen. The frame overlap/gap may be introduced when target RNC takes the Serving RNC role and starts to produce the DL data from the bi-casted GTP-PDUs. In this case the estimated gap/overlap is equal to: - For SRNS relocation: the delay difference between the transport bearer used for Iur DCH data stream and the transport bearer used for the new GTP tunnels - For hard handover: the delay difference between the transport bearer used for the original GTP tunnels and the transport bearer used for the new GTP tunnels. This frame overlap/gap coincides with radio hard handover. The gap will exist only if the delay via the new route is larger than the delay via the original route. To support handovers for real time services from the PS domain with the Core Network bi-casting solution, procedural changes are required at the SGSN, GGSN, and RNC.
7d3783c93dcb97023753560f1c6e0f1f
25.936
6.2.7 Open issues
7d3783c93dcb97023753560f1c6e0f1f
25.936
7 Open items for all solutions
Real time PDCP numbers are a RAN2 issue that has not been resolved yet. The questions to be solved with R2 include whether the RAB contexts (i.e. the sequence numbers) need to be between RNCs or not, and whether the header compression/stripping solution to be selected allows that transmission to UE continues via the Iur (i.e. effectively making the context in RELOCATION COMMIT message outdated). According to the UMTS release 99 specifications, PDCP sequence numbers are exchanged with the UE as follows: - UL: The target RNC can determine the UL sequence number which according to the header decompression information should be the next PDCP to be received from the UE. To do this, the RNC uses the PDU causing the RLC to re-establish.. This UL sequence number given by the RNC might be a few sequence numbers lower than the assumption of UE, since it has still maybe sent a few PDUs via source RNC after commit. UE should roll back the PDCP header compression and thus base the next compressed header of the next real-time PDU to the header information of the UL PDU considered as the last received by the target RNC (the indicated one - 1). - DL: Similarly UE indicates in the PDU acknowledging the RLC re-establishment the DL Sequence number which PDU according to the DL header decompression information in the UE should next be received by UE. This is not generally the first forwarded but one of the first ones. Target RNC selects appropriate forwarded PDU and bases its header compression to the header of the 'indicated DL PDCP PDU-1'.
7d3783c93dcb97023753560f1c6e0f1f
25.936
8 Comparison of the solutions
Both solutions meet the requirements defined in this TR. In addition, the following differences are pointed out: Solution 1 (SRNC duplication) Solution 2 (Core Network Bi-casting) For a rel4 UTRAN, user data path between RNCs is same as in lossless relocation for R99 User data path for real-time is different from user data path for lossless data in R99 Utilises a N-PDU duplication mechanism in the RNC/BSS Utilises a duplication mechanism in the GGSN and optionally in the SGSN, during an intermediate state of the relocation For DL, two instances of frame gap/overlapping may occur For DL, one instance of frame gap/overlapping may occur Execution of relocation is performed after relocation resource allocation Execution of relocation is performed after relocation resource allocation and PDP context update procedures that are initiated in parallel
7d3783c93dcb97023753560f1c6e0f1f
25.936
9 Agreements
Solution 1 has been agreed for handling relocation for real time services from PS domain Rel 4. Annex A (informative): Change History Change history Date TSG # TSG Doc. CR Rev Subject/Comment Old New 03/2001 11 RP-010132 - - Approved at TSG RAN #11 and placed under Change Control 2.0.0 4.0.0 12/2001 14 - - - Formatting corrections 4.0.0 4.0.1
dc7f93eeb005e644aa8f154545a30461
29.198-04
1 Scope
The present document is Part 4 of the Stage 3 specification for an Application Programming Interface (API) for Open Service Access (OSA). The OSA specifications define an architecture that enables application developers to make use of network functionality through an open standardised interface, i.e. the OSA APIs. The concepts and the functional architecture for the OSA are contained in 3GPP TS 23.127 [3]. The requirements for OSA are contained in 3GPP TS 22.127 [2]. The present document specifies the Call Control Service Capability Feature (SCF) aspects of the interface. All aspects of the Call Control SCF are defined here, these being: • Sequence Diagrams • Class Diagrams • Interface specification plus detailed method descriptions • State Transition diagrams • Data definitions • IDL Description of the interfaces The process by which this task is accomplished is through the use of object modelling techniques described by the Unified Modelling Language (UML). This specification has been defined jointly between 3GPP TSG CN WG5, ETSI TISPAN and The Parlay Group, in co-operation with a number of JAIN™ Community member companies.
dc7f93eeb005e644aa8f154545a30461
29.198-04
2 References
The following documents contain provisions which, through reference in this text, constitute provisions of the present document. • References are either specific (identified by date of publication, edition number, version number, etc.) or non‑specific. • For a specific reference, subsequent revisions do not apply. • 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. [1] 3GPP TS 29.198-1 "Open Service Access; Application Programming Interface; Part 1: Overview". [2] 3GPP TS 22.127: "Service Requirement for the Open Services Access (OSA); Stage 1". [3] 3GPP TS 23.127: "Virtual Home Environment (VHE) / Open Service Access (OSA)". [4] 3GPP TS 22.002: "Circuit Bearer Services Supported by a PLMN". [5] ISO 4217 (1995): "Codes for the representation of currencies and funds". [6] 3GPP TS 24.002: "GSM-UMTS Public Land Mobile Network (PLMN) Access Reference Configuration". [7] 3GPP TS 22.003: "Circuit Teleservices supported by a Public Land Mobile Network (PLMN)".
dc7f93eeb005e644aa8f154545a30461
29.198-04
3 Definitions and abbreviations
dc7f93eeb005e644aa8f154545a30461
29.198-04
3.1 Definitions
For the purposes of the present document, the terms and definitions given in TS 29.198-1 [1] apply.
dc7f93eeb005e644aa8f154545a30461
29.198-04
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in TS 29.198-1 [1] apply. 4 Call Control SCF Two flavours of Call Control (CC) APIs have been included in 3GPP Release 4. These are the Generic Call Control (GCC) and the Multi-Party Call Control (MPCC). The GCC is the same API as was already present in the Release 99 specification (TS 29.198 v3.3.0) and is in principle able to satisfy the requirements on CC APIs for Release 4. However, the joint work between 3GPP CN5, ETSI SPAN12 and the Parlay CC Working group with collaboration from JAIN has been focussed on the MPCC API. A number of improvements on CC functionality have been made and are reflected in this API. For this it was necessary to break the inheritance that previously existed between GCC and MPCC. The joint CC group has furthermore decided that the MPCC is to be considered as the future base CC family and the technical work will not be continued on GCC. Errors or technical flaws will of course be corrected. The following clauses describe each aspect of the CC Service Capability Feature (SCF). The order is as follows: • The Sequence diagrams give the reader a practical idea of how each of the SCF is implemented. • The Class relationships clause shows how each of the interfaces applicable to the SCF, relate to one another. • The Interface specification clause describes in detail each of the interfaces shown within the Class diagram part. • The State Transition Diagrams (STD) show transition between states in the SCF. The states and transitions are well-defined; either methods specified in the Interface specification or events occurring in the underlying networks cause state transitions. • The Data definitions clause show a detailed expansion of each of the data types associated with the methods within the classes. Note that some data types are used in other methods and classes and are therefore defined within the Common Data types part of this specification (29.198-2).
dc7f93eeb005e644aa8f154545a30461
29.198-04
4.1 Call Model Description
The adopted call model has the following objects. • a call object. A call is a relation between a number of parties. The call object relates to the entire call view from the application. E.g., the entire call will be released when a release is called on the call. Note that different applications can have different views on the same physical call, e.g., one application for the originating side and another application for the terminating side. The applications will not be aware of each other, all 'communication' between the applications will be by means of network signalling. The API currently does not specify any feature interaction mechanisms. • a call leg object. The leg object represents a logical association between a call and an address. The relationship includes at least the signalling relation with the party. The relation with the address is only made when the leg is routed. Before that the leg object is IDLE and not yet associated with the address. • an address. The address logically represents a party in the call. • a terminal. A terminal is the end-point of the signalling and/or media for a party. This object type is currently not addressed. The call object is used to establish a relation between a number of parties by creating a leg for each party within the call. Associated with the signalling relationship represented by the call leg, there may also be a bearer connection (e.g., in the traditional voice only networks) or a number (zero or more) of media channels (in multi-media networks). A leg can be attached to the call or detached from the call. When the leg is attached, this means that media or bearer channels related to the legs are connected to the media or bearer channels of the other legs that are attached to the same call. I.e., only legs that are attached can 'speak' to each other. A leg can have a number of states, depending on the signalling received from or sent to the party associated with the leg. Usually there is a limit to the number of legs that are in being routed (i.e., the connection is being established) or connected to the call (i.e., the connection is established). Also, there usually is a limit to the number of legs that can be simultaneously attached to the same call. Some networks distinguish between controlling and passive legs. By definition the call will be released when the controlling leg is released. All other legs are called passive legs. There can be at most one controlling leg per call. However, there is currently no way the application can influence whether a Leg is controlling or not. There are two ways for an application to get the control of a call. The application can request to be notified of calls that meet certain criteria. When a call occurs in the network that meets these criteria, the application is notified and can control the call. Some legs will already be associated with the call in this case. Another way is to create a new call from the application.
dc7f93eeb005e644aa8f154545a30461
29.198-04
4.2 General requirements on support of methods
An implementation of this API which supports or implements a method described in the present document, shall support or implement the functionality described for that method, for at least one valid set of values for the parameters of that method. Where a method is not supported by an implementation of a Service interface, the exception P_METHOD_NOT_SUPPORTED shall be returned to any call of that method. Where a method is not supported by an implementation of an Application interface, a call to that method shall be possible, and no exception shall be returned. 5 The Service Interface Specifications 5.1 Interface Specification Format This clause defines the interfaces, methods and parameters that form a part of the API specification. The Unified Modelling Language (UML) is used to specify the interface classes. The general format of an interface specification is described below. 5.1.1 Interface Class This shows a UML interface class description of the methods supported by that interface, and the relevant parameters and types. The Service and Framework interfaces for enterprise-based client applications are denoted by classes with name Ip<name>. The callback interfaces to the applications are denoted by classes with name IpApp<name>. For the interfaces between a Service and the Framework, the Service interfaces are typically denoted by classes with name IpSvc<name>, while the Framework interfaces are denoted by classes with name IpFw<name> 5.1.2 Method descriptions Each method (API method “call”) is described. Both synchronous and asynchronous methods are used in the API. Asynchronous methods are identified by a 'Req' suffix for a method request, and, if applicable, are served by asynchronous methods identified by either a 'Res' or 'Err' suffix for method results and errors, respectively. To handle responses and reports, the application or service developer must implement the relevant IpApp<name> or IpSvc<name> interfaces to provide the callback mechanism. 5.1.3 Parameter descriptions Each method parameter and its possible values are described. Parameters described as 'in' represent those that must have a value when the method is called. Those described as 'out' are those that contain the return result of the method when the method returns. 5.1.4 State Model If relevant, a state model is shown to illustrate the states of the objects that implement the described interface. 5.2 Base Interface 5.2.1 Interface Class IpInterface All application, framework and service interfaces inherit from the following interface. This API Base Interface does not provide any additional methods. <<Interface>> IpInterface 5.3 Service Interfaces 5.3.1 Overview The Service Interfaces provide the interfaces into the capabilities of the underlying network - such as call control, user interaction, messaging, mobility and connectivity management. The interfaces that are implemented by the services are denoted as 'Service Interface'. The corresponding interfaces that must be implemented by the application (e.g. for API callbacks) are denoted as 'Application Interface'. 5.4 Generic Service Interface 5.4.1 Interface Class IpService Inherits from: IpInterface All service interfaces inherit from the following interface. <<Interface>> IpService setCallback (appInterface : in IpInterfaceRef) : void setCallbackWithSessionID (appInterface : in IpInterfaceRef, sessionID : in TpSessionID) : void Method setCallback() This method specifies the reference address of the callback interface that a service uses to invoke methods on the application. It is not allowed to invoke this method on an interface that uses SessionIDs. Parameters appInterface : in IpInterfaceRef Specifies a reference to the application interface, which is used for callbacks. Raises TpCommonExceptions, P_INVALID_INTERFACE_TYPE Method setCallbackWithSessionID() This method specifies the reference address of the application's callback interface that a service uses for interactions associated with a specific session ID: e.g. a specific call, or call leg. It is not allowed to invoke this method on an interface that does not use SessionIDs. Parameters appInterface : in IpInterfaceRef Specifies a reference to the application interface, which is used for callbacks. sessionID : in TpSessionID Specifies the session for which the service can invoke the application's callback interface. Raises TpCommonExceptions, P_INVALID_SESSION_ID, P_INVALID_INTERFACE_TYPE 6 Generic Call Control Service The Generic Call Control API of 3GPP Rel.4 relies on the CAMEL Service Environment (CSE) and thus some restrictions exist to the use of the interface. The most significant one is that there is no support for createCall method. The detailed description of the supported methods and further restrictions is given in the chapter 6.5. 6.1 Sequence Diagrams 6.1.1 Additional Callbacks The following sequence diagram shows how an application can register two call back interfaces for the same set of events. If one of the call backs can not be used, e.g., because the application crashed, the other call back interface is used instead. 1: The first instance of the application is started on node 1. The application creates a new IpAppCallControlManager to handle callbacks for this first instance of the logic. 2: The enableCallNotification is associated with an applicationID. The call control manager uses the applicationID to decide whether this is the same application. 3: The second instance of the application is started on node 2. The application creates a new IpAppCallControlManager to handle callbacks for this second instance of the logic. 4: The same enableCallNotification request is sent as for the first instance of the logic. Because both requests are associated with the same application, the second request is not rejected, but the specified callback object is stored as an additional callback. 5: When the trigger occurs one of the first instance of the application is notified. The gateway may have different policies on how to handle additional callbacks, e.g., always first try the first registered or use some kind of round robin scheme. 6: The event is forwarded to the first instance of the logic. 7: When the first instance of the application is overloaded or unavailable this is communicated with an exception to the call control manager. 8: Based on this exception the call control manager will notify another instance of the application (if available). 9: The event is forwarded to the second instance of the logic. 6.1.2 Alarm Call The following sequence diagram shows a "reminder message", in the form of an alarm, being delivered to a customer as a result of a trigger from an application. Typically, the application would be set to trigger at a certain time, however, the application could also trigger on events. 1: This message is used to create an object implementing the IpAppCall interface. 2: This message requests the object implementing the IpCallControlManager interface to create an object implementing the IpCall interface. 3: Assuming that the criteria for creating an object implementing the IpCall interface (e.g. load control values not exceeded) is met it is created. 4: This message instructs the object implementing the IpCall interface to route the call to the customer destined to receive the "reminder message". 5: This message passes the result of the call being answered to its callback object. 6: This message is used to forward the previous message to the IpAppLogic. 7: The application requests a new UICall object that is associated with the call object. 8: Assuming all criteria are met, a new UICall object is created by the service. 9: This message instructs the object implementing the IpUICall interface to send the alarm to the customer's call. 10: When the announcement ends this is reported to the call back interface. 11: The event is forwarded to the application logic. 12: The application releases the UICall object, since no further announcements are required. Alternatively, the application could have indicated P_FINAL_REQUEST in the sendInfoReq in which case the UICall object would have been implicitly released after the announcement was played. 13: The application releases the call and all associated parties. 6.1.3 Application Initiated Call The following sequence diagram shows an application creating a call between party A and party B. This sequence could be done after a customer has accessed a Web page and selected a name on the page of a person or organisation to talk to. 1: This message is used to create an object implementing the IpAppCall interface. 2: This message requests the object implementing the IpCallControlManager interface to create an object implementing the IpCall interface. 3: Assuming that the criteria for creating an object implementing the IpCall interface (e.g. load control values not exceeded) is met, it is created. 4: This message is used to route the call to the A subscriber (origination). In the message the application request response when the A party answers. 5: This message indicates that the A party answered the call. 6: This message forwards the previous message to the application logic. 7: This message is used to route the call to the B-party. Also in this case a response is requested for call answer or failure. 8: This message indicates that the B-party answered the call. The call now has two parties and a speech connection is automatically established between them. 9: This message is used to forward the previous message to the IpAppLogic. 10: Since the application is no longer interested in controlling the call, the application deassigns the call. The call will continue in the network, but there will be no further communication between the call object and the application. 6.1.4 Call Barring 1 The following sequence diagram shows a call barring service, initiated as a result of a prearranged event being received by the call control service. Before the call is routed to the destination number, the calling party is asked for a PIN code. The code is accepted and the call is routed to the original called party. 1: This message is used by the application to create an object implementing the IpAppCallControlManager interface. 2: This message is sent by the application to enable notifications on new call events. As this sequence diagram depicts a call barring service, it is likely that all new call events destined for a particular address or address range prompted for a password before the call is allowed to progress. When a new call, that matches the event criteria set, arrives a message (not shown) is directed to the object implementing the IpCallControlManager. Assuming that the criteria for creating an object implementing the IpCall interface (e.g. load control values not exceeded) is met, other messages (not shown) are used to create the call and associated call leg object. 3: This message is used to pass the new call event to the object implementing the IpAppCallControlManager interface. 4: This message is used to forward the previous message to the IpAppLogic. 5: This message is used by the application to create an object implementing the IpAppCall interface. The reference to this object is passed back to the object implementing the IpCallControlManager using the return parameter of the callEventNotify. 6: This message is used to create a new UICall object. The reference to the call object is given when creating the UICall. 7: Provided all the criteria are fulfilled, a new UICall object is created. 8: The call barring service dialogue is invoked. 9: The result of the dialogue, which in this case is the PIN code, is returned to its callback object. 10: This message is used to forward the previous message to the IpAppLogic. 11: This message releases the UICall object. 12: Assuming the correct PIN is entered, the call is forward routed to the destination party. 13: This message passes the result of the call being answered to its callback object. 14: This message is used to forward the previous message to the IpAppLogic 15: When the call is terminated in the network, the application will receive a notification. This notification will always be received when the call is terminated by the network in a normal way, the application does not have to request this event explicitly. 16: The event is forwarded to the application. 17: The application must free the call related resources in the gateway by calling deassignCall. 6.1.5 Number Translation 1 The following sequence diagram shows a simple number translation service, initiated as a result of a prearranged event being received by the call control service. 1: This message is used by the application to create an object implementing the IpAppCallControlManager interface. 2: This message is sent by the application to enable notifications on new call events. As this sequence diagram depicts a number translation service, it is likely that only new call events within a certain address range will be enabled. When a new call, that matches the event criteria set in message 2, arrives a message (not shown) is directed to the object implementing the IpCallControlManager. Assuming that the criteria for creating an object implementing the IpCall interface (e.g. load control values not exceeded) is met, other messages (not shown) are used to create the call and associated call leg object. 3: This message is used to pass the new call event to the object implementing the IpAppCallControlManager interface. 4: This message is used to forward message 3 to the IpAppLogic. 5: This message is used by the application to create an object implementing the IpAppCall interface. The reference to this object is passed back to the object implementing the IpCallControlManager using the return parameter of message 3. 6: This message invokes the number translation function. 7: The returned translated number is used in message 7 to route the call towards the destination. 8: This message passes the result of the call being answered to its callback object 9: This message is used to forward the previous message to the IpAppLogic. 10: The application is no longer interested in controlling the call and therefore deassigns the call. The call will continue in the network, but there will be no further communication between the call object and the application. 6.1.6 Number Translation 1 (with callbacks) The following sequence diagram shows a simple number translation service, initiated as a result of a prearranged event being received by the call control service. For illustration, in this sequence the callback references are set explicitly. This is optional. All the callbacks references can also be passed in other methods. From an efficiency point of view that is also the preferred method. The rest of the sequences use that mechanism. 1: This message is used by the application to create an object implementing the IpAppCallControlManager interface. 2: This message sets the reference of the IpAppCallControlManager object in the CallControlManager. The CallControlManager reports the callEventNotify to referenced object only for enableCallNotifications that do not have a explicit IpAppCallControlManager reference specified in the enableCallNotification. 3: This message is sent by the application to enable notifications on new call events. As this sequence diagram depicts a number translation service, it is likely that only new call events within a certain address range will be enabled. When a new call, that matches the event criteria set in message 3, arrives a message (not shown) is directed to the object implementing the IpCallControlManager. Assuming that the criteria for creating an object implementing the IpCall interface (e.g. load control values not exceeded) is met, other messages (not shown) are used to create the call and associated call leg object. 4: This message is used to pass the new call event to the object implementing the IpAppCallControlManager interface. 5: This message is used to forward message 4 to the IpAppLogic. 6: This message is used by the application to create an object implementing the IpAppCall interface. 7: This message is used to set the reference to the IpAppCall for this call. 8: This message invokes the number translation function. 9: The returned translated number is used in message 7 to route the call towards the destination. 10: This message passes the result of the call being answered to its callback object 11: This message is used to forward the previous message to the IpAppLogic. 12: The application is no longer interested in controlling the call and therefore deassigns the call. The call will continue in the network, but there will be no further communication between the call object and the application. 6.1.7 Number Translation 2 The following sequence diagram shows a number translation service, initiated as a result of a prearranged event being received by the call control service. If the translated number being routed to does not answer or is busy then the call is automatically released. 1: This message is used by the application to create an object implementing the IpAppCallControlManager interface. 2: This message is sent by the application to enable notifications on new call events. As this sequence diagram depicts a number translation service, it is likely that only new call events within a certain address range will be enabled. When a new call, that matches the event criteria, arrives a message (not shown) is directed to the object implementing the IpCallControlManager. Assuming that the criteria for creating an object implementing the IpCall interface (e.g. load control values not exceeded) is met, other messages (not shown) are used to create the call and associated call leg object. 3: This message is used to pass the new call event to the object implementing the IpAppCallControlManager interface. 4: This message is used to forward the previous message to the IpAppLogic. 5: This message is used by the application to create an object implementing the IpAppCall interface. The reference to this object is passed back to the object implementing the IpCallControlManager using the return parameter of the callEventNotify. 6: This message invokes the number translation function. 7: The returned translated number is used to route the call towards the destination. 8: Assuming the called party is busy or does not answer, the object implementing the IpCall interface sends a callback in this message, indicating the unavailability of the called party. 9: This message is used to forward the previous message to the IpAppLogic. 10: The application takes the decision to release the call. 6.1.8 Number Translation 3 The following sequence diagram shows a number translation service, initiated as a result of a prearranged event being received by the call control service. If the translated number being routed to does not answer or is busy then the call is automatically routed to a voice mailbox. 1: This message is used by the application to create an object implementing the IpAppCallControlManager interface. 2: This message is sent by the application to enable notifications on new call events. As this sequence diagram depicts a number translation service, it is likely that only new call events within a certain address range will be enabled. When a new call, that matches the event criteria, arrives a message (not shown) is directed to the object implementing the IpCallControlManager. Assuming that the criteria for creating an object implementing the IpCall interface (e.g. load control values not exceeded) is met, other messages (not shown) are used to create the call and associated call leg object. 3: This message is used to pass the new call event to the object implementing the IpAppCallControlManager interface. 4: This message is used to forward the previous message to the IpAppLogic. 5: This message is used by the application to create an object implementing the IpAppCall interface. The reference to this object is passed back to the object implementing the IpCallControlManager using the return parameter of the callEventNotify. 6: This message invokes the number translation function. 7: The returned translated number is used to route the call towards the destination. 8: Assuming the called party is busy or does not answer, the object implementing the IpCall interface sends a callback, indicating the unavailability of the called party. 9: This message is used to forward the previous message to the IpAppLogic. 10: The application takes the decision to translate the number, but this time the number is translated to a number belonging to a voice mailbox system. 11: This message routes the call towards the voice mailbox. 12: This message passes the result of the call being answered to its callback object. 13: This message is used to forward the previous message to the IpAppLogic. 14: The application is no longer interested in controlling the call and therefore deassigns the call. The call will continue in the network, but there will be no further communication between the call object and the application. 6.1.9 Number Translation 4 The following sequence diagram shows a number translation service, initiated as a result of a prearranged event being received by the call control service. Before the call is routed to the translated number, the application requests for all call related information to be delivered back to the application on completion of the call. 1: This message is used by the application to create an object implementing the IpAppCallControlManager interface. 2: This message is sent by the application to enable notifications on new call events. As this sequence diagram depicts a number translation service, it is likely that only new call events within a certain address range will be enabled. When a new call, that matches the event criteria, arrives a message (not shown) is directed to the object implementing the IpCallControlManager. Assuming that the criteria for creating an object implementing the IpCall interface (e.g. load control values not exceeded) is met, other messages (not shown) are used to create the call and associated call leg object. 3: This message is used to pass the new call event to the object implementing the IpAppCallControlManager interface. 4: This message is used to forward the previous message to the IpAppLogic. 5: This message is used by the application to create an object implementing the IpAppCall interface. The reference to this object is passed back to the object implementing the IpCallControlManager using the return parameter of the callEventNotify. 6: This message invokes the number translation function. 7: The application instructs the object implementing the IpCall interface to return all call related information once the call has been released. 8: The returned translated number is used to route the call towards the destination. 9: This message passes the result of the call being answered to its callback object. 10: This message is used to forward the previous message to the IpAppLogic. 11: Towards the end of the call, when one of the parties disconnects, a message (not shown) is directed to the object implementing the IpCall. This causes an event, to be passed to the object implementing the IpAppCall object. 12: This message is used to forward the previous message to the IpAppLogic. 13: The application now waits for the call information to be sent. Now that the call has completed, the object implementing the IpCall interface passes the call information to its callback object. 14: This message is used to forward the previous message to the IpAppLogic 15: After the last information is received, the application deassigns the call. This will free the resources related to this call in the gateway. 6.1.10 Number Translation 5 The following sequence diagram shows a simple number translation service which contains a status check function, initiated as a result of a prearranged event being received. In the following sequence, when the application receives an incoming call, it checks the status of the user, and returns a busy code to the calling party. 1: This message is used by the application to create an object implementing the IpAppCallControlManager interface. 2: This message is sent by the application to enable notifications on new call events. As this sequence diagram depicts a number translation service, it is likely that only new call events within a certain address range will be enabled. When a new call, that matches the event criteria set in message 2, arrives a message (not shown) is directed to the object implementing the IpCallControlManager. Assuming that the criteria for creating an object implementing the IpCall interface (e.g. load control values not exceeded) is met, other messages (not shown) are used to create the call and associated call leg object. 3: This message is used to pass the new call event to the object implementing the IpAppCallControlManager interface. 4: This message is used to forward message 3 to the IpAppLogic. 5: This message is used by the application to create an object implementing the IpAppCall interface. The reference to this object is passed back to the object implementing the IpCallControlManager using the return parameter of message 3. 6: This message invokes the status checking function. 7: The application decides to release the call, and sends a release cause to the calling party indicating that the user is busy. 6.1.11 Prepaid This sequence shows a Pre-paid application. The subscriber is using a pre-paid card or credit card to pay for the call. The application each time allows a certain timeslice for the call. After the timeslice, a new timeslice can be started or the application can terminate the call. In the following sequence the end-user will receive an announcement before his final timeslice. 1: This message is used by the application to create an object implementing the IpAppCallControlManager interface. 2: This message is sent by the application to enable notifications on new call events. As this sequence diagram depicts a pre-paid service, it is likely that only new call events within a certain address range will be enabled. When a new call, that matches the event criteria, arrives a message (not shown) is directed to the object implementing the IpCallControlManager. Assuming that the criteria for creating an object implementing the IpCall interface (e.g. load control values not exceeded) is met, other messages (not shown) are used to create the call and associated call leg object. 3: The incoming call triggers the Pre-Paid Application (PPA). 4: The message is forwarded to the application. 5: A new object on the application side for the Generic Call object is created 6: The Pre-Paid Application (PPA) requests to supervise the call. The application will be informed after the period indicated in the message. This period is related to the credits left on the account of the pre-paid subscriber. 7: Before continuation of the call, PPA sends all charging information, a possible tariff switch time and the call duration supervision period, towards the GW which forwards it to the network. 8: At the end of each supervision period the application is informed and a new period is started. 9: The message is forwarded to the application. 10: The Pre-Paid Application (PPA) requests to supervise the call for another call duration. 11: At the end of each supervision period the application is informed and a new period is started. 12: The message is forwarded to the application. 13: The Pre-Paid Application (PPA) requests to supervise the call for another call duration. When the timer expires it will indicate that the user is almost out of credit. 14: When the user is almost out of credit the application is informed. 15: The message is forwarded to the application. 16: The application decides to play an announcement to the parties in this call. A new UICall object is created and associated with the call. 17: An announcement is played informing the user about the near-expiration of his credit limit. 18: When the announcement is completed the application is informed. 19: The message is forwarded to the application. 20: The application releases the UICall object. 21: The user does not terminate so the application terminates the call after the next supervision period. 22: The supervision period ends 23: The event is forwarded to the logic. 24: The application terminates the call. Since the user interaction is already explicitly terminated no userInteractionFaultDetected is sent to the application. 6.1.12 Pre-Paid with Advice of Charge (AoC) This sequence shows a Pre-paid application that uses the Advice of Charge feature. The application will send the charging information before the actual call setup and when during the call the charging changes new information is sent in order to update the end-user. Note: the Advice of Charge feature requires an application in the end-user terminal to display the charges for the call, depending on the information received from the application. 1: This message is used by the application to create an object implementing the IpAppCallControlManager interface. 2: This message is sent by the application to enable notifications on new call events. As this sequence diagram depicts a pre-paid service, it is likely that only new call events within a certain address range will be enabled. When a new call, that matches the event criteria, arrives a message (not shown) is directed to the object implementing the IpCallControlManager. Assuming that the criteria for creating an object implementing the IpCall interface (e.g. load control values not exceeded) is met, other messages (not shown) are used to create the call and associated call leg object. 3: The incoming call triggers the Pre-Paid Application (PPA). 4: The message is forwarded to the application. 5: A new object on the application side for the Call object is created 6: The Pre-Paid Application (PPA) sends the AoC information (e.g. the tariff switch time). (it shall be noted the PPA contains ALL the tariff information and knows how to charge the user). During this call sequence 2 tariff changes take place. The call starts with tariff 1, and at the tariff switch time (e.g., 18:00 hours) switches to tariff 2. The application is not informed about this (but the end-user is!) 7: The Pre-Paid Application (PPA) requests to supervise the call. The application will be informed after the period indicated in the message. This period is related to the credits left on the account of the pre-paid subscriber. 8: The application requests to route the call to the destination address. 9: At the end of each supervision period the application is informed and a new period is started. 10: The message is forwarded to the application. 11: The Pre-Paid Application (PPA) requests to supervise the call for another call duration. 12: At the end of each supervision period the application is informed and a new period is started. 13: The message is forwarded to the application. 14: Before the next tariff switch (e.g., 19:00 hours) the application sends a new AOC with the tariff switch time. Again, at the tariff switch time, the network will send AoC information to the end-user. 15: The Pre-Paid Application (PPA) requests to supervise the call for another call duration. When the timer expires it will indicate that the user is almost out of credit. 16: When the user is almost out of credit the application is informed. 17: The message is forwarded to the application. 18: The application creates a new call back interface for the User interaction messages. 19: A new UI Call object that will handle playing of the announcement needs to be created 20: The Gateway creates a new UI call object that will handle playing of the announcement. 21: With this message the announcement is played to the parties in the call. 22: The user indicates that the call should continue. 23: The message is forwarded to the application. 24: The user does not terminate so the application terminates the call after the next supervision period. 25: The user is out of credit and the application is informed. 26: The message is forwarded to the application. 27: With this message the application requests to release the call. 28: Terminating the call which has still a UICall object associated will result in a userInteractionFaultDetected. The UICall object is terminated in the gateway and no further communication is possible between the UICall and the application. 6.2 Class Diagrams This class diagram shows the interfaces of the generic call control service package. Figure: Service Interfaces The generic call control service consists of two packages, one for the interfaces on the application side and one for interfaces on the service side. The class diagrams in the following figures show the interfaces that make up the generic call control application package and the generic call control service package. Communication between these packages is indicated with the <<uses>> associations; e.g., the IpCallControlManager interface uses the IpAppCallControlManager , by means of calling callback methods. This class diagram shows the interfaces of the generic call control application package and their relations to the interfaces of the generic call control service package. Figure: Application Interfaces 6.3 Generic Call Control Service Interface Classes The Generic Call Control Service (GCCS) provides the basic call control service for the API. It is based around a third party model, which allows calls to be instantiated from the network and routed through the network. The GCCS supports enough functionality to allow call routing and call management for today's Intelligent Network (IN) services in the case of a switched telephony network, or equivalent for packet based networks. It is the intention of the GCCS that it could be readily specialised into call control specifications, for example, ITU-T recommendations H.323, ISUP, Q.931 and Q.2931, ATM Forum specification UNI3.1 and the IETF Session Initiation Protocol, or any other call control technology. For the generic call control service, only a subset of the call model defined in clause 4 is used; the API for generic call control does not give explicit access to the legs and the media channels. This is provided by the Multi-Party Call Control Service. Furthermore, the generic call is restricted to two party calls, i.e., only two legs are active at any given time. Active is defined here as 'being routed' or connected. The GCCS is represented by the IpCallControlManager and IpCall interfaces that interface to services provided by the network. Some methods are asynchronous, in that they do not lock a thread into waiting whilst a transaction performs. In this way, the client machine can handle many more calls, than one that uses synchronous message calls. To handle responses and reports, the developer must implement IpAppCallControlManager and IpAppCall to provide the callback mechanism. 6.3.1 Interface Class IpCallControlManager Inherits from: IpService This interface is the 'service manager' interface for the Generic Call Control Service. The generic call control manager interface provides the management functions to the generic call control service. The application programmer can use this interface to provide overload control functionality, create call objects and to enable or disable call-related event notifications. This interface shall be implemented by a Generic Call Control SCF. As a minimum requirement either the createCall() method shall be implemented, or the enableCallNotification() and disableCallNotification() methods shall be implemented. <<Interface>> IpCallControlManager createCall (appCall : in IpAppCallRef) : TpCallIdentifier enableCallNotification (appCallControlManager : in IpAppCallControlManagerRef, eventCriteria : in TpCallEventCriteria) : TpAssignmentID disableCallNotification (assignmentID : in TpAssignmentID) : void setCallLoadControl (duration : in TpDuration, mechanism : in TpCallLoadControlMechanism, treatment : in TpCallTreatment, addressRange : in TpAddressRange) : TpAssignmentID changeCallNotification (assignmentID : in TpAssignmentID, eventCriteria : in TpCallEventCriteria) : void getCriteria () : TpCallEventCriteriaResultSet Method createCall() This method is used to create a new call object. Call back reference: An IpAppCallControlManager should already have been passed to the IpCallControlManager, otherwise the call control will not be able to report a callAborted() to the application. The application shall invoke setCallback() prior to createCall if it wishes to ensure this. Returns callReference: Specifies the interface reference and sessionID of the call created. Parameters appCall : in IpAppCallRef Specifies the application interface for callbacks from the call created. Returns TpCallIdentifier Raises TpCommonExceptions, P_INVALID_INTERFACE_TYPE Method enableCallNotification() This method is used to enable call notifications so that events can be sent to the application. This is the first step an application has to do to get initial notification of calls happening in the network. When such an event happens, the application will be informed by callEventNotify(). In case the application is interested in other events during the context of a particular call session it has to use the routeReq() method on the call object. The application will get access to the call object when it receives the callEventNotify(). (Note that the enableCallNotification() is not applicable if the call is setup by the application). The enableCallNotification method is purely intended for applications to indicate their interest to be notified when certain call events take place. It is possible to subscribe to a certain event for a whole range of addresses, e.g. the application can indicate it wishes to be informed when a call is made to any number starting with 800. If some application already requested notifications with criteria that overlap the specified criteria, the request is refused with P_GCCS_INVALID_CRITERIA. The criteria are said to overlap if both originating and terminating ranges overlap and the same number plan is used and the same CallNotificationType is used. If a notification is requested by an application with the monitor mode set to notify, then there is no need to check the rest of the criteria for overlapping with any existing request as the notify mode does not allow control on a call to be passed over. Only one application can place an interrupt request if the criteria overlaps. Set of the callback reference: The call back reference can be registered either in a) enableCallNotification() or b) explicitly with a separate setCallback() method depending on how the application provides its callback reference. Case a: From an efficiency point of view the enableCallNotification() with explicit immediate registration (no "Null" value) of call back reference may be the preferred method. Case b: The enableCallNotfication() with no call back reference ("Null" value) is used where (e.g. due to distributed application logic) the call back reference is provided previously in a setCallback(). If no callback reference has been provided previously to the service, the exception, P_NO_CALLBACK_ADDRESS_SET shall be raised. In case the enableCallNotification() contains no callback, at the moment the application needs to be informed the gateway will use as callback the callback that has been registered by setCallback(). See example in clause 6.1.6. Set additional callback reference: If the same application requests two notifications with exactly the same criteria but different callback references, the second callback will be treated as an additional callback. Both notifications will share the same assignmentID. The gateway will always use the most recent callback. In case this most recent callback fails the second most recent is used. See examples in clause 6.1.1. Returns assignmentID: Specifies the ID assigned by the generic call control manager interface for this newly-enabled event notification. Parameters appCallControlManager : in IpAppCallControlManagerRef If this parameter is set (i.e. not NULL) it specifies a reference to the application interface, which is used for callbacks. If set to NULL, the application interface defaults to the interface specified previously via the setCallback() method. eventCriteria : in TpCallEventCriteria Specifies the event specific criteria used by the application to define the event required. Only events that meet these criteria are reported. Examples of events are "incoming call attempt reported by network", "answer", "no answer", "busy". Individual addresses or address ranges may be specified for destination and/or origination. Returns TpAssignmentID Raises TpCommonExceptions, P_INVALID_CRITERIA, P_INVALID_INTERFACE_TYPE, P_INVALID_EVENT_TYPE Method disableCallNotification() This method is used by the application to disable call notifications. Parameters assignmentID : in TpAssignmentID Specifies the assignment ID given by the generic call control manager interface when the previous enableCallNotification() was called. If the assignment ID does not correspond to one of the valid assignment IDs, the exception P_INVALID_ASSIGNMENTID will be raised. If two callbacks have been registered under this assignment ID both of them will be disabled. Raises TpCommonExceptions, P_INVALID_ASSIGNMENT_ID Method setCallLoadControl() This method imposes or removes load control on calls made to a particular address range within the generic call control service. The address matching mechanism is similar as defined for TpCallEventCriteria. Returns assignmentID: Specifies the assignmentID assigned by the gateway to this request. This assignmentID can be used to correlate the callOverloadEncountered and callOverloadCeased methods with the request. Parameters duration : in TpDuration Specifies the duration for which the load control should be set. A duration of 0 indicates that the load control should be removed. A duration of -1 indicates an infinite duration (i.e., until disabled by the application) A duration of -2 indicates the network default duration. mechanism : in TpCallLoadControlMechanism Specifies the load control mechanism to use (for example, admit one call per interval), and any necessary parameters, such as the call admission rate. The contents of this parameter are ignored if the load control duration is set to zero. treatment : in TpCallTreatment Specifies the treatment of calls that are not admitted. The contents of this parameter are ignored if the load control duration is set to zero. addressRange : in TpAddressRange Specifies the address or address range to which the overload control should be applied or removed. Returns TpAssignmentID Raises TpCommonExceptions, P_INVALID_ADDRESS, P_UNSUPPORTED_ADDRESS_PLAN Method changeCallNotification() This method is used by the application to change the event criteria introduced with enableCallNotification. Any stored criteria associated with the specified assignmentID will be replaced with the specified criteria. Parameters assignmentID : in TpAssignmentID Specifies the ID assigned by the generic call control manager interface for the event notification. If two call backs have been registered under this assignment ID both of them will be changed. eventCriteria : in TpCallEventCriteria Specifies the new set of event specific criteria used by the application to define the event required. Only events that meet these criteria are reported. Raises TpCommonExceptions, P_INVALID_ASSIGNMENT_ID, P_INVALID_CRITERIA, P_INVALID_EVENT_TYPE Method getCriteria() This method is used by the application to query the event criteria set with enableCallNotification or changeCallNotification. Returns eventCriteria: Specifies the event specific criteria used by the application to define the event required. Only events that meet these criteria are reported. Parameters No Parameters were identified for this method Returns TpCallEventCriteriaResultSet Raises TpCommonExceptions 6.3.2 Interface Class IpAppCallControlManager Inherits from: IpInterface The generic call control manager application interface provides the application call control management functions to the generic call control service. <<Interface>> IpAppCallControlManager callAborted (callReference : in TpSessionID) : void callEventNotify (callReference : in TpCallIdentifier, eventInfo : in TpCallEventInfo, assignmentID : in TpAssignmentID) : IpAppCallRef callNotificationInterrupted () : void callNotificationContinued () : void callOverloadEncountered (assignmentID : in TpAssignmentID) : void callOverloadCeased (assignmentID : in TpAssignmentID) : void Method callAborted() This method indicates to the application that the call object (at the gateway) has aborted or terminated abnormally. No further communication will be possible between the call and application. Parameters callReference : in TpSessionID Specifies the sessionID of call that has aborted or terminated abnormally. Method callEventNotify() This method notifies the application of the arrival of a call-related event. If this method is invoked with a monitor mode of P_CALL_MONITOR_MODE_INTERRUPT, then the APL has control of the call. If the APL does nothing with the call (including its associated legs) within a specified time period (the duration of which forms a part of the service level agreement), then the call in the network shall be released and callEnded() shall be invoked, giving a release cause of 102 (Recovery on timer expiry). Set of the callback reference: A reference to the application interface has to be passed back to the call interface to which the notification relates. However, the setting of a call back reference is only applicable if the notification is in INTERRUPT mode. When callEventNotify() is invoked with a monitor mode of P_CALL_MONITOR_MODE_INTERRUPT, the application writer should ensure that no continue processing e.g. routeReq() is performed until an IpAppCall has been passed to the gateway, either through an explicit setCallbackWithSessionID() invocation on the supplied IpCall, or via the return of the callEventNotify() method. The call back reference can be registered either in a) callEventNotify() or b) explicitly with a setCallbackWithSessionID() method e.g. depending on how the application provides its call reference. Case a: From an efficiency point of view the callEventNotify() with explicit pass of registration may be the preferred method. Case b: The callEventNotify() with no call back reference ("Null" value) is used where (e.g. due to distributed application logic) the callback reference is provided previously in a setCallbackWithSessionID(). If no callback reference has been provided previously to the service, the exception, P_NO_CALLBACK_ADDRESS_SET shall be raised, and no further application invocations related to the call shall be permitted. In case the callEventNotify() contains no callback, at the moment the application needs to be informed the gateway will use as callback the callback that has been registered previously by setCallbackWithSessionID(). See example in clause 6.1.6. Returns appCall: Specifies a reference to the application interface which implements the callback interface for the new call. If the application has previously explicitly passed a reference to the IpAppCall interface using a setCallbackWithSessionID() invocation, this parameter may be null, or if supplied must be the same as that provided during the setCallbackWithSessionID(). This parameter will be null if the notification is in NOTIFY mode and in case b. Parameters callReference : in TpCallIdentifier Specifies the reference to the call interface to which the notification relates. If the notification is in NOTIFY mode, this parameter shall be ignored by the application client implementation, and consequently the implementation of the SCS entity invoking callEventNotify may populate this parameter as it chooses. eventInfo : in TpCallEventInfo Specifies data associated with this event. assignmentID : in TpAssignmentID Specifies the assignment id which was returned by the enableCallNotification() method. The application can use assignment id to associate events with event specific criteria and to act accordingly. Returns IpAppCallRef Method callNotificationInterrupted() This method indicates to the application that all event notifications have been temporarily interrupted (for example, due to faults detected). Note that more permanent failures are reported via the Framework (integrity management). Parameters No Parameters were identified for this method Method callNotificationContinued() This method indicates to the application that event notifications will again be possible. Parameters No Parameters were identified for this method Method callOverloadEncountered() This method indicates that the network has detected overload and may have automatically imposed load control on calls requested to a particular address range or calls made to a particular destination within the call control service. Parameters assignmentID : in TpAssignmentID Specifies the assignmentID corresponding to the associated setCallLoadControl. This implies the address range for within which the overload has been encountered. Method callOverloadCeased() This method indicates that the network has detected that the overload has ceased and has automatically removed any load controls on calls requested to a particular address range or calls made to a particular destination within the call control service. Parameters assignmentID : in TpAssignmentID Specifies the assignmentID corresponding to the associated setCallLoadControl. This implies the address range for within which the overload has been ceased 6.3.3 Interface Class IpCall Inherits from: IpService The generic Call provides the possibility to control the call routing, to request information from the call, control the charging of the call, to release the call and to supervise the call. It does not give the possibility to control the legs directly and it does not allow control over the media. The first capability is provided by the multi-party call and the latter as well by the multi-media call. The call is limited to two party calls, although it is possible to provide 'follow-on' calls, meaning that the call can be rerouted after the terminating party has disconnected or routing to the terminating party has failed. Basically, this means that at most two legs can be in connected or routing state at any time. This interface shall be implemented by a Generic Call Control SCF. As a minimum requirement, the routeReq (), release() and deassignCall() methods shall be implemented. <<Interface>> IpCall routeReq (callSessionID : in TpSessionID, responseRequested : in TpCallReportRequestSet, targetAddress : in TpAddress, originatingAddress : in TpAddress, originalDestinationAddress : in TpAddress, redirectingAddress : in TpAddress, appInfo : in TpCallAppInfoSet) : TpSessionID release (callSessionID : in TpSessionID, cause : in TpCallReleaseCause) : void deassignCall (callSessionID : in TpSessionID) : void getCallInfoReq (callSessionID : in TpSessionID, callInfoRequested : in TpCallInfoType) : void setCallChargePlan (callSessionID : in TpSessionID, callChargePlan : in TpCallChargePlan) : void setAdviceOfCharge (callSessionID : in TpSessionID, aOCInfo : in TpAoCInfo, tariffSwitch : in TpDuration) : void getMoreDialledDigitsReq (callSessionID : in TpSessionID, length : in TpInt32) : void superviseCallReq (callSessionID : in TpSessionID, time : in TpDuration, treatment : in TpCallSuperviseTreatment) : void <<new>> continueProcessing (callSessionID : in TpSessionID) : void Method routeReq() This asynchronous method requests routing of the call to the remote party indicated by the targetAddress. Note that in case of routeReq() it is recommended to request for 'successful' (e.g. 'answer' event) and 'failure' events at invocation, because those are needed for the application to keep track of the state of the call. The extra address information such as originatingAddress is optional. If not present (i.e., the plan is set to P_ADDRESS_PLAN_NOT_PRESENT), the information provided in corresponding addresses from the route is used, otherwise the network or gateway provided numbers will be used. If this method in invoked, and call reports have been requested, yet no IpAppCall interface has been provided, this method shall throw the P_NO_CALLBACK_ADDRESS_SET exception. This operation continues processing of the call implicitly. Returns callLegSessionID: Specifies the sessionID assigned by the gateway. This is the sessionID of the implicitly created call leg. The same ID will be returned in the routeRes or Err. This allows the application to correlate the request and the result. This parameter is only relevant when multiple routeReq() calls are executed in parallel, e.g., in the multi-party call control service. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. responseRequested : in TpCallReportRequestSet Specifies the set of observed events that will result in zero or more routeRes() being generated. E.g., when both answer and disconnect is monitored the result can be received two times. If the application wants to control the call (in whatever sense) it shall enable event reports targetAddress : in TpAddress Specifies the destination party to which the call leg should be routed. originatingAddress : in TpAddress Specifies the address of the originating (calling) party. originalDestinationAddress : in TpAddress Specifies the original destination address of the call. redirectingAddress : in TpAddress Specifies the address from which the call was last redirected. appInfo : in TpCallAppInfoSet Specifies application-related information pertinent to the call (such as alerting method, tele-service type, service identities and interaction indicators). Returns TpSessionID Raises TpCommonExceptions, P_INVALID_SESSION_ID, P_INVALID_ADDRESS, P_UNSUPPORTED_ADDRESS_PLAN, P_INVALID_NETWORK_STATE, P_INVALID_CRITERIA, P_INVALID_EVENT_TYPE Method release() This method requests the release of the call object and associated objects. The call will also be terminated in the network. If the application requested reports to be sent at the end of the call (e.g., by means of getCallInfoReq) these reports will still be sent to the application. This operation continues processing of the call implicitly. The application should always either release or deassign the call when it is finished with the call, unless a callFaultDetected is received by the application. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. cause : in TpCallReleaseCause Specifies the cause of the release. Raises TpCommonExceptions, P_INVALID_SESSION_ID, P_INVALID_NETWORK_STATE Method deassignCall() This method requests that the relationship between the application and the call and associated objects be de-assigned. It leaves the call in progress, however, it purges the specified call object so that the application has no further control of call processing. If a call is de-assigned that has event reports, call information reports or call Leg information reports requested, then these reports will be disabled and any related information discarded. This operation continues processing of the call implicitly. The application should always either release or deassign the call when it is finished with the call, unless callFaultDetected is received by the application. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. Raises TpCommonExceptions, P_INVALID_SESSION_ID Method getCallInfoReq() This asynchronous method requests information associated with the call to be provided at the appropriate time (for example, to calculate charging). This method must be invoked before the call is routed to a target address. A report is received when the destination leg or party terminates or when the call ends. The call object will exist after the call is ended if information is required to be sent to the application at the end of the call. In case the originating party is still available the application can still initiate a follow-on call using routeReq. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. callInfoRequested : in TpCallInfoType Specifies the call information that is requested. Raises TpCommonExceptions, P_INVALID_SESSION_ID Method setCallChargePlan() Set an operator specific charge plan for the call. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. callChargePlan : in TpCallChargePlan Specifies the charge plan to use. Raises TpCommonExceptions, P_INVALID_SESSION_ID Method setAdviceOfCharge() This method allows for advice of charge (AOC) information to be sent to terminals that are capable of receiving this information. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. aOCInfo : in TpAoCInfo Specifies two sets of Advice of Charge parameter. tariffSwitch : in TpDuration Specifies the tariff switch interval that signifies when the second set of AoC parameters becomes valid. Raises TpCommonExceptions, P_INVALID_SESSION_ID Method getMoreDialledDigitsReq() This asynchronous method requests the call control service to collect further digits and return them to the application. Depending on the administered data, the network may indicate a new call to the gateway if a caller goes off-hook or dialled only a few digits. The application then gets a new call event which contains no digits or only the few dialled digits in the event data. The application should use this method if it requires more dialled digits, e.g. to perform screening. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. length : in TpInt32 Specifies the maximum number of digits to collect. Raises TpCommonExceptions, P_INVALID_SESSION_ID Method superviseCallReq() The application calls this method to supervise a call. The application can set a granted connection time for this call. If an application calls this function before it calls a routeReq() or a user interaction function the time measurement will start as soon as the call is answered by the B-party or the user interaction system. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. time : in TpDuration Specifies the granted time in milliseconds for the connection. treatment : in TpCallSuperviseTreatment Specifies how the network should react after the granted connection time expired. Raises TpCommonExceptions, P_INVALID_SESSION_ID Method <<new>> continueProcessing() This operation continues processing of the call explicitly. Applications can invoke this operation after call processing was interrupted due to detection of a notification or event the application subscribed its interest in. In case the operation is invoked and call processing is not interrupted the exception P_INVALID_NETWORK_STATE will be raised. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. Raises TpCommonExceptions, P_INVALID_SESSION_ID, P_INVALID_NETWORK_STATE 6.3.4 Interface Class IpAppCall Inherits from: IpInterface The generic call application interface is implemented by the client application developer and is used to handle call request responses and state reports. <<Interface>> IpAppCall routeRes (callSessionID : in TpSessionID, eventReport : in TpCallReport, callLegSessionID : in TpSessionID) : void routeErr (callSessionID : in TpSessionID, errorIndication : in TpCallError, callLegSessionID : in TpSessionID) : void getCallInfoRes (callSessionID : in TpSessionID, callInfoReport : in TpCallInfoReport) : void getCallInfoErr (callSessionID : in TpSessionID, errorIndication : in TpCallError) : void superviseCallRes (callSessionID : in TpSessionID, report : in TpCallSuperviseReport, usedTime : in TpDuration) : void superviseCallErr (callSessionID : in TpSessionID, errorIndication : in TpCallError) : void callFaultDetected (callSessionID : in TpSessionID, fault : in TpCallFault) : void getMoreDialledDigitsRes (callSessionID : in TpSessionID, digits : in TpString) : void getMoreDialledDigitsErr (callSessionID : in TpSessionID, errorIndication : in TpCallError) : void callEnded (callSessionID : in TpSessionID, report : in TpCallEndedReport) : void Method routeRes() This asynchronous method indicates that the request to route the call to the destination was successful, and indicates the response of the destination party (for example, the call was answered, not answered, refused due to busy, etc.). If this method is invoked with a monitor mode of P_CALL_MONITOR_MODE_INTERRUPT, then the APL has control of the call. If the APL does nothing with the call (including its associated legs) within a specified time period (the duration of which forms a part of the service level agreement), then the call in the network shall be released and callEnded() shall be invoked, giving a release cause of 102 (Recovery on timer expiry). Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. eventReport : in TpCallReport Specifies the result of the request to route the call to the destination party. It also includes the network event, date and time, monitoring mode and event specific information such as release cause. callLegSessionID : in TpSessionID Specifies the sessionID of the associated call leg. This corresponds to the sessionID returned at the routeReq() and can be used to correlate the response with the request. Method routeErr() This asynchronous method indicates that the request to route the call to the destination party was unsuccessful - the call could not be routed to the destination party (for example, the network was unable to route the call, the parameters were incorrect, the request was refused, etc.). Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. errorIndication : in TpCallError Specifies the error which led to the original request failing. callLegSessionID : in TpSessionID Specifies the sessionID of the associated call leg. This corresponds to the sessionID returned at the routeReq() and can be used to correlate the error with the request. Method getCallInfoRes() This asynchronous method reports time information of the finished call or call attempt as well as release cause depending on which information has been requested by getCallInfoReq. This information may be used e.g. for charging purposes. The call information will possibly be sent after routeRes in all cases where the call or a leg of the call has been disconnected or a routing failure has been encountered. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. callInfoReport : in TpCallInfoReport Specifies the call information requested. Method getCallInfoErr() This asynchronous method reports that the original request was erroneous, or resulted in an error condition. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. errorIndication : in TpCallError Specifies the error which led to the original request failing. Method superviseCallRes() This asynchronous method reports a call supervision event to the application when it has indicated its interest in these kind of events. It is also called when the connection is terminated before the supervision event occurs. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call report : in TpCallSuperviseReport Specifies the situation which triggered the sending of the call supervision response. usedTime : in TpDuration Specifies the used time for the call supervision (in milliseconds). Method superviseCallErr() This asynchronous method reports a call supervision error to the application. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. errorIndication : in TpCallError Specifies the error which led to the original request failing. Method callFaultDetected() This method indicates to the application that a fault in the network has been detected. The call may or may not have been terminated. The system deletes the call object. Therefore, the application has no further control of call processing. No report will be forwarded to the application. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call in which the fault has been detected. fault : in TpCallFault Specifies the fault that has been detected. Method getMoreDialledDigitsRes() This asynchronous method returns the collected digits to the application. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. digits : in TpString Specifies the additional dialled digits if the string length is greater than zero. Method getMoreDialledDigitsErr() This asynchronous method reports an error in collecting digits to the application. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. errorIndication : in TpCallError Specifies the error which led to the original request failing. Method callEnded() This method indicates to the application that the call has terminated in the network. However, the application may still receive some results (e.g., getCallInfoRes) related to the call. The application is expected to deassign the call object after having received the callEnded. Note that the event that caused the call to end might also be received separately if the application was monitoring for it. Parameters callSessionID : in TpSessionID Specifies the call sessionID. report : in TpCallEndedReport Specifies the reason the call is terminated. 6.4 Generic Call Control Service State Transition Diagrams 6.4.1 State Transition Diagrams for IpCallControlManager The state transition diagram shows the application view on the Call Control Manager object. Figure : Application view on the Call Control Manager 6.4.1.1 Active State In this state a relation between the Application and the Generic Call Control Service has been established. The state allows the application to indicate that it is interested in call related events. In case such an event occurs, the Call Control Manager will create a Call object and inform the application by invoking the operation callEventNotify() on the IpAppCallControlManager interface. The application can also indicate it is no longer interested in certain call related events by calling disableCallNotification(). 6.4.1.2 Notification terminated State When the Call Control Manager is in the Notification terminated state, events requested with enableCallNotification() will not be forwarded to the application. There can be multiple reasons for this: for instance it might be that the application receives more notifications from the network than defined in the Service Level Agreement. Another example is that the Service has detected it receives no notifications from the network due to e.g. a link failure. In this state no requests for new notifications will be accepted. 6.4.2 State Transition Diagrams for IpCall The state transition diagram shows the application view on the Call object for 3GPP. Figure : Application view on the IpCall object for 3GPP 6.4.2.1 Network Released State In this state the call has ended and the Gateway collects the possible call information requested with getCallInfoReq() and / or superviseCallReq(). The information will be returned to the application by invoking the methods getCallInfoRes() and / or superviseCallRes() on the application. Also when a call was unsuccessful these methods are used. In case the application has not requested additional call related information immediately a transition is made to state Finished. 6.4.2.2 Finished State In this state the call has ended and no call related information is to be send to the application. The application can only release the call object. Calling the deassignCall() operation has the same effect. Note that the application has to release the object itself as good OO practice requires that when an object was created on behalf of a certain entity, this entity is also responsible for destroying it when the object is no longer needed. 6.4.2.3 Application Released State In this state the application has requested to release the Call object and the Gateway collects the possible call information requested with getCallInfoReq() and / or superviseCallReq(). In case the application has not requested additional call related information the Call object is destroyed immediately. 6.4.2.4 Active State In this state a call between two parties is being setup or present. Refer to the substates for more details. The application can request supervision of the call by calling superviseCallReq(). It is also allowed to send Advice of Charge information by calling setAdviceOfCharge() as well as to define the charging by invoking setCallChargePlan. Call processing is suspended when a network event is met for the call, which was requested to be monitored in the P_CALL_MONITOR_MODE_INTERRUPT. In order to resume of the suspended call processing, the application invokes continueProcessing(), routeReq(), release() or deassignCall() method. 6.4.2.5 1 Party in Call State When the Call is in this state a calling party is present. The application can now request that a connection to a called party be established by calling the method routeReq(). In this state the application can also request the gateway for a certain type of charging of the call by calling setCallChargePlan(). The application can also request for charging related information by calling getCallInfoReq(). The setCallChargePlan() and getCallInfoReq() should be issued before requesting a connection to a called party by means of routeReq(). When the calling party abandons the call before the application has invoked the routeReq() operation, the gateway informs the application by invoking callFaultDetected() and also the operation callEnded() will be invoked. When the calling party abandons the call after the application has invoked routeReq() but before the call has actually been established, the gateway informs the application by invoking callEnded(). When the called party answers the call, a transition will be made to the 2 Parties in Call state. In case the call can not be established because the application supplied an invalid address or the connection to the called party was unsuccessful while the application was monitoring for the latter in interrupt mode, the Call object will stay in this state In this state user interaction is possible unless there is an outstanding routing request. 6.4.2.6 2 Parties in Call State A connection between two parties has been established. In case the calling party disconnects, the gateway informs the application by invoking callEnded(). When the called party disconnects different situations apply: 1. the application is monitoring for this event in interrupt mode: a transition is made to the 1 Party in Call state, the application is informed with routeRes with indication that the called party has disconnected and all requested reports are sent to the application. The application now again has control of the call. 2. the application is monitoring for this event but not in interrupt mode. In this case a transition is made to the Network Released state and the gateway informs the application by invoking the operation routeRes() and callEnded(). 3. the application is not monitoring for this event. In this case the application is informed by the gateway invoking the callEnded() operation and a transition is made to the Network Released state. In this state user interaction is possible, depending on the underlying network. 6.5 Generic Call Control Service Properties 6.5.1 List of Service Properties The following table lists properties relevant for the GCC API. Property Type Description / Interpretation P_TRIGGERING_EVENT_TYPES INTEGER_SET Indicates the static event types supported by the SCS. Static events are the events by which applications are initiated. P_DYNAMIC_EVENT_TYPES INTEGER_SET Indicates the dynamic event types supported by the SCS. Dynamic events are the events the application can request for during the context of a call. P_ADDRESSPLAN INTEGER_SET Indicates the supported address plans (defined in TpAddressPlan.) e.g. {P_ADDRESS_PLAN_E164, P_ADDRESS_PLAN_IP}). Note that more than one address plan may be supported. P_UI_CALL_BASED BOOLEAN_SET Value = TRUE : User interaction can be performed on call level and a reference to a Call object can be used in the IpUIManager.createUICall() operation. Value = FALSE: No User interaction on call level is supported. P_UI_AT_ALL_STAGES BOOLEAN_SET Value = TRUE: User Interaction can be performed at any stage during a call . Value = FALSE: User Interaction can be performed in case there is only one party in the call. P_MEDIA_TYPE INTEGER_SET Specifies the media type used by the Service. Values are defined by data-type TpMediaType : P_AUDIO, P_VIDEO, P_DATA The previous table lists properties related to capabilities of the SCS itself. The following table lists properties that are used in the context of the Service Level Agreement, e.g. to restrict the access of applications to the capabilities of the SCS. Property Type Description P_TRIGGERING_ADDRESSES (Deprecated) ADDRESSRANGE_SET Indicates for which numbers the notification may be set. For terminating notifications it applies to the terminating number, for originating notifications it applies only to the originating number. P_NOTIFICATION_ADDRESS_RANGES XML_ADDRESS_RANGE_SET Indicates for which numbers notifications may be set. More than one range may be present. For terminating notifications they apply to the terminating number, for originating notifications they apply only to the originating number. P_NOTIFICATION_TYPES INTEGER_SET Indicates whether the application is allowed to set originating and/or terminating triggers in the ECN. Set is: P_ORIGINATING P_TERMINATING P_MONITOR_MODE INTEGER_SET Indicates whether the application is allowed to monitor in interrupt and/or notify mode. Set is: P_INTERRUPT P_NOTIFY P_NUMBERS_TO_BE_CHANGED INTEGER_SET Indicates which numbers the application is allowed to change or fill for legs in an incoming call. Allowed value set: {P_ORIGINAL_CALLED_PARTY_NUMBER, P_REDIRECTING_NUMBER, P_TARGET_NUMBER, P_CALLING_PARTY_NUMBER}. P_CHARGEPLAN_ALLOWED INTEGER_SET Indicates which charging is allowed in the setCallChargePlan indicator. Allowed values: {P_TRANSPARANT_CHARGING, P_CHARGE_PLAN} P_CHARGEPLAN_MAPPING INTEGER_INTEGER_MAP Indicates the mapping of chargeplans (we assume they can be indicated with integers) to a logical network chargeplan indicator. When the chargeplan supports indicates P_CHARGE_PLAN then only chargeplans in this mapping are allowed. 6.5.2 Service Property values for the CAMEL Service Environment. Implementations of the Generic Call Control API relying on the CSE of CAMEL phase 3 shall have the Service Properties outlined above set to the indicated values : P_OPERATION_SET = { “IpCallControlManager.enableCallNotification”, “IpCallControlManager.disableCallNotification”, “IpCallControlManager.changeCallNotification”, “IpCallControlManager.getCriteria”, “IpCallControlManager.setCallLoadControl”, “IpCall.routeReq”, “IpCall.release”, “IpCall.deassignCall”, “IpCall.getCallInfoReq”, “IpCall.setCallChargePlan”, “IpCall.setAdviceOfCharge”, “IpCall.superviseCallReq” } P_TRIGGERING_EVENT_TYPES = { P_EVENT_GCCS_ADDRESS_COLLECTED_EVENT, P_EVENT_GCCS_ADDRESS_ANALYSED_EVENT, P_EVENT_GCCS_CALLED_PARTY_BUSY, P_EVENT_GCCS_CALLED_PARTY_UNREACHABLE, P_EVENT_GCCS_NO_ANSWER_FROM_CALLED_PARTY, P_EVENT_GCCS_ROUTE_SELECT_FAILURE } P_DYNAMIC_EVENT_TYPES = { P_CALL_REPORT_ANSWER, P_CALL_REPORT_BUSY, P_CALL_REPORT_NO_ANSWER, P_CALL_REPORT_DISCONNECT, P_CALL_REPORT_ROUTING_FAILURE, P_CALL_REPORT_NOT_REACHABLE } P_ADDRESS_PLAN = { P_ADDRESS_PLAN_E164 } P_UI_CALL_BASED = { TRUE } P_UI_AT_ALL_STAGES = { FALSE } P_MEDIA_TYPE = { P_AUDIO } 6.6 Generic Call Control Data Definitions This clause provides the GCC data definitions necessary to support the API specification. The general format of a Data Definition specification is described below. • Data Type This shows the name of the data type. • Description This describes the data type. • Tabular Specification This specifies the data types and values of the data type. • Example If relevant, an example is shown to illustrate the data type. All data types referenced but not defined in this clause are either in the common call control data definitions clause of the present document (clause 8) or in the common data definitions which may be found in 3GPP TS 29.198-2. 6.6.1 Generic Call Control Event Notification Data Definitions 6.6.1.1 TpCallEventName Defines the names of event being notified. The following events are supported. The values may be combined by a logical 'OR' function when requesting the notifications. Additional events that can be requested / received during the call process are found in the TpCallReportType data-type. Name Value Description P_EVENT_NAME_UNDEFINED 0 Undefined P_EVENT_GCCS_OFFHOOK_EVENT 1 GCCS – Offhook event This can be used for hot-line features. In case this event is set in the TpCallEventCriteria, only the originating address(es) may be specified in the criteria. P_EVENT_GCCS_ADDRESS_COLLECTED_EVENT 2 GCCS – Address information collected The network has collected the information from the A-party, but not yet analysed the information. The number can still be incomplete. Applications might set notifications for this event when part of the number analysis needs to be done in the application (see also the getMoreDialledDigitsReq method on the call class). P_EVENT_GCCS_ADDRESS_ANALYSED_EVENT 4 GCCS – Address information is analysed The dialled number is a valid and complete number in the network. P_EVENT_GCCS_CALLED_PARTY_BUSY 8 GCCS – Called party is busy P_EVENT_GCCS_CALLED_PARTY_UNREACHABLE 16 GCCS – Called party is unreachable (e.g. the called party has a mobile telephone that is currently switched off). P_EVENT_GCCS_NO_ANSWER_FROM_CALLED_PARTY 32 GCCS – No answer from called party P_EVENT_GCCS_ROUTE_SELECT_FAILURE 64 GCCS – Failure in routing the call P_EVENT_GCCS_ANSWER_FROM_CALL_PARTY 128 GCCS – Party answered call. 6.6.1.2 TpCallNotificationType Defines the type of notification. Indicates whether it is related to the originating of the terminating user in the call. Name Value Description P_ORIGINATING 0 Indicates that the notification is related to the originating user in the call. P_TERMINATING 1 Indicates that the notification is related to the terminating user in the call. 6.6.1.3 TpCallEventCriteria Defines the Sequence of Data Elements that specify the criteria for a event notification. Of the addresses only the Plan and the AddrString are used for the purpose of matching the notifications against the criteria. Sequence Element Name Sequence Element Type Description DestinationAddress TpAddressRange Defines the destination address or address range for which the notification is requested. OriginatingAddress TpAddressRange Defines the origination address or a address range for which the notification is requested. CallEventName TpCallEventName Name of the event(s) CallNotificationType TpCallNotificationType Indicates whether it is related to the originating or the terminating user in the call. MonitorMode TpCallMonitorMode Defines the mode that the call is in following the notification. Monitor mode P_CALL_MONITOR_MODE_DO_NOT_MONITOR is not a legal value here. 6.6.1.4 TpCallEventInfo Defines the Sequence of Data Elements that specify the information returned to the application in a Call event notification. Sequence Element Name Sequence Element Type DestinationAddress TpAddress OriginatingAddress TpAddress OriginalDestinationAddress TpAddress RedirectingAddress TpAddress CallAppInfo TpCallAppInfoSet CallEventName TpCallEventName CallNotificationType TpCallNotificationType MonitorMode TpCallMonitorMode 6.6.2 Generic Call Control Data Definitions 6.6.2.1 IpCall Defines the address of an IpCall Interface. 6.6.2.2 IpCallRef Defines a Reference to type IpCall. 6.6.2.3 IpAppCall Defines the address of an IpAppCall Interface. 6.6.2.4 IpAppCallRef Defines a Reference to type IpAppCall 6.6.2.5 TpCallIdentifier Defines the Sequence of Data Elements that unambiguously specify the Generic Call object Sequence Element Name Sequence Element Type Sequence Element Description CallReference IpCallRef This element specifies the interface reference for the call object. CallSessionID TpSessionID This element specifies the call session ID of the call. 6.6.2.6 IpAppCallControlManager Defines the address of an IpAppCallControlManager Interface. 6.6.2.7 IpAppCallControlManagerRef Defines a Reference to type IpAppCallControlManager. 6.6.2.8 IpCallControlManager Defines the address of an IpCallControlManager Interface. 6.6.2.9 IpCallControlManagerRef Defines a Reference to type IpCallControlManager. 6.6.2.10 TpCallAppInfo Defines the Tagged Choice of Data Elements that specify application-related call information. Tag Element Type TpCallAppInfoType Tag Element Value Choice Element Type Choice Element Name P_CALL_APP_ALERTING_MECHANISM TpCallAlertingMechanism CallAppAlertingMechanism P_CALL_APP_NETWORK_ACCESS_TYPE TpCallNetworkAccessType CallAppNetworkAccessType P_CALL_APP_TELE_SERVICE TpCallTeleService CallAppTeleService P_CALL_APP_BEARER_SERVICE TpCallBearerService CallAppBearerService P_CALL_APP_PARTY_CATEGORY TpCallPartyCategory CallAppPartyCategory P_CALL_APP_PRESENTATION_ADDRESS TpAddress CallAppPresentationAddress P_CALL_APP_GENERIC_INFO TpString CallAppGenericInfo P_CALL_APP_ADDITIONAL_ADDRESS TpAddress CallAppAdditionalAddress 6.6.2.11 TpCallAppInfoType Defines the type of call application-related specific information. Name Value Description P_CALL_APP_UNDEFINED 0 Undefined P_CALL_APP_ALERTING_MECHANISM 1 The alerting mechanism or pattern to use P_CALL_APP_NETWORK_ACCESS_TYPE 2 The network access type (e.g. ISDN) P_CALL_APP_TELE_SERVICE 3 Indicates the tele-service (e.g. telephony) P_CALL_APP_BEARER_SERVICE 4 Indicates the bearer service (e.g. 64kbit/s unrestricted data). P_CALL_APP_PARTY_CATEGORY 5 The category of the calling party P_CALL_APP_PRESENTATION_ADDRESS 6 The address to be presented to other call parties P_CALL_APP_GENERIC_INFO 7 Carries unspecified service-service information P_CALL_APP_ADDITIONAL_ADDRESS 8 Indicates an additional address 6.6.2.12 TpCallAppInfoSet Defines a Numbered Set of Data Elements of TpCallAppInfo. 6.6.2.13 TpCallEndedReport Defines the Sequence of Data Elements that specify the reason for the call ending. Sequence Element Name Sequence Element Type Description CallLegSessionID TpSessionID The leg that initiated the release of the call. If the call release was not initiated by the leg, then this value is set to –1. Cause TpCallReleaseCause The cause of the call ending. 6.6.2.14 TpCallFault Defines the cause of the call fault detected. Name Value Description P_CALL_FAULT_UNDEFINED 0 Undefined P_CALL_TIMEOUT_ON_RELEASE 1 This fault occurs when the final report has been sent to the application, but the application did not explicitly release or deassign the call object, within a specified time. The timer value is operator specific. P_CALL_TIMEOUT_ON_INTERRUPT 2 This fault occurs when the application did not instruct the gateway how to handle the call within a specified time, after the gateway reported an event that was requested by the application in interrupt mode. The timer value is operator specific. 6.6.2.15 TpCallInfoReport Defines the Sequence of Data Elements that specify the call information requested. Information that was not requested is invalid. Sequence Element Name Sequence Element Type Description CallInfoType TpCallInfoType The type of call report. CallInitiationStartTime TpDateAndTime The time and date when the call, or follow-on call, was started as a result of a routeReq. CallConnectedToResourceTime TpDateAndTime The date and time when the call was connected to the resource. This data element is only valid when information on user interaction is reported. CallConnectedToDestinationTime TpDateAndTime The date and time when the call was connected to the destination (i.e. when the destination answered the call). If the destination did not answer, the time is set to an empty string. This data element is invalid when information on user interaction is reported. CallEndTime TpDateAndTime The date and time when the call or follow-on call or user interaction was terminated. Cause TpCallReleaseCause The cause of the termination. A callInfoReport will be generated at the end of user interaction and at the end of the connection with the associated address. This means that either the destination related information is present or the resource related information, but not both. 6.6.2.16 TpCallReleaseCause Defines the Sequence of Data Elements that specify the cause of the release of a call. Sequence Element Name Sequence Element Type Value TpInt32 Location TpInt32 NOTE: The Value and Location are specified as in ITU-T Recommendation Q.850. The following example was taken from Q.850 to aid understanding: Equivalent Call Report Cause Value Set by Application Cause Value from Network P_CALL_REPORT_BUSY 17 17 P_CALL_REPORT_NO_ANSWER 19 18,19,21 P_CALL_REPORT_DISCONNECT 16 16 P_CALL_REPORT_REDIRECTED 23 23 P_CALL_REPORT_SERVICE_CODE 31 NA P_CALL_REPORT_NOT_REACHABLE 20 20 P_CALL_REPORT_ROUTING_FAILURE 3 Any other value 6.6.2.17 TpCallReport Defines the Sequence of Data Elements that specify the call report and call leg report specific information. Sequence Element Name Sequence Element Type MonitorMode TpCallMonitorMode CallEventTime TpDateAndTime CallReportType TpCallReportType AdditionalReportInfo TpCallAdditionalReportInfo 6.6.2.18 TpCallAdditionalReportInfo Defines the Tagged Choice of Data Elements that specify additional call report information for certain types of reports. Tag Element Type TpCallReportType Tag Element Value Choice Element Type Choice Element Name P_CALL_REPORT_UNDEFINED NULL Undefined P_CALL_REPORT_PROGRESS NULL Undefined P_CALL_REPORT_ALERTING NULL Undefined P_CALL_REPORT_ANSWER NULL Undefined P_CALL_REPORT_BUSY TpCallReleaseCause Busy P_CALL_REPORT_NO_ANSWER NULL Undefined P_CALL_REPORT_DISCONNECT TpCallReleaseCause CallDisconnect P_CALL_REPORT_REDIRECTED TpAddress ForwardAddress P_CALL_REPORT_SERVICE_CODE TpCallServiceCode ServiceCode P_CALL_REPORT_ROUTING_FAILURE TpCallReleaseCause RoutingFailure P_CALL_REPORT_QUEUED TpString QueueStatus P_CALL_REPORT_NOT_REACHABLE TpCallReleaseCause NotReachable 6.6.2.19 TpCallReportRequest Defines the Sequence of Data Elements that specify the criteria relating to call report requests. Sequence Element Name Sequence Element Type MonitorMode TpCallMonitorMode CallReportType TpCallReportType AdditionalReportCriteria TpCallAdditionalReportCriteria 6.6.2.20 TpCallAdditionalReportCriteria Defines the Tagged Choice of Data Elements that specify specific criteria. Tag Element Type TpCallReportType Tag Element Value Choice Element Type Choice Element Name P_CALL_REPORT_UNDEFINED NULL Undefined P_CALL_REPORT_PROGRESS NULL Undefined P_CALL_REPORT_ALERTING NULL Undefined P_CALL_REPORT_ANSWER NULL Undefined P_CALL_REPORT_BUSY NULL Undefined P_CALL_REPORT_NO_ANSWER TpDuration NoAnswerDuration P_CALL_REPORT_DISCONNECT NULL Undefined P_CALL_REPORT_REDIRECTED NULL Undefined P_CALL_REPORT_SERVICE_CODE TpCallServiceCode ServiceCode P_CALL_REPORT_ROUTING_FAILURE NULL Undefined P_CALL_REPORT_QUEUED NULL Undefined P_CALL_REPORT_NOT_REACHABLE NULL Undefined 6.6.2.21 TpCallReportRequestSet Defines a Numbered Set of Data Elements of TpCallReportRequest. 6.6.2.22 TpCallReportType Defines a specific call event report type. Name Value Description P_CALL_REPORT_UNDEFINED 0 Undefined. P_CALL_REPORT_PROGRESS 1 Call routing progress event: an indication from the network that progress has been made in routing the call to the requested call party. This message may be sent more than once, or may not be sent at all by the gateway with respect to routing a given call leg to a given address. P_CALL_REPORT_ALERTING 2 Call is alerting at the call party. P_CALL_REPORT_ANSWER 3 Call answered at address. P_CALL_REPORT_BUSY 4 Called address refused call due to busy. P_CALL_REPORT_NO_ANSWER 5 No answer at called address. P_CALL_REPORT_DISCONNECT 6 The media stream of the called party has disconnected. This does not imply that the call has ended. When the call is ended, the callEnded method is called. This event can occur both when the called party hangs up, or when the application explicitly releases the leg using IpCallLeg.release() This cannot occur when the app explicitly releases the call leg and the call. P_CALL_REPORT_REDIRECTED 7 Call redirected to new address: an indication from the network that the call has been redirected to a new address. P_CALL_REPORT_SERVICE_CODE 8 Mid-call service code received. P_CALL_REPORT_ROUTING_FAILURE 9 Call routing failed - re-routing is possible. P_CALL_REPORT_QUEUED 10 The call is being held in a queue. This event may be sent more than once during the routing of a call. P_CALL_REPORT_NOT_REACHABLE 11 The called address is not reachable; e.g., the phone has been switched off or the phone is outside the coverage area of the network. 6.6.2.23 TpCallTreatment Defines the Sequence of Data Elements that specify the treatment for calls that will be handled only by the network (for example, call which are not admitted by the call load control mechanism). Sequence Element Name Sequence Element Type CallTreatmentType TpCallTreatmentType ReleaseCause TpCallReleaseCause AdditionalTreatmentInfo TpCallAdditionalTreatmentInfo 6.6.2.24 TpCallEventCriteriaResultSet Defines a set of TpCallEventCriteriaResult. 6.6.2.25 TpCallEventCriteriaResult Defines a sequence of data elements that specify a requested call event notification criteria with the associated assignmentID. Sequence Element Name Sequence Element Type Sequence Element Description CallEventCriteria TpCallEventCriteria The event criteria that were specified by the application. AssignmentID TpInt32 The associated assignmentID. This can be used to disable the notification. 7 MultiParty Call Control Service The Multi-Party Call Control API of 3GPP Rel4 relies on the CAMEL Service Environment (CSE). It should be noted that a number of restrictions exist because CAMEL phase 3 supports only two-party calls and no leg based operations. Furthermore application initiated calls are not supported in CAMEL phase 3. The detailed description of the supported methods is given in the chapter 7.5. 7.1 Sequence Diagrams 7.1.1 Application initiated call setup The following sequence diagram shows an application creating a call between party A and party B. Here, a call is created first. Then party A's call leg is created before events are requested on it for answer and then routed to the call. On answer from Party A, an announcement is played indicating that the call is being set up to party B. While the announcement is being played, party B's call leg is created and then events are requested on it for answer. On answer from Party B the announcement is cancelled and party B is routed to the call. The service may as a variation be extended to include 3 parties (or more). After the two party call is established, the application can create a new leg and request to route it to a new destination address in order to establish a 3 party call. The event that causes this to happen could for example be the report of answer event from B-party or controlled by the A-party by entering a service code (mid-call event). The procedure for call setup to party C is exactly the same as for the set up of the connection to party B (sequence 13 to 17 in the sequence diagram). 1: This message is used to create an object implementing the IpAppMultiPartyCall interface. 2: This message requests the object implementing the IpMultiPartyCallControlManager interface to create an object implementing the IpMultiPartyCall interface. 3: Assuming that the criteria for creating an object implementing the IpMultiPartyCall interface (e.g. load control values not exceeded) is met it is created. 4: Once the object implementing the IpMultiPartyCall interface is created it is used to pass the reference of the object implementing the IpAppMultiPartyCall interface as the callback reference to the object implementing the IpMultiPartyCall interface. Note that the reference to the callback interface could already have been passed in the createCall. 5: This message instructs the object implementing the IpMultiPartyCall interface to create a call leg for customer A. 6: Assuming that the criteria for creating an object implementing the IpCallLeg interface is met, message 6 is used to create it. 7: This message requests the call leg for customer A to inform the application when the call leg answers the call. 8: The call is then routed to the originating call leg. 9: Assuming the call is answered, the object implementing party A's IpCallLeg interface passes the result of the call being answered back to its callback object. This message is then forwarded via another message (not shown) to the object implementing the IpAppLogic interface. 10: A UICall object is created and associated with the just created call leg. 11: This message is used to inform party A that the call is being routed to party B. 12: An indication that the dialogue with party A has commenced is returned via message 13 and eventually forwarded via another message (not shown) to the object implementing the IpAppLogic interface. 13: This message instructs the object implementing the IpMultiPartyCall interface to create a call leg for customer B. 14: Assuming that the criteria for creating a second object implementing the IpCallLeg interface is met, it is created. 15: This message requests the call leg for customer B to inform the application when the call leg answers the call. 16: The call is then routed to the call leg. 17: Assuming the call is answered, the object implementing party B's IpCallLeg interface passes the result of the call being answered back to its callback object. This message is then forwarded via another message (not shown) to the object implementing the IpAppLogic interface. 18: This message then instructs the object implementing the IpUICall interface to stop sending announcements to party A. 19: The application deassigns the call. This will also deassign the associated user interaction. 7.1.2 Call Barring 2 The following sequence diagram shows a call barring service, initiated as a result of a prearranged event being received by the call control service. Before the call is routed to the destination number, the calling party is asked for a PIN code. The code is rejected and the call is cleared. 1: This message is used by the application to create an object implementing the IpAppMultiPartyCallControlManager interface. 2: This message is sent by the application to enable notifications on new call events. As this sequence diagram depicts a call barring service, it is likely that all new call events destined for a particular address or address range prompted for a password before the call is allowed to progress. When a new call, that matches the event criteria, arrives a message (not shown) is directed to the object implementing the IpMultiPartyCallControlManager. Assuming that the criteria for creating an object implementing the IpMultiPartyCall interface (e.g. load control values not exceeded) is met, other messages (not shown) are used to create the call and associated call leg object. 3: This message is used to pass the new call event to the object implementing the IpAppMultiPartyCallControlManager interface. 4: This message is used to forward message 3 to the IpAppLogic. 5: This message is used by the application to create an object implementing the IpAppMultiPartyCall interface. The reference to this object is passed back to the object implementing the IpMultiPartyCallControlManager using the return parameter of the callEventNotify. 6: The application requests an list of all the legs currently in the call. 7: This message is used to create a UICall object that is associated with the incoming leg of the call. 8: The call barring service dialogue is invoked. 9: The result of the dialogue, which in this case is the PIN code, is returned to its callback object. 10: This message is used to forward the previous message to the IpAppLogic 11: Assuming an incorrect PIN is entered, the calling party is informed using additional dialogue of the reason why the call cannot be completed. 12: This message passes the indication that the additional dialogue has been sent. 13: This message is used to forward the previous message to the IpAppLogic. 14: No more UI is required, so the UICall object is released. 15: This message is used by the application to clear the call. 7.1.3 Call forwarding on Busy Service The following sequence diagram shows an application establishing a call forwarding on busy. When a call is made from A to B but the B-party is detected to be busy, then the application is informed of this and sets up a connection towards a C party. The C party can for instance be a voicemail system. 1: This message is used by the application to create an object implementing the IpAppMultiPartyCallControlManager interface. 2: This message is sent by the application to enable notifications on new call events. 3: 4: When a new call, that matches the event criteria, arrives a message ("busy") is directed to the object implementing the IpMultiPartyCallControlManager. Assuming that the criteria for creating an object implementing the IpMultiPartyCall interface is met, other messages are used to create the call and associated call leg objects. 5: 6: A new MultiPartyCall object is created to handle this particular call. 7: A new CallLeg object corresponding to Party A is created. 8: The new Call Leg instance transits to state Initiating. 9: 10: 11: This message is used to pass the new call event to the object implementing the IpAppMultiPartyCallControlManager interface. Applied monitor mode is "interrupt" 12: This message is used to forward the message to the IpAppLogic. 13: This message is used by the application to create an object implementing the IpAppMultiPartyCall interface. The reference to this object is passed back to the object implementing the IpMultiPartyCallControlManager using the return parameter of the reportNotification. 14: A new AppCallLeg is created to receive callbacks for the Leg corresponding to party A. 15: A new AppCallLeg C is created to receive callbacks for another leg. 16: This message is used to create a new call leg object. The object is created in the idle state and not yet routed in the network. 17: 18: 19: The application requests to be notified (monitor mode "INTERRUPT") when party C answers the call. 20: The application requests to route the terminating leg to reach the associated party C. The application may request information about the original destination address be sent by setting up the field P_CALL_APP_ORIGINAL_DESTINATION_ADDRESS of TpCallAppInfo in the request to route the call leg to the remote party C. 21: 22: 23: The application requests to resume call processing for the terminating call leg to party B to terminate the leg. Alternative the application could request to deassign the leg to party B for example if it is not interested in possible requested call leg information (getInfoRes, superviseRes). When the terminating call leg is destroyed, the AppLeg B is notified and the event is forwarded to the application logic (not shown). 24: 25: The application requests to resume call processing for the originating call leg. As a result call processing is resumed in the network that will try to reach the associated party B. 26: When the party C answers the call, the termination call leg is notified. 27: Assuming the call is answered, the object implementing party C's IpCallLeg interface passes the result of the call being answered back to its callback object. 28: This answer message is then forwarded to the object implementing the IpAppLogic interface. 7.1.4 Call Information Collect Service The following sequence diagram shows an application monitoring a call between party A and a party B in order to collect call information at the end of the call for e.g. charging and/or statistic information collection purposes. The service may apply to ordinary two-party calls, but could also include a number translation of the dialled number and special charging (e.g. a premium rate service) . Additional call leg related information is requested with the getInfoReq and superviseReq methods. The answer and call release events are in this service example requested to be reported in notify mode and additional call leg related information is requested with the getInfoReq and superviseReq methods in order to illustrate the information that can be collected and sent to the application at the end of the call. Furthermore is shows the order in which information is sent to the application: network release event followed by possible requested call leg information, then the destroy of the call leg object (callLegEnded) and finally the destroy of the call object (callEnded). 1: This message is used by the application to create an object implementing the IpAppMultiPartyCallControlManager interface. 2: This message is sent by the application to enable notifications on new call events. 3: 4: When a new call, that matches the event criteria, arrives a message ("analysed information") is directed to the object implementing the IpMultiPartyCallControlManager. Assuming that the criteria for creating an object implementing the IpMultiPartyCall interface is met, other messages are used to create the call and associated call leg object 5: 6: A new MultiPartyCall object is created to handle this particular call. 7: A new CallLeg object corresponding to Party A is created. 8: The new Call Leg instance transits to state Active. 9: This message is used to pass the new call event to the object implementing the IpAppMultiPartyCallControlManager interface. Applied monitor mode is "interrupt" 10: This message is used to forward message 9 to the IpAppLogic. 11: This message is used by the application to create an object implementing the IpAppMultiPartyCall interface. The reference to this object is passed back to the object implementing the IpMultiPartyCallControlManager using the return parameter of the reportNotification. 12: A new AppCallLeg is created to receive callbacks for the Leg corresponding to party A. 13: A new AppCallLeg is created to receive callbacks for another leg. 14: This message is used to create a new call leg object. The object is created in the idle state and not yet routed in the network. 15: A new CallLeg corresponding to party B is created. 16: A transition to state Idle is made after the Call leg has been created. 17: The application requests to be notified (monitor mode "NOTIFY") when party B answers the call and when the leg to B-party is released. 18: The application requests to supervise the call leg to party B. 19: The application requests information associated with the call leg to party b for example to calculate charging. 20: The application requests a specific charge plan to be set for the call leg to party B. 21: The application requests to route the terminating leg to reach the associated party B. 22: The Call Leg instance transits to state Active. 23: 24: The application requests to be notified (monitor mode "Notify") when the leg to A-party is released. 25: The application requests information associated with the call leg to party A for example to calculate charging. 26: The application requests to resume call processing for the originating call leg. As a result call processing is resumed in the network that will try to reach the associated party B. 27: 28: 29: When the B-party answers the call, the termination call leg is notified. 30: Assuming the call is answered, the object implementing party B's IpCallLeg interface passes the result of the call being answered back to its callback object (monitor mode "NOTIFY"). 31: This answer message is then forwarded. 32: When the A-party releases the call, the originating call leg is notified (monitor mode "NOTIFY") and makes a transition to "releasing state". 33: 34: The application IpAppLeg A is notified, as the release event has been requested to be reported in Notify mode. 35: The event is forwarded to the application logic 36: The call leg information is reported. 37: The event is forwarded to the application logic 38: The origination call leg is destroyed, the AppLeg A is notified. 39: The event is forwarded to the application logic 40: 41: When the B-party releases the call or the call is released as a result of the release request from party A, i.e. a "originating release" indication, the terminating call leg is notified and makes a transition to "releasing state". 42: 43: If a network release event is received being a "terminating release" indication from called party B, the application IpAppLeg B is notified, as the release event from party B has been requested to be reported in NOTIFY mode. Note that no report is sent if the release is caused by propagation of network release event being a "originating release" indication coming from calling party A. 44: The event is forwarded to the application logic. 45: The call leg information is reported. 46: The event is forwarded to the application logic. 47: The supervised call leg information is reported. 48: The event is forwarded to the application logic. 49: The terminating call leg is destroyed, the AppLeg B is notified. 50: The event is forwarded to the application logic. 51: 52: Assuming the IpCall object has been informed that the legs have been destroyed, the IpAppMultiPartyCall is notified that the call is ended . 53: The event is forwarded to the application logic. 7.1.5 Complex Card Service The following sequence diagram shows an advanced card service, initiated as a result of a prearranged event being received by the call control service. Before the call is made, the calling party is asked for an ID and PIN code. If the ID and PIN code are accepted, the calling party is prompted to enter the address of the destination party. A trigger of '#5' is then set on the controlling leg (the calling party's leg) such that if the calling party enters a '#5' an event will be sent to the application. The call is then routed to the destination party. Sometime during the call the calling party enters '#5' which causes the called leg to be released. The calling party is now prompted to enter the address of a new destination party, to which it is then routed. 1: This message is used by the application to create an object implementing the IpAppMultiPartyCallControlManager interface. 2: This message is sent by the application to enable notifications on new call events. As this sequence diagram depicts a call barring service, it is likely that all new call events destined for a particular address or address range result in the caller being prompted for a password before the call is allowed to progress. When a new call, that matches the event criteria set in message 2, arrives a message (not shown) is directed to the object implementing the IpMultiPartyCallControlManager. Assuming that the criteria for creating an object implementing the IpMultiPartyCall interface (e.g. load control values not exceeded) is met, other messages (not shown) are used to create the call and associated call leg object. 3: This message is used to pass the new call event to the object implementing the IpAppMultiPartyCallControlManager interface. 4: This message is used to forward message 3 to the IpAppLogic. 5: This message is used by the application to create an object implementing the IpAppMultiPartyCall interface. The reference to this object is passed back to the object implementing the IpMultiPartyCallControlManager using the return parameter of message 3. 6: This message returns the call legs currently in the call. In principle a reference to the call leg of the calling party is already obtained by the application when it was notified of the new call event. 7: This message is used to associate a user interaction object with the calling party. 8: The initial card service dialogue is invoked using this message. 9: The result of the dialogue, which in this case is the ID and PIN code, is returned to its callback object using this message and eventually forwarded via another message (not shown) to the IpAppLogic. 10: Assuming the correct ID and PIN are entered, the final dialogue is invoked. 11: The result of the dialogue, which in this case is the destination address, is returned and eventually forwarded via another message (not shown) to the IpAppLogic. 12: This message is used to forward the address of the callback object. 13: The trigger for follow-on calls is set (on service code). 14: A new AppCallLeg is created to receive callbacks for another leg. Alternatively, the already existing AppCallLeg object could be passed in the subsequent createCallLeg(). In that case the application has to use the sessionIDs of the legs to distinguish between callbacks destined for the A-leg and callbacks destined for the B-leg. 15: This message is used to create a new call leg object. The object is created in the idle state and not yet routed in the network. 16: The application requests to be notified when the leg is answered. 17: The application routes the leg. As a result the network will try to reach the associated party. 18: When the B-party answers the call, the application is notified. 19: The event is forwarded to the application logic. 20: Legs that are created and routed explicitly are by default in state detached. This means that the media is not connected to the other parties in the call. In order to allow inband communication between the new party and the other parties in the call the media have to be explicitly attached. 21: At some time during the call the calling party enters '#5'. This causes this message to be sent to the object implementing the IpAppCallLeg interface, which forwards this event as a message (not shown) to the IpAppLogic. 22: The event is forwarded to the application. 23: This message releases the called party. 24: Another user interaction dialogue is invoked. 25: The result of the dialogue, which in this case is the new destination address is returned and eventually forwarded via another message (not shown) to the IpAppLogic. 26: A new AppCallLeg is created to receive callbacks for another leg. 27: The call is then forward routed to the new destination party. 28: As a result a new Callleg object is created. 29: This message passes the result of the call being answered to its callback object and is eventually forwarded via another message (not shown) to the IpAppLogic. 30: When the A-party terminates the application is informed. 31: The event is forwarded to the application logic. 32: Since the release of the A-party will in this case terminate the entire call, the application is also notified with this message. 33: The event is forwarded to the application logic. 34: Since the user interaction object were not released at the moment that the call terminated, the application receives this message to indicate that the UI resources are released in the gateway and no further communication is possible. 35: The event is forwarded to the application logic. 36: The application deassigns the call object. 7.1.6 Hotline Service The following sequence diagram shows an application establishing a call between party A and pre-arranged party B defined to constitute a hot-line address. The address of the destination party is provided by the application as the calling party makes a call attempt (goes off-hook) and do not dial any number within a predefined time. In this case a pre-defined number (hot-line number) is provided by the application. The call is then routed to the pre-defined destination party. The call release is monitored to enable the sending of information to the application at call release, e.g. for charging purposes. Note that this service could be extended as follows: Sometime during the call the calling party enters '#5' which causes the called leg to be released. The calling party is now prompted to enter the address of a new destination party, to which it is then routed. 1: This message is used by the application to create an object implementing the IpAppMultiPartyCallControlManager interface. 2: This message is sent by the application to enable notifications on new call events. 3: 4: When a new call, that matches the event criteria, arrives a message ("analysed information") is directed to the object implementing the IpMultiPartyCallControlManager. Assuming that the criteria for creating an object implementing the IpMultiPartyCall interface is met, other messages are used to create the call and associated call leg object 5: 6: A new MultiPartyCall object is created to handle this particular call. 7: A new CallLeg object corresponding to Party A is created. 8: The new Call Leg instance transits to state Initiating. 9: This message is used to pass the new call event to the object implementing the IpAppMultiPartyCallControlManager interface. Applied monitor mode is "interrupt" 10: This message is used to forward message 9 to the IpAppLogic. 11: This message is used by the application to create an object implementing the IpAppMultiPartyCall interface. The reference to this object is passed back to the object implementing the IpMultiPartyCallControlManager using the return parameter of the reportNotification. 12: A new AppCallLeg is created to receive callbacks for the Leg corresponding to party A. 13: A new AppCallLeg is created to receive callbacks for another leg. 14: This message is used to create a new call leg object. The object is created in the idle state and not yet routed in the network. 15: A new CallLeg corresponding to party B is created. 16: A transition to state Idle is made after the Call leg has been created. 17: The application requests to be notified (monitor mode "NOTIFY") when the leg to party B is released. 18: The application requests to route the terminating leg to reach the associated party as specified by the application ("hot-line number"). 19: The Call Leg instance transits to state Active. 20: 21: The application requests to be notified (monitor mode "Notify") when the leg to A-party is released. 22: The application requests to resume call processing for the originating call leg. As a result call processing is resumed in the network that will try to reach the associated party as specified by the application (E.164 number provided by application). 23: 24: 25: The originating call leg is notified that the number (provided by application) has been analysed by the network and the originating call leg STD makes a transition to "active" state. The application is not notified as it has not requested this event to be reported. 26: 27: When the B-party releases the call, the terminating call leg is notified (monitor mode "NOTIFY") and makes a transition to "Releasing state". 28: 29: The application is notified, as the release event has been requested to be reported in Notify mode. 30: The event is forwarded to the application logic. 31: The terminating call leg is destroyed, the AppLeg B is notified. 32: This answer message is then forwarded. 33: 34: When the call release ("terminating release" indication) is propagated in the network toward the party A, the originating call leg is notified and makes a transition to "releasing state". This release event (being propagated from party B) is not reported to the application. 35: 36: When the originating call leg is destroyed, the AppLeg A is notified. 37: The event is forwarded to the application logic 38: 39: When all legs have been destroyed, the IpAppMultiPartyCall is notified that the call is ended. 40: The event is forwarded to the application logic. 7.1.7 Use of the Redirected event 1: The application has already created the call and a call leg. It places an event report request for the ANSWER and REDIRECTED events in NOTIFY mode. 2: The application routes the call leg. 3: The call is redirected within the network and the application is informed. The new destination address is passed within the event. The event is not disarmed, so subsequent redirections will also be reported. Also, the same call leg is used so the application does not have to create a new one. 4: The call is answered at its new destination. 7.2 Class Diagrams The multiparty call control service consists of two packages, one for the interfaces on the application side and one for interfaces on the service side. The class diagrams in the following figures show the interfaces that make up the multi party call control application package and the multi party call control service package. This class diagram shows the interfaces of the multi-party call control application package and their relations to the interfaces of the multi-party call control service package. Figure: Application Interfaces This class diagram shows the interfaces of the multi-party call control service package. Figure: Service Interfaces 7.3 MultiParty Call Control Service Interface Classes The Multi-party Call Control service enhances the functionality of the Generic Call Control Service with leg management. It also allows for multi-party calls to be established, i.e., up to a service specific number of legs can be connected simultaneously to the same call. The Multi-party Call Control Service is represented by the IpMultiPartyCallControlManager, IpMultiPartyCall, IpCallLeg interfaces that interface to services provided by the network. Some methods are asynchronous, in that they do not lock a thread into waiting whilst a transaction performs. In this way, the client machine can handle many more calls, than one that uses synchronous message calls. To handle responses and reports, the developer must implement IpAppMultiPartyCallControlManager, IpAppMultiPartyCall and IpAppCallLeg to provide the callback mechanism. 7.3.1 Interface Class IpMultiPartyCallControlManager Inherits from: IpService This interface is the 'service manager' interface for the Multi-party Call Control Service. The multi-party call control manager interface provides the management functions to the multi-party call control service. The application programmer can use this interface to provide overload control functionality, create call objects and to enable or disable call-related event notifications. The action table associated with the STD shows in what state the IpMultiPartyCallControlManager must be if a method can successfully complete. In other words, if the IpMultiPartyCallControlManager is in another state the method will throw an exception immediately. This interface shall be implemented by a Multi Party Call Control SCF. As a minimum requirement either the createCall() method shall be implemented, or the createNotification() and destroyNotification() methods shall be implemented. <<Interface>> IpMultiPartyCallControlManager createCall (appCall : in IpAppMultiPartyCallRef) : TpMultiPartyCallIdentifier createNotification (appCallControlManager : in IpAppMultiPartyCallControlManagerRef, notificationRequest : in TpCallNotificationRequest) : TpAssignmentID destroyNotification (assignmentID : in TpAssignmentID) : void changeNotification (assignmentID : in TpAssignmentID, notificationRequest : in TpCallNotificationRequest) : void getNotification () : TpNotificationRequestedSet setCallLoadControl (duration : in TpDuration, mechanism : in TpCallLoadControlMechanism, treatment : in TpCallTreatment, addressRange : in TpAddressRange) : TpAssignmentID Method createCall() This method is used to create a new call object. An IpAppMultiPartyCallControlManager should already have been passed to the IpMultiPartyCallControlManager, otherwise the call control will not be able to report a callAborted() to the application. The application shall invoke setCallback() prior to createCall() if it wishes to ensure this. Returns callReference: Specifies the interface reference and sessionID of the call created. Parameters appCall : in IpAppMultiPartyCallRef Specifies the application interface for callbacks from the call created. Returns TpMultiPartyCallIdentifier Raises TpCommonExceptions, P_INVALID_INTERFACE_TYPE Method createNotification() This method is used to enable call notifications so that events can be sent to the application. This is the first step an application has to do to get initial notifications of calls happening in the network. When such an event happens, the application will be informed by reportNotification(). In case the application is interested in other events during the context of a particular call session it has to use the createAndRouteCallLegReq() method on the call object or the eventReportReq() method on the call leg object. The application will get access to the call object when it receives the reportNotification(). (Note that createNotification() is not applicable if the call is setup by the application). The createNotification method is purely intended for applications to indicate their interest to be notified when certain call events take place. It is possible to subscribe to a certain event for a whole range of addresses, e.g. the application can indicate it wishes to be informed when a call is made to any number starting with 800. If some application already requested notifications with criteria that overlap the specified criteria, the request is refused with P_INVALID_CRITERIA. The criteria are said to overlap if both originating and terminating ranges overlap and the same number plan is used. If a notification is requested by an application with monitor mode set to notify, then there is no need to check the rest of the criteria for overlapping with any existing request as the notify mode does not allow control on a call to be passed over. Only one application can place an interrupt request if the criteria overlaps. Set of the callback reference: The call back reference can be registered either in a) createNotification() or b) explicitly with a setCallback() method e.g. depending on how the application provides its callback reference. Case a: From an efficiency point of view the createNotification() with explicit registration may be the preferred method. Case b: The createNotification() with no call back reference ("Null" value) is used where (e.g. due to distributed application logic) the call back reference is provided previously in a setCallback(). If no callback reference has been provided previously to the service, the exception, P_NO_CALLBACK_ADDRESS_SET shall be raised. In case the createNotification() contains no callback, at the moment the application needs to be informed the gateway will use as callback the callback that has been registered by setCallback(). Set additional Call back: If the same application requests two notifications with exactly the same criteria but different callback references, the second callback will be treated as an additional callback. Both notifications will share the same assignmentID. The gateway will always use the most recent callback. In case this most recent callback fails the second most recent is used. Returns assignmentID: Specifies the ID assigned by the call control manager interface for this newly-enabled event notification. Parameters appCallControlManager : in IpAppMultiPartyCallControlManagerRef If this parameter is set (i.e. not NULL) it specifies a reference to the application interface, which is used for callbacks. If set to NULL, the application interface defaults to the interface specified previously via the setCallback() method. notificationRequest : in TpCallNotificationRequest Specifies the event specific criteria used by the application to define the event required. Only events that meet these criteria are reported. Examples of events are "incoming call attempt reported by network", "answer", "no answer", "busy". Individual addresses or address ranges may be specified for destination and/or origination. Returns TpAssignmentID Raises TpCommonExceptions, P_INVALID_CRITERIA, P_INVALID_INTERFACE_TYPE, P_INVALID_EVENT_TYPE Method destroyNotification() This method is used by the application to disable call notifications. Parameters assignmentID : in TpAssignmentID Specifies the assignment ID given by the generic call control manager interface when the previous enableNotification() was called. If the assignment ID does not correspond to one of the valid assignment IDs, the exception P_INVALID_ASSIGNMENTID will be raised. If two callbacks have been registered under this assignment ID both of them will be disabled. Raises TpCommonExceptions, P_INVALID_ASSIGNMENT_ID Method changeNotification() This method is used by the application to change the event criteria introduced with createNotification. Any stored criteria associated with the specified assignmentID will be replaced with the specified criteria. Parameters assignmentID : in TpAssignmentID Specifies the ID assigned by the generic call control manager interface for the event notification. If two callbacks have been registered under this assignment ID both of them will be changed. notificationRequest : in TpCallNotificationRequest Specifies the new set of event specific criteria used by the application to define the event required. Only events that meet these criteria are reported. Raises TpCommonExceptions, P_INVALID_ASSIGNMENT_ID, P_INVALID_CRITERIA, P_INVALID_EVENT_TYPE Method getNotification() This method is used by the application to query the event criteria set with createNotification or changeNotification. Returns notificationsRequested: Specifies the notifications that have been requested by the application. Parameters No Parameters were identified for this method Returns TpNotificationRequestedSet Raises TpCommonExceptions Method setCallLoadControl() This method imposes or removes load control on calls made to a particular address range within the call control service. The address matching mechanism is similar as defined for TpCallEventCriteria. Returns assignmentID: Specifies the assignmentID assigned by the gateway to this request. This assignmentID can be used to correlate the callOverloadEncountered and callOverloadCeased methods with the request. Parameters duration : in TpDuration Specifies the duration for which the load control should be set. A duration of 0 indicates that the load control should be removed. A duration of -1 indicates an infinite duration (i.e., until disabled by the application) A duration of -2 indicates the network default duration. mechanism : in TpCallLoadControlMechanism Specifies the load control mechanism to use (for example, admit one call per interval), and any necessary parameters, such as the call admission rate. The contents of this parameter are ignored if the load control duration is set to zero. treatment : in TpCallTreatment Specifies the treatment of calls that are not admitted. The contents of this parameter are ignored if the load control duration is set to zero. addressRange : in TpAddressRange Specifies the address or address range to which the overload control should be applied or removed. Returns TpAssignmentID Raises TpCommonExceptions, P_INVALID_ADDRESS, P_UNSUPPORTED_ADDRESS_PLAN 7.3.2 Interface Class IpAppMultiPartyCallControlManager Inherits from: IpInterface The Multi-Party call control manager application interface provides the application call control management functions to the Multi-Party call control service. <<Interface>> IpAppMultiPartyCallControlManager reportNotification (callReference : in TpMultiPartyCallIdentifier, callLegReferenceSet : in TpCallLegIdentifierSet, notificationInfo : in TpCallNotificationInfo, assignmentID : in TpAssignmentID) : TpAppMultiPartyCallBack callAborted (callReference : in TpSessionID) : void managerInterrupted () : void managerResumed () : void callOverloadEncountered (assignmentID : in TpAssignmentID) : void callOverloadCeased (assignmentID : in TpAssignmentID) : void Method reportNotification() This method notifies the application of the arrival of a call-related event. If this method is invoked with a monitor mode of P_CALL_MONITOR_MODE_INTERRUPT, then the APL has control of the call. If the APL does nothing with the call (including its associated legs) within a specified time period (the duration of which forms a part of the service level agreement), then the call in the network shall be released and callEnded() shall be invoked, giving a release cause of P_TIMER_EXPIRY. Set of the callback reference: A reference to the application interface has to be passed back to the call interface to which the notification relates. However, the setting of a call back reference is only applicable if the notification is in INTERRUPT mode. When reportNotification() is invoked with a monitor mode of P_CALL_MONITOR_MODE_INTERRUPT, the application writer should ensure that no continue processing e.g. createAndRouteCallLegReq() is performed until the callback interface for the new call and/or new call leg has been passed to the gateway, either through an explicit setCallbackWithSessionID() invocation, or via the return of the reportNotification() method. The call back reference can be registered either in a) reportNotification() or b) explicitly with a setCallbackWithSessionID() method depending on how the application provides its callback reference. Case a: From an efficiency point of view the reportNotification() with explicit pass of registration may be the preferred method. Case b: The reportNotification() with no call back reference ("Null" value) is used where (e.g. due to distributed application logic) the call back reference is provided previously in a setCallbackWithSessionID(). If no callback reference has been provided previously to the service, the exception, P_NO_CALLBACK_ADDRESS_SET shall be raised, and no further application invocations related to the call shall be permitted. In case reportNotification() contains no callback, at the moment the application needs to be informed the gateway will use as callback the callback that has been registered previously by setCallbackWithSessionID(). Returns appCallBack: Specifies references to the application interface which implements the callback interface for the new call and/or new call leg. If the application has previously explicitly passed a reference to the callback interface using a setCallbackWithSessionID() invocation, this parameter may be set to P_APP_CALLBACK_UNDEFINED, or if supplied must be the same as that provided during the setCallbackWithSessionID(). This parameter will be set to P_APP_CALLBACK_UNDEFINED if the notification is in NOTIFY mode and in case b. Parameters callReference : in TpMultiPartyCallIdentifier Specifies the reference to the call interface to which the notification relates. If the notification is being given in NOTIFY mode, this parameter shall be ignored by the application client implementation, and consequently the implementation of the SCS entity invoking reportNotification may populate this parameter as it chooses. callLegReferenceSet : in TpCallLegIdentifierSet Specifies the set of all call leg references. First in the set is the reference to the originating callLeg. It indicates the call leg related to the originating party. In case there is a destination call leg this will be the second leg in the set. from the notificationInfo can be found on whose behalf the notification was sent. However, if the notification is being given in NOTIFY mode, this parameter shall be ignored by the application client implementation, and consequently the implementation of the SCS entity invoking reportNotification may populate this parameter as it chooses. notificationInfo : in TpCallNotificationInfo Specifies data associated with this event (e.g. the originating or terminating leg which reports the notification ). assignmentID : in TpAssignmentID Specifies the assignment id which was returned by the createNotification() method. The application can use assignment id to associate events with event specific criteria and to act accordingly. Returns TpAppMultiPartyCallBack Method callAborted() This method indicates to the application that the call object has aborted or terminated abnormally. No further communication will be possible between the call and application. Parameters callReference : in TpSessionID Specifies the sessionID of call that has aborted or terminated abnormally. Method managerInterrupted() This method indicates to the application that event notifications and method invocations have been temporarily interrupted (for example, due to network resources unavailable). Note that more permanent failures are reported via the Framework (integrity management). Parameters No Parameters were identified for this method Method managerResumed() This method indicates to the application that event notifications are possible and method invocations are enabled. Parameters No Parameters were identified for this method Method callOverloadEncountered() This method indicates that the network has detected overload and may have automatically imposed load control on calls requested to a particular address range or calls made to a particular destination within the call control service. Parameters assignmentID : in TpAssignmentID Specifies the assignmentID corresponding to the associated setCallLoadControl. This implies the addressrange for within which the overload has been encountered. Method callOverloadCeased() This method indicates that the network has detected that the overload has ceased and has automatically removed any load controls on calls requested to a particular address range or calls made to a particular destination within the call control service. Parameters assignmentID : in TpAssignmentID Specifies the assignmentID corresponding to the associated setCallLoadControl. This implies the addressrange for within which the overload has been ceased 7.3.3 Interface Class IpMultiPartyCall Inherits from: IpService The Multi-Party Call provides the possibility to control the call routing, to request information from the call, control the charging of the call, to release the call and to supervise the call. It also gives the possibility to manage call legs explicitly. An application may create more then one call leg. This interface shall be implemented by a Multi Party Call Control SCF. The release() and deassignCall() methods, and either the createCallLeg() or the createAndRouteCallLegReq(), shall be implemented as a minimum requirement. <<Interface>> IpMultiPartyCall getCallLegs (callSessionID : in TpSessionID) : TpCallLegIdentifierSet createCallLeg (callSessionID : in TpSessionID, appCallLeg : in IpAppCallLegRef) : TpCallLegIdentifier createAndRouteCallLegReq (callSessionID : in TpSessionID, eventsRequested : in TpCallEventRequestSet, targetAddress : in TpAddress, originatingAddress : in TpAddress, appInfo : in TpCallAppInfoSet, appLegInterface : in IpAppCallLegRef) : TpCallLegIdentifier release (callSessionID : in TpSessionID, cause : in TpReleaseCause) : void deassignCall (callSessionID : in TpSessionID) : void getInfoReq (callSessionID : in TpSessionID, callInfoRequested : in TpCallInfoType) : void setChargePlan (callSessionID : in TpSessionID, callChargePlan : in TpCallChargePlan) : void setAdviceOfCharge (callSessionID : in TpSessionID, aOCInfo : in TpAoCInfo, tariffSwitch : in TpDuration) : void superviseReq (callSessionID : in TpSessionID, time : in TpDuration, treatment : in TpCallSuperviseTreatment) : void Method getCallLegs() This method requests the identification of the call leg objects associated with the call object. Returns the legs in the order of creation. Returns callLegList: Specifies the call legs associated with the call. The set contains both the sessionIDs and the interface references. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. Returns TpCallLegIdentifierSet Raises TpCommonExceptions, P_INVALID_SESSION_ID Method createCallLeg() This method requests the creation of a new call leg object. Returns callLeg: Specifies the interface and sessionID of the call leg created. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. appCallLeg : in IpAppCallLegRef Specifies the application interface for callbacks from the call leg created. Returns TpCallLegIdentifier Raises TpCommonExceptions, P_INVALID_SESSION_ID, P_INVALID_INTERFACE_TYPE Method createAndRouteCallLegReq() This asynchronous operation requests creation and routing of a new callLeg. In case the connection to the destination party is established successfully the CallLeg is attached to the call, i.e. no explicit attachMediaReq() operation is needed. Requested events will be reported on the IpAppCallLeg interface. This interface the application must provide through the appLegInterface parameter. The extra address information such as originatingAddress is optional. If not present (i.e., the plan is set to P_ADDRESS_PLAN_NOT_PRESENT), the information provided in corresponding addresses from the route is used, otherwise the network or gateway provided numbers will be used. If the application wishes that the call leg should be represented in the network as being a redirection it should include a value for the field P_CALL_APP_ORIGINAL_DESTINATION_ADDRESS of TpCallAppInfo. If this method is invoked, and call reports have been requested, yet the IpAppCallLeg interface parameter is NULL, this method shall throw the P_NO_CALLBACK_ADDRESS_SET exception. Returns callLegReference: Specifies the reference to the CallLeg interface that was created. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. eventsRequested : in TpCallEventRequestSet Specifies the event specific criteria used by the application to define the events required. Only events that meet these criteria are reported. Examples of events are "address analysed", "answer" and "release". targetAddress : in TpAddress Specifies the destination party to which the call should be routed. originatingAddress : in TpAddress Specifies the address of the originating (calling) party. appInfo : in TpCallAppInfoSet Specifies application-related information pertinent to the call (such as alerting method, tele-service type, service identities and interaction indicators). appLegInterface : in IpAppCallLegRef Specifies a reference to the application interface that implements the callback interface for the new call leg. Requested events will be reported by the eventReportRes() operation on this interface. Returns TpCallLegIdentifier Raises TpCommonExceptions, P_INVALID_SESSION_ID, P_INVALID_INTERFACE_TYPE, P_INVALID_ADDRESS, P_UNSUPPORTED_ADDRESS_PLAN, P_INVALID_NETWORK_STATE, P_INVALID_EVENT_TYPE, P_INVALID_CRITERIA Method release() This method requests the release of the call object and associated objects. The call will also be terminated in the network. If the application requested reports to be sent at the end of the call (e.g., by means of getInfoReq) these reports will still be sent to the application. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. cause : in TpReleaseCause Specifies the cause of the release. Raises TpCommonExceptions, P_INVALID_SESSION_ID, P_INVALID_NETWORK_STATE Method deassignCall() This method requests that the relationship between the application and the call and associated objects be de-assigned. It leaves the call in progress, however, it purges the specified call object so that the application has no further control of call processing. If a call is de-assigned that has call information reports, call leg event reports or call Leg information reports requested, then these reports will be disabled and any related information discarded. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. Raises TpCommonExceptions, P_INVALID_SESSION_ID Method getInfoReq() This asynchronous method requests information associated with the call to be provided at the appropriate time (for example, to calculate charging). This method must be invoked before the call is routed to a target address. A report is received when the destination leg or party terminates or when the call ends. The call object will exist after the call is ended if information is required to be sent to the application at the end of the call. In case the originating party is still available the application can still initiate a follow-on call using routeReq. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. callInfoRequested : in TpCallInfoType Specifies the call information that is requested. Raises TpCommonExceptions, P_INVALID_SESSION_ID Method setChargePlan() Set an operator specific charge plan for the call. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. callChargePlan : in TpCallChargePlan Specifies the charge plan to use. Raises TpCommonExceptions, P_INVALID_SESSION_ID Method setAdviceOfCharge() This method allows for advice of charge (AOC) information to be sent to terminals that are capable of receiving this information. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. aOCInfo : in TpAoCInfo Specifies two sets of Advice of Charge parameter. tariffSwitch : in TpDuration Specifies the tariff switch interval that signifies when the second set of AoC parameters becomes valid. Raises TpCommonExceptions, P_INVALID_SESSION_ID, P_INVALID_CURRENCY, P_INVALID_AMOUNT Method superviseReq() The application calls this method to supervise a call. The application can set a granted connection time for this call. If an application calls this operation before it routes a call or a user interaction operation the time measurement will start as soon as the call is answered by the B-party or the user interaction system. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. time : in TpDuration Specifies the granted time in milliseconds for the connection. treatment : in TpCallSuperviseTreatment Specifies how the network should react after the granted connection time expired. Raises TpCommonExceptions, P_INVALID_SESSION_ID 7.3.4 Interface Class IpAppMultiPartyCall Inherits from: IpInterface The Multi-Party call application interface is implemented by the client application developer and is used to handle call request responses and state reports. <<Interface>> IpAppMultiPartyCall getInfoRes (callSessionID : in TpSessionID, callInfoReport : in TpCallInfoReport) : void getInfoErr (callSessionID : in TpSessionID, errorIndication : in TpCallError) : void superviseRes (callSessionID : in TpSessionID, report : in TpCallSuperviseReport, usedTime : in TpDuration) : void superviseErr (callSessionID : in TpSessionID, errorIndication : in TpCallError) : void callEnded (callSessionID : in TpSessionID, report : in TpCallEndedReport) : void createAndRouteCallLegErr (callSessionID : in TpSessionID, callLegReference : in TpCallLegIdentifier, errorIndication : in TpCallError) : void Method getInfoRes() This asynchronous method reports time information of the finished call or call attempt as well as release cause depending on which information has been requested by getInfoReq. This information may be used e.g. for charging purposes. The call information will possibly be sent after reporting of all cases where the call or a leg of the call has been disconnected or a routing failure has been encountered. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. callInfoReport : in TpCallInfoReport Specifies the call information requested. Method getInfoErr() This asynchronous method reports that the original request was erroneous, or resulted in an error condition. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. errorIndication : in TpCallError Specifies the error which led to the original request failing. Method superviseRes() This asynchronous method reports a call supervision event to the application when it has indicated its interest in these kind of events. It is also called when the connection is terminated before the supervision event occurs. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call report : in TpCallSuperviseReport Specifies the situation which triggered the sending of the call supervision response. usedTime : in TpDuration Specifies the used time for the call supervision (in milliseconds). Method superviseErr() This asynchronous method reports a call supervision error to the application. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. errorIndication : in TpCallError Specifies the error which led to the original request failing. Method callEnded() This method indicates to the application that the call has terminated in the network. Note that the event that caused the call to end might have been received separately if the application was monitoring for it. Parameters callSessionID : in TpSessionID Specifies the call sessionID. report : in TpCallEndedReport Specifies the reason the call is terminated. Method createAndRouteCallLegErr() This asynchronous method indicates that the request to route the call leg to the destination party was unsuccessful - the call leg could not be routed to the destination party (for example, the network was unable to route the call leg, the parameters were incorrect, the request was refused, etc.). Note that the event cases that can be monitored and correspond to an unsuccessful setup of a connection (e.g. busy, no_answer) will be reported by eventReportRes() and not by this operation. Parameters callSessionID : in TpSessionID Specifies the call session ID of the call. callLegReference : in TpCallLegIdentifier Specifies the reference to the CallLeg interface that was created. errorIndication : in TpCallError Specifies the error which led to the original request failing. 7.3.5 Interface Class IpCallLeg Inherits from: IpService The call leg interface represents the logical call leg associating a call with an address. The call leg tracks its own states and allows charging summaries to be accessed. The leg represents the signalling relationship between the call and an address. An application that uses the IpCallLeg interface to set up connections has good control, e.g. by defining leg specific event request and can obtain call leg specific report and events. This interface shall be implemented by a Multi Party Call Control SCF. The routeReq(), eventReportReq(), release(), continueProcessing() and deassign() methods shall be implemented as a minimum requirement. <<Interface>> IpCallLeg routeReq (callLegSessionID : in TpSessionID, targetAddress : in TpAddress, originatingAddress : in TpAddress, appInfo : in TpCallAppInfoSet, connectionProperties : in TpCallLegConnectionProperties) : void eventReportReq (callLegSessionID : in TpSessionID, eventsRequested : in TpCallEventRequestSet) : void release (callLegSessionID : in TpSessionID, cause : in TpReleaseCause) : void getInfoReq (callLegSessionID : in TpSessionID, callLegInfoRequested : in TpCallLegInfoType) : void getCall (callLegSessionID : in TpSessionID) : TpMultiPartyCallIdentifier attachMediaReq (callLegSessionID : in TpSessionID) : void detachMediaReq (callLegSessionID : in TpSessionID) : void getCurrentDestinationAddress (callLegSessionID : in TpSessionID) : TpAddress continueProcessing (callLegSessionID : in TpSessionID) : void setChargePlan (callLegSessionID : in TpSessionID, callChargePlan : in TpCallChargePlan) : void setAdviceOfCharge (callLegSessionID : in TpSessionID, aOCInfo : in TpAoCInfo, tariffSwitch : in TpDuration) : void superviseReq (callLegSessionID : in TpSessionID, time : in TpDuration, treatment : in TpCallLegSuperviseTreatment) : void deassign (callLegSessionID : in TpSessionID) : void Method routeReq() This asynchronous method requests routing of the call leg to the remote party indicated by the targetAddress. In case the connection to the destination party is established successfully the CallLeg will be either detached or attached to the call based on the attach Mechanism values specified in the connectionProperties parameter. The extra address information such as originatingAddress is optional. If not present (i.e. the plan is set to P_ADDRESS_PLAN_NOT_PRESENT), the information provided in the corresponding addresses from the route is used, otherwise network or gateway provided addresses will be used. If the application wishes that the call leg should be represented in the network as being a redirection it should include a value for the field P_CALL_APP_ORIGINAL_DESTINATION_ADDRESS of TpCallAppInfo. This operation continues processing of the call leg. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg. targetAddress : in TpAddress Specifies the destination party to which the call leg should be routed originatingAddress : in TpAddress Specifies the address of the originating (calling) party. appInfo : in TpCallAppInfoSet Specifies application-related information pertinent to the call leg (such as alerting method, tele-service type, service identities and interaction indicators). connectionProperties : in TpCallLegConnectionProperties Specifies the properties of the connection. Raises TpCommonExceptions, P_INVALID_SESSION_ID, P_INVALID_NETWORK_STATE, P_INVALID_ADDRESS, P_UNSUPPORTED_ADDRESS_PLAN Method eventReportReq() This asynchronous method sets, clears or changes the criteria for the events that the call leg object will be set to observe. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg. eventsRequested : in TpCallEventRequestSet Specifies the event specific criteria used by the application to define the events required. Only events that meet these criteria are reported. Examples of events are "address analysed", "answer" and "release". Raises TpCommonExceptions, P_INVALID_SESSION_ID, P_INVALID_EVENT_TYPE, P_INVALID_CRITERIA Method release() This method requests the release of the call leg. If successful, the associated address (party) will be released from the call, and the call leg deleted. Note that in some cases releasing the party may lead to release of the complete call in the network. The application will be informed of this with callEnded(). This operation continues processing of the call leg. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg. cause : in TpReleaseCause Specifies the cause of the release. Raises TpCommonExceptions, P_INVALID_SESSION_ID, P_INVALID_NETWORK_STATE Method getInfoReq() This asynchronous method requests information associated with the call leg to be provided at the appropriate time (for example, to calculate charging). Note that in the call leg information must be accessible before the objects of concern are deleted. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg. callLegInfoRequested : in TpCallLegInfoType Specifies the call leg information that is requested. Raises TpCommonExceptions, P_INVALID_SESSION_ID Method getCall() This method requests the call associated with this call leg. Returns callReference: Specifies the interface and sessionID of the call associated with this call leg. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg. Returns TpMultiPartyCallIdentifier Raises TpCommonExceptions, P_INVALID_SESSION_ID Method attachMediaReq() This method requests that the call leg be attached to its call object. This will allow transmission on all associated bearer connections or media streams to and from other parties in the call. The call leg must be in the connected state for this method to complete successfully. Parameters callLegSessionID : in TpSessionID Specifies the sessionID of the call leg to attach to the call. Raises TpCommonExceptions, P_INVALID_SESSION_ID, P_INVALID_NETWORK_STATE Method detachMediaReq() This method will detach the call leg from its call, i.e., this will prevent transmission on any associated bearer connections or media streams to and from other parties in the call. The call leg must be in the connected state for this method to complete successfully. Parameters callLegSessionID : in TpSessionID Specifies the sessionID of the call leg to detach from the call. Raises TpCommonExceptions, P_INVALID_SESSION_ID, P_INVALID_NETWORK_STATE Method getCurrentDestinationAddress() Queries the current address of the destination the leg has been directed to. Returns the address of the destination point towards which the call leg has been routed.. If this method is invoked on the Originating Call Leg, exception P_INVALID_STATE will be thrown. Parameters callLegSessionID : in TpSessionID Specifies the call session ID of the call leg. Returns TpAddress Raises TpCommonExceptions, P_INVALID_SESSION_ID Method continueProcessing() This operation continues processing of the call leg. Applications can invoke this operation after call leg processing was interrupted due to detection of a notification or event the application subscribed its interest in. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg. Raises TpCommonExceptions, P_INVALID_SESSION_ID, P_INVALID_NETWORK_STATE Method setChargePlan() Set an operator specific charge plan for the call leg. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call party. callChargePlan : in TpCallChargePlan Specifies the charge plan to use. Raises TpCommonExceptions, P_INVALID_SESSION_ID Method setAdviceOfCharge() This method allows for advice of charge (AOC) information to be sent to terminals that are capable of receiving this information. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call party. aOCInfo : in TpAoCInfo Specifies two sets of Advice of Charge parameter. tariffSwitch : in TpDuration Specifies the tariff switch interval that signifies when the second set of AoC parameters becomes valid. Raises TpCommonExceptions, P_INVALID_SESSION_ID, P_INVALID_CURRENCY, P_INVALID_AMOUNT Method superviseReq() The application calls this method to supervise a call leg. The application can set a granted connection time for this call. If an application calls this function before it calls a routeReq() or a user interaction function the time measurement will start as soon as the call is answered by the B-party or the user interaction system. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call party. time : in TpDuration Specifies the granted time in milliseconds for the connection. treatment : in TpCallLegSuperviseTreatment Specifies how the network should react after the granted connection time expired. Raises TpCommonExceptions, P_INVALID_SESSION_ID Method deassign() This method requests that the relationship between the application and the call leg and associated objects be de-assigned. It leaves the call leg in progress, however, it purges the specified call leg object so that the application has no further control of call leg processing. If a call leg is de-assigned that has event reports or call leg information reports requested, then these reports will be disabled and any related information discarded. The application should not release or deassign the call leg when received a callLegEnded() or callEnded(). This operation continues processing of the call leg. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg. Raises TpCommonExceptions, P_INVALID_SESSION_ID 7.3.6 Interface Class IpAppCallLeg Inherits from: IpInterface The application call leg interface is implemented by the client application developer and is used to handle responses and errors associated with requests on the call leg in order to be able to receive leg specific information and events. <<Interface>> IpAppCallLeg eventReportRes (callLegSessionID : in TpSessionID, eventInfo : in TpCallEventInfo) : void eventReportErr (callLegSessionID : in TpSessionID, errorIndication : in TpCallError) : void attachMediaRes (callLegSessionID : in TpSessionID) : void attachMediaErr (callLegSessionID : in TpSessionID, errorIndication : in TpCallError) : void detachMediaRes (callLegSessionID : in TpSessionID) : void detachMediaErr (callLegSessionID : in TpSessionID, errorIndication : in TpCallError) : void getInfoRes (callLegSessionID : in TpSessionID, callLegInfoReport : in TpCallLegInfoReport) : void getInfoErr (callLegSessionID : in TpSessionID, errorIndication : in TpCallError) : void routeErr (callLegSessionID : in TpSessionID, errorIndication : in TpCallError) : void superviseRes (callLegSessionID : in TpSessionID, report : in TpCallSuperviseReport, usedTime : in TpDuration) : void superviseErr (callLegSessionID : in TpSessionID, errorIndication : in TpCallError) : void callLegEnded (callLegSessionID : in TpSessionID, cause : in TpReleaseCause) : void Method eventReportRes() This asynchronous method reports that an event has occurred that was requested to be reported (for example, a mid-call event, the party has requested to disconnect, etc.). Depending on the type of event received, outstanding requests for events are discarded. The exact details of these so-called disarming rules are captured in the data definition of the event type. If this method is invoked for a report with a monitor mode of P_CALL_MONITOR_MODE_INTERRUPT, then the application has control of the call leg. If the application does nothing with the call leg within a specified time period (the duration which forms a part of the service level agreement), then the connection in the network shall be released and callLegEnded() shall be invoked, giving a release cause of P_TIMER_EXPIRY. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg on which the event was detected. eventInfo : in TpCallEventInfo Specifies data associated with this event. Method eventReportErr() This asynchronous method indicates that the request to manage call leg event reports was unsuccessful, and the reason (for example, the parameters were incorrect, the request was refused, etc.). Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg. errorIndication : in TpCallError Specifies the error which led to the original request failing. Method attachMediaRes() This asynchronous method reports the attachment of a call leg to a call has succeeded. The media channels or bearer connections to this leg is now available. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg to which the information relates. Method attachMediaErr() This asynchronous method reports that the original request was erroneous, or resulted in an error condition. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg. errorIndication : in TpCallError Specifies the error which led to the original request failing. Method detachMediaRes() This asynchronous method reports the detachment of a call leg from a call has succeeded. The media channels or bearer connections to this leg is no longer available. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg to which the information relates. Method detachMediaErr() This asynchronous method reports that the original request was erroneous, or resulted in an error condition. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg. errorIndication : in TpCallError Specifies the error which led to the original request failing. Method getInfoRes() This asynchronous method reports all the necessary information requested by the application, for example to calculate charging. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg to which the information relates. callLegInfoReport : in TpCallLegInfoReport Specifies the call leg information requested. Method getInfoErr() This asynchronous method reports that the original request was erroneous, or resulted in an error condition. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg. errorIndication : in TpCallError Specifies the error which led to the original request failing. Method routeErr() This asynchronous method indicates that the request to route the call leg to the destination party was unsuccessful - the call leg could not be routed to the destination party (for example, the network was unable to route the call leg, the parameters were incorrect, the request was refused, etc.). Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg. errorIndication : in TpCallError Specifies the error which led to the original request failing. Method superviseRes() This asynchronous method reports a call leg supervision event to the application when it has indicated its interest in these kind of events. It is also called when the connection to a party is terminated before the supervision event occurs. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg report : in TpCallSuperviseReport Specifies the situation which triggered the sending of the call leg supervision response. usedTime : in TpDuration Specifies the used time for the call leg supervision (in milliseconds). Method superviseErr() Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg. errorIndication : in TpCallError Specifies the error which led to the original request failing. Method callLegEnded() This method indicates to the application that the leg has terminated in the network. The application has received all requested results (e.g., getInfoRes) related to the call leg. The call leg will be destroyed after returning from this method. Parameters callLegSessionID : in TpSessionID Specifies the call leg session ID of the call leg. cause : in TpReleaseCause Specifies the reason the connection is terminated. 7.4 MultiParty Call Control Service State Transition Diagrams 7.4.1 State Transition Diagrams for IpMultiPartyCallControlManager Figure : Application view and the Multi-Party Call Control Manager 7.4.1.1 Active State In this state a relation between the Application and the Service has been established. The state allows the application to indicate that it is interested in call related events. In case such an event occurs, the Manager will create a Call object with the appropriate number of Call Leg objects and inform the application. The application can also indicate it is no longer interested in certain call related events by calling destroyNotification(). 7.4.1.2 Interrupted State When the Manager is in the Interrupted state it is temporarily unavailable for use. Events requested cannot be forwarded to the application and methods in the API cannot successfully be executed. A number of reasons can cause this: for instance the application receives more notifications from the network than defined in the Service Agreement. Another example is that the Service has detected it receives no notifications from the network due to e.g. a link failure. 7.4.1.3 Overview of allowed methods Call Control Manager State Methods applicable Active createCall, createNotification, destroyNotification, changeNotification, getNotification, setCallLoadControl Interrupted getNotification 7.4.2 State Transition Diagrams for IpMultiPartyCall The state transition diagram shows the application view on the MultiParty Call object. When an IpMultiPartyCall is created using createCall, or when an IpMultiPartyCall is given to the application for a notification with a monitor mode of P_CALL_MONITOR_MODE_INTERRUPT, an activity timer is started. The activity timer is stopped when the application invokes a method on the IpMultiPartyCall. The action upon expiry of this activity timer is to invoke callEnded() on the IpAppMultiPartyCall with a release cause of P_TIMER_EXPIRY. In the case when no IpAppMultiPartyCall is available on which to invoke callEnded(), callAborted() shall be invoked on the IpAppMultiPartyCallControlManager as this is an abnormal termination. Figure : Application view on the MultiParty Call object 7.4.2.1 IDLE State In this state the Call object has no Call Leg object associated to it. The application can request for charging related information reports, call supervision, set the charge plan and set Advice Of Charge indicators. When the first Call Leg object is requested to be created a state transition is made to the Active state. 7.4.2.2 ACTIVE State In this state the Call object has one or more Call Leg objects associated to it. The application is allowed to create additional Call Leg objects. Furthermore, the application can request for call supervision. The Application can request charging related information reports, set the charge plan and set Advice Of Charge indicators in this state prior to call establishment. 7.4.2.3 RELEASED State In this state the last Call leg object has released or the call itself was released. While the call is in this state, the requested call information will be collected and returned through getInfoRes() and / or superviseRes(). As soon as all information is returned, the application will be informed that the call has ended and Call object transition to the end state. 7.4.2.4 Overview of allowed methods Methods applicable Call Control Call State Call Control Manager State getCallLegs, Idle, Active, Released - createCallLeg, createAndRouteCallLegReq, setAdviceOfCharge, superviseReq, Idle, Active Active release Active Active deassignCall Idle, Active - setChargePlan, getInfoReq Idle, Active Active 7.4.3 State Transition Diagrams for IpCallLeg The IpCallLeg State Transition Diagram is divided in two State Transition Diagrams, one for the originating call leg and one for the terminating call leg. Call Leg State Model General Objectives: 1) Events in backwards direction (upstream), coming from terminating leg, are not visible in originating leg model. 2) Events in forwards direction (downstream), coming from originating leg, are not visible in terminating leg model. 3) States are as seen from the application: if there is no change in the method an application is permitted to apply on the IpCallLeg object, then there is no state change. Therefore receipt of e.g. answer or alerting events on terminating leg do not change state. NOTE 2 4) The application is to send a request to continue processing (using an appropriate method like continueProcessing) for each leg and event reported in monitor mode ‘interrupt’. 5) In case on a leg more than one network event (for example mid-call event ‘service_code’) is to be reported to the application at quasi the same time, then the events are to be reported one by one to the application in the order received from the network. When for a leg an event is reported in interrupt mode, a next pending event is not to be reported to the application until a request to resume call processing for the current reported event has been received on the leg. NOTE1: Call processing is suspended if for a leg a network event is met, which was requested to be monitored in the P_CALL_MONITOR_MODE_INTERRUPT. NOTE2: Even though there in the Originating Call Leg STD is no change in the methods the application is permitted to apply to the IpCallLeg object for the states Analysing and Active, separate states are maintained. The states may therefore from an application viewpoint appear as just one state that may be have substates like Analysing and Active. The digit collection task in state Analysing state may be viewed as a specialised task that may not at all be applicable in some networks and therefore here described as being a state on its own. 7.4.3.1 Originating Call Leg Figure : Originating Leg 7.4.3.1.1 Initiating State Entry events: • Sending of a reportNotification() method by the IpMultiPartyCallControlManager for an “Originating_Call_Attempt” initial notification criterion. - Sending of a reportNotification() method by the IpMultiPartyCallControlManager for an “Originating_Call_Attempt_Authorised” initial notification criterion. Functions: In this state the network checks the authority/ability of the party to place the connection to the remote (destination) party with the given properties, e.g. based on the originating party’s identity and service profile. The setup of the connection for the party has been initiated and the application activity timer is being provided. The figure below shows the order in which network events may be detected in the Initiating state and depending on the monitor mode be reported to the application. Note 1: Event oCA only applicable as an initial notification . Note 2: The release event (oREL) can occur in any state resulting in a transition to Releasing state. Abbreviations used for the events: oCA: originating Call Attempt; oCAA originating Call Attempt Authorized; AC: Address Collected, oREL originating RELease. Figure : Application view on event reporting order in Initiating State In this state the following functions are applicable: - The detection of a “Originating_Call_Attempt” initial notification criterion. - The detection of an “Originating_Call_Attempt_Authorised” initial notification criterion as a result that the call attempt authorisation is successful. - The report of the “Originating_Call_Attempt_Authorised” event indication whereby the following functions are performed: i) When the P_CALL_MONITOR_MODE_INTERRUPT is requested for the call leg event P_CALL_EVENT_CALL_ATTEMPT_AUTHORISED then the event is reported and call leg processing is suspended. ii) When the P_CALL_MONITOR_MODE_NOTIFY is requested for the call leg event P_CALL_EVENT_CALL_ATTEMPT_AUTHORISED then the event is notified and call leg processing continues. iii) When the P_CALL_MONITOR_MODE_DO_NOT_MONITOR is requested for the call leg event P_CALL_EVENT_CALL_ATTEMPT_AUTHORISED then no monitoring is performed. - The receipt of destination address information, i.e. initial information package/dialling string as received from calling party. - Resumption of suspended call leg processing occurs on receipt of a continueProcessing() method. Exit events: - Availability of destination address information, i.e. the initial information package/dialling string received from the calling party. - Application activity timer expiry indicating that no requests from the application have been received during a certain period. - Receipt of a deassign() method. • Receipt of a release() method. - Detection of a “originating release” indication as a result of a premature disconnect from the calling party. 7.4.3.1.2 Analysing State Entry events: - Availability of an “Address_Collected” event indication as a result of the receipt of the (complete) initial information package/dialling string from the calling party. - Sending of a reportNotification() method by the IpMultiPartyCallControlManager for an “Address_Collected” initial notification criterion. Functions: In this state the destination address provided by the calling party is collected and analysed. The received information (dialled address string from the calling party) is being collected and examined in accordance to the dialling plan in order to determine end of address information (digit) collection. Additional address digits can be collected. Upon completion of address collection the address is analysed. The address analysis is being made according to the dialling plan in force to determine the routing address of the call leg connection and the connection type (e.g. local, transit, gateway). The request (with eventReportReq method) to collect a variable number of more address digits and report them to the application (within eventReportRes method)) is handled within this state. The collection of more digits as requested and the reporting of received digits to the application (when the digit collect criteria is met) is done in this state. This action is recursive, e.g. the application could ask for 3 digits to be collected and when report request can be done repeatedly, e.g. the application may for example request first for 3 digits to be collected and when reported request further digits. The figure below shows the order in which network events may be detected in the Analysing state and depending on the monitor mode be reported to the application. Note 1: The release event (oREL) can occur in any state resulting in a transition to Releasing state. Abbreviations used for the events: oCAA: originating Call Attempt Authorized; AC: Address Collected; AA: Address Analysed; oREL: originating RELease. Figure : Application view on event reporting order in Analysing State In this state the following functions are applicable: - The detection of a “Address_Collected“ initial notification criterion. - On receipt of the “Address_Collected” indication the following functions are performed: i) When the P_CALL_MONITOR_MODE_INTERRUPT is requested for the call leg event P_CALL_EVENT_ADDRESS_COLLECTED then the event is reported and call leg processing is suspended. ii) When the P_CALL_MONITOR_MODE_NOTIFY is requested for the call leg event P_CALL_EVENT_ADDRESS_COLLECTED then the event is notified and call leg processing continues. iii) When the P_CALL_MONITOR_MODE_DO_NOT_MONITOR is requested for the call leg event P_CALL_EVENT_ADDRESS_COLLECTED then no monitoring is performed. - Receipt of a eventReportReq() method defining the criteria for the events the call leg object is to observe. - Resumption of suspended call leg processing occurs on receipt of a continueProcessing() or a routeReq() method. Exit events: - Detection of an “Address_Analysed” indication as a result of the availability of the routing address and nature of address. - Receipt of a deassign() method. - Receipt of a release() method. - Detection of a “originating release” indication as a result of a premature disconnect from the calling party. 7.4.3.1.3 Active State Entry events: - Receipt of an “Address_Analysed” indication as a result of the availability of the routing address and nature of address. - Sending of a reportNotification() method by the IpMultiPartyCallControlManager for an “Address_Analysed initial indication criterion. Functions: In this state the call leg connection to the calling party exists and originating mid call events can be received. The figure below shows the order in which network events may be detected in the Active state and depending on the monitor mode be reported to the application. Note 1: Only the detected service code or the range to which the service code belongs is disarmed as the service code is reported to the application Note 2: The release event (oREL) can occur in any state resulting in a transition to Releasing state. Abbreviations used for the events: AC: Address Collected; AA: Address Analysed; oSC: originating Service Code; oREL: originating RELease. Figure : Application view on event reporting order Active State In this state the following functions are applicable: - The detection of a Address_Analysed initial indication criterion. - On receipt of the “Address_Analysed” indication the following functions are performed: i) When the P_CALL_MONITOR_MODE_INTERRUPT is requested for the call leg event P_CALL_EVENT_ADDRESS_ANALYSED then the event is reported and call leg processing is suspended. ii) When the P_CALL_MONITOR_MODE_NOTIFY is requested for the call leg event P_CALL_EVENT_ADDRESS_ANALYSED then the event is notified and call leg processing continues. iii) When the P_CALL_MONITOR_MODE_DO_NOT_MONITOR is requested for the call leg event P_CALL_EVENT_ADDRESS_ANALYSED then no monitoring is performed. - Resumption of suspended call leg processing occurs on receipt of a continueProcessing() method. - In this state the routing information is interpreted, the authority of the calling party to establish this connection is verified and the call leg connection is set up to the remote party. - In this state a connection to the call party is established. - Detection of a “terminating release” indication (not visible to the application) from remote party caused by a network release event propagated from a terminating party, possibly resulting in an “originating release” indication and causing the originating call leg STD to transit to Releasing state: - Detection of a disconnect from the calling party. - Receipt of a deassign() method. - Receipt of a release() method. - On receipt of the “originating_service code” indication the following functions are performed: i) When the P_CALL_MONITOR_MODE_INTERRUPT is requested for the call leg event P_CALL_EVENT_ORIGINATING_SERVICE_CODE then the event is reported and call leg processing is suspended. ii) When the P_CALL_MONITOR_MODE_NOTIFY is requested for the call leg event P_CALL_EVENT_ORIGINATING_SERVICE_CODED then the event is notified and call leg processing continues.. iii) When the P_CALL_MONITOR_MODE_DO_NOT_MONITOR is requested for the call leg event P_CALL_EVENT_ORIGINATING_SERVICE_CODE then no monitoring is performed. - Resumption of suspended call leg processing occurs on receipt of a continueProcessing() method. Exit events: - Detection of an “originating release” indication as a result of a disconnect from the calling party and a “terminating release” indication as a result of a disconnect from called party. - Receipt of a deassign() method. - Receipt of a release() method from the application. 7.4.3.1.4 Releasing State Entry events: - Detection of an “Originating_Release” indication as a result of the network release initiated by calling party or called party. - Reception of the release() method from the application. - A transition due to fault detection to this state is made when the Call leg object is in a state and no requests from the application have been received during a certain time period (timer expiry). Functions: In this state the connection to the call party is released as requested by the network or by the application and the reports are processed and sent to the application if requested. When the Releasing state is entered the order of actions to be performed is as follows: i) the network release event handling is performed. ii) the possible call leg information requested with getInfoReq() and/ or superviseReq() is collected and send to the application. iii) the callLegEnded() method is sent to the application to inform that the call leg object is destroyed. In this state the following functions are applicable: • The detection of a “originating_release” initial indication criterion.. - On receipt of the “originating_release” indication the following functions are performed: - The network release event handling is performed as follows: i) When the P_CALL_MONITOR_MODE_INTERRUPT is requested for the call leg event P_CALL_EVENT_RELEASE then the event is reported and call leg processing is suspended. ii) When the P_CALL_MONITOR_MODE_NOTIFY is requested for the call leg event P_CALL_EVENT_RELEASE then the event is notified and call leg processing continues. iii) When the P_CALL_MONITOR_MODE_DO_NOT_MONITOR is requested for the call leg event P_CALL_EVENT_RELEASE then no monitoring is performed. • Resumption of suspended call leg processing occurs on receipt of a continueProcessing() method. • The possible call leg information requested with the getInfoReq() and/or superviseReq() is collected and sent to the application with respectively the getInfoRes() and/or superviseRes() methods. • The callLegEnded() method is sent to the application after all information has been sent. In case that the application has not requested additional call leg related information the call leg object is destroyed immediately and additionally the application will also be informed that the connection has ended • In case of abnormal termination due to a fault and the application requested for call leg related information previously, the application will be informed that this information is not available and additionally the application is informed that the call leg object is destroyed (callLegEnded). Note: the call in the network may continue or be released, depending e.g. on the call state. - In case the release() method is received in Releasing state it will be discarded. The request from the application to release the leg is ignored in this case because release of the leg is already ongoing. Exit events: - In case that the application has not requested additional call leg related information the call leg object is destroyed immediately and additionally the application is informed that the call leg connection has ended, by sending the callLegEnded() method. - After the sending of the last call leg information to the application the Call Leg object is destroyed and additionally the application is informed that the call leg connection has ended, by sending the callLegEnded() method. 7.4.3.1.5 Overview of allowed methods, Originating Call Leg STD State Methods allowed Initiating attachMediaReq (as a request), detachMediaReq, (as a request) getCall , continueProcessing, release (call leg), deassign eventReportReq, getInfoReq, setChargePlan, setAdviceOfCharge, superviseReq Analysing attachMediaReq (as a request), detachMediaReq, (as a request) getCall , continueProcessing, release (call leg), deassign eventReportReq, getInfoReq, setChargePlan, setAdviceOfCharge, superviseReq Active attachMediaReq, detachMediaReq, getCall, continueProcessing, release deassign eventReportReq, getInfoReq, setChargePlan, setAdviceOfCharge, superviseReq Releasing getCall , continueProcessing, release deassign 7.4.3.2 Terminating Call Leg Figure : Terminating Leg 7.4.3.2.1 Idle (terminating) State Entry events: - Receipt of a createCallLeg() method to start an application initiated call leg connection. Functions: In this state the call leg object is created and the interface connection is idled. The application activity timer is being provided. In this state the following functions are applicable: - Invoking routeReq will result in a request to actually route the call leg object. - Resumption of call leg processing occurs on receipt of a routeReq() method. Exit events: - Receipt of a routeReq() method from the application. - Application activity timer expiry indicating that no requests from the application have been received during a certain period to continue processing. - Receipt of a deassign() method. - Receipt of a release() method. - Detection of a network release event being an “originating release” indication as a result of a premature disconnect from the calling party. 7.4.3.2.2 Active (terminating) State Entry events: • Receipt of an routeReq will result in actually routing the call leg object. • Receipt of a createAndRouteCallLegReq() method to start an application initiated call leg connection. • Sending of a reportNotification() method by the IpMultiPartyCallControlManager for the following trigger criteria: “Terminating_Call_Attempt”, “Terminating_Call_Attempt_Authorised”, “Alerting”, “Answer”, “Terminating service code”, “Redirected” and “Queued”. Functions: In this state the routing information is interpreted, the authority of the called party to establish this connection is verified for the call leg connection. In this state a connection to the call party is established whereby events from the network may indicate to the application when the party is alerted (acknowledge connection setup) and when the party answer (confirmation of connection setup). Furthermore, in this state terminating service code events can be received. The figure below shows the order in which network events may be detected in the Active state and depending on the monitor mode be reported to the application. Note 1: Event tCA applicable as initial notification Note 2: Only the detected service code or the range to which the service code belongs is disarmed as the service code is reported to the application Note 3: The release event (tREL) can occur in any state resulting in a transition to Releasing state. Abbreviations used for the events: tCA: Terminating Call Attempt; tCAA: terminating Call Attempt Authorized; AL: Alerting; ANS: Answer; tREL: terminating RELease; Q: Queued; RD: ReDirected; tSC: terminating Service Code. Figure : Application view on event reporting order in Active State In this state the following functions are applicable: - The detection and report of the “Terminating_Call_Attempt_Authorised” event indication whereby the following functions are performed: i) When the P_CALL_MONITOR_MODE_INTERRUPT is requested for the call leg event P_CALL_EVENT_TERMINATING_CALL_ATTEMPT_AUTHORISED then the event is reported and call leg processing is suspended. ii) When the P_CALL_MONITOR_MODE_NOTIFY is requested for the call leg event P_CALL_EVENT_TERMINATING_CALL_ATTEMPT_AUTHORISED then the event is notified and call leg processing continues. iii) When the P_CALL_MONITOR_MODE_DO_NOT_MONITOR is requested for the call leg event P_CALL_EVENT_CALL_TERMINATING_ATTEMPT_AUTHORISED then no monitoring is performed. • Detection of an “Queued” indication as a result of the terminating call being queued. - On receipt of the “Queued” indication the following functions are performed: i) When the P_CALL_MONITOR_MODE_INTERRUPT is requested for the call leg event P_CALL_EVENT_QUEUED then the event is reported and call leg processing is suspended. ii) When the P_CALL_MONITOR_MODE_NOTIFY is requested for the call leg event P_CALL_EVENT_QUEUED then the event is notified and call leg processing continues. iii) When the P_CALL_MONITOR_MODE_DO_NOT_MONITOR is requested for the call leg event P_CALL_EVENT_QUEUED then no monitoring is performed. - On receipt of the “Alerting” indication the following functions are performed: i) When the P_CALL_MONITOR_MODE_INTERRUPT is requested for the call leg event P_CALL_EVENT_ALERTING then the event is reported and call leg processing is suspended. ii) When the P_CALL_MONITOR_MODE_NOTIFY is requested for the call leg event P_CALL_EVENT_ALERTING then the event is notified and call leg processing continues. iii) When the P_CALL_MONITOR_MODE_DO_NOT_MONITOR is requested for the call leg event P_CALL_EVENT_ALERTING then no monitoring is performed. • Detection of an “Answer” indication as a result of the remote party being connected (answered). - On receipt of the “Answer” indication the following functions are performed: i) When the P_CALL_MONITOR_MODE_INTERRUPT is requested for the call leg event P_CALL_EVENT_ANSWER then the event is reported and call leg processing is suspended. ii) When the P_CALL_MONITOR_MODE_NOTIFY is requested for the call leg event P_CALL_EVENT_ANSWER then the event is notified and call leg processing continues. iii) When the P_CALL_MONITOR_MODE_DO_NOT_MONITOR is requested for the call leg event P_CALL_EVENT_ANSWER then no monitoring is performed. - The detection of a “service_code” trigger criterion suspends call leg processing. - On receipt of the “service code” indication the following functions are performed: i) When the P_CALL_MONITOR_MODE_INTERRUPT is requested for the call leg event P_CALL_EVENT_TERMINATING_SERVICE_CODE then the event is reported and call leg processing is suspended. ii) When the P_CALL_MONITOR_MODE_NOTIFY is requested for the call leg event P_CALL_EVENT_TERMINATING_SERVICE_CODE then this is not a valid event (that event is not notified) and call leg processing continues. iii) When the P_CALL_MONITOR_MODE_DO_NOT_MONITOR is requested for the call leg event P_CALL_EVENT_TERMINATING_SERVICE_CODE then no monitoring is performed. - On receipt of the “redirected” indication the following functions are performed: i) When the P_CALL_MONITOR_MODE_INTERRUPT is requested for the call leg event P_CALL_EVENT_REDIRECTED then the event is reported and call leg processing is suspended. ii) When the P_CALL_MONITOR_MODE_NOTIFY is requested for the call leg event P_CALL_EVENT_REDIRECTED then the event is notified and call leg processing continues. iii) When the P_CALL_MONITOR_MODE_DO_NOT_MONITOR is requested for the call leg event P_CALL_EVENT_REDIRECTED then no monitoring is performed. - Resumption of call leg processing occurs on receipt of a continueProcessing() method. Exit events: - Detection of a network release event being an “terminating release” indication as a result of the following events: i) Unable to select a route or indication from the remote party of the call leg connection cannot be presented (this is the network determined busy condition) ii) Occurrence of an authorisation failure when the authority to place the call leg connection was denied (e.g. business group restriction mismatch). iii) Detection of a route busy condition received from the remote call leg connection portion. iv) Detection of a no-answer condition received from the remote call leg connection portion. v) Detection that the remote party was not reachable. - Detection of a network release event being an “originating release” indication as a result of the following events: vi) Detection of a premature disconnect from the calling party. - Receipt of a deassign() method. - Receipt of a release() method from the application. - Detection of a network release event being an “originating release” indication as a result of a disconnect from the calling party or a “terminating release” indication as a result of a disconnect from the called party. 7.4.3.2.3 Releasing (terminating) State Entry events: - Detection of a network release event being an “originating release” indication as a result of the network release initiated by calling party or a “terminating release” indication as a result of the network release initiated by called party.. - Sending of the release() method by the application. • A transition due to fault detection to this state is made when the Call leg object awaits a request from the application and this is not received within a certain time period. - Detection of a network event being a “terminating release” indication as a result of the following events: i) Unable to select a route or indication from the remote party of the call leg connection cannot be presented (this is the network determined busy condition) ii) Occurrence of an authorisation failure when the authority to place the call leg connection was denied (e.g. business group restriction mismatch). iii) Detection of a route busy condition received from the remote call leg connection portion. iv) Detection of a no-answer condition received from the remote call leg connection portion. v) Detection that the remote party was not reachable. - Detection of a network release event being an “originating release” indication as a result of the following events: vi) Detection of a premature disconnect from the calling party. Functions: In this state the connection to the call party is released as requested by the network or by the application and the reports are processed and sent to the application if requested . When the Releasing state is entered the order of actions to be performed is as follows: i) the release event handling is performed. ii) the possible call leg information requested with getInfoReq() and/ or superviseReq() is collected and send to the application. iii) the callLegEnded() method is sent to the application to inform that the call leg object is destroyed. Where the entry to this state is caused by the application, for example because the application has requested the leg to be released or deassigned or a fault (e.g. timer expiry, no response from application) has been detected, then i) is not applicable. In the fault case for action ii) error report methods are sent to the application for any possible requested reports. In this state the following functions are applicable: • The detection of a “Terminating Release” trigger criterion. - On receipt of the network release event being a “Terminating Release” indication the following functions are performed: - The network release event handling is performed as follows: i) When the P_CALL_MONITOR_MODE_INTERRUPT is requested for the call leg event P_CALL_EVENT_TERMINATING_RELEASE then the event is reported and call leg processing is suspended. ii) When the P_CALL_MONITOR_MODE_NOTIFY is requested for the call leg event P_CALL_EVENT_TERMINATING_RELEASE then the event is notified and call leg processing continues. iii) When the P_CALL_MONITOR_MODE_DO_NOT_MONITOR is requested for the call leg event P_CALL_EVENT_TERMINATING_RELEASE then no monitoring is performed. • Resumption of suspended call leg processing occurs on receipt of a continueProcessing() method. • The possible call leg information requested with the getInfoReq() and/or superviseReq() is collected and sent to the application with respectively the getInfoRes() and/or superviseRes() methods. • The callLegEnded() method is sent to the application after all information has been sent. In case that the application has not requested additional call leg related information the call leg object is destroyed immediately and additionally the application will also be informed that the connection has ended • In case of abnormal termination due to a fault and the application requested for call leg related information previously, the application will be informed that this information is not available and additionally the application is informed that the call leg object is destroyed (callLegEnded). Note: the call in the network may continue or be released, depending e.g. on the call state. • In case the release() method is received in Releasing state it will be discarded. The request from the application to release the leg is ignored in this case because release of the leg is already ongoing. Exit events: - In case that the application has not requested additional call leg related information the call leg object is destroyed immediately and additionally the application is informed that the call leg connection has ended, by sending the callLegEnded() method. - After the sending of the last call leg information to the application the Call Leg object is destroyed and additionally the application is informed that the call leg connection has ended, by sending the callLegEnded() method. 7.4.3.2.4 Overview of allowed methods and trigger events, Terminating Call Leg STD State Methods allowed Idle routeReq, getCall , getCurrentDestinationAddress, release, deassign eventReportReq, getInfoReq, setChargePlan, setAdviceOfCharge, superviseReq Active attachMediaReq detachMediaReq getCall , getCurrentDestinationAddress, continueProcessing, release, deassign eventReportReq, getInfoReq, setChargePlan, setAdviceOfCharge, superviseReq Releasing getCall , getCurrentDestinationAddress, continueProcessing, release, deassign 7.5 Multi-Party Call Control Service Properties 7.5.1 List of Service Properties The following table lists properties relevant for the MPCC API. These properties are additional to the properties of the GCC, from which the MPCC is an extension. Property Type Description P_MAX_CALLLEGS_PER_CALL INTEGER_SET Indicates how many parties can be in one call. P_UI_CALLLEG_BASED BOOLEAN_SET Value = TRUE : User interaction can be performed on leg level and a reference to a CallLeg object can be used in the IpUIManager.createUICall() operation. Value = FALSE : No user interaction on leg level is supported. P_ROUTING_WITH_CALLLEG_OPERATIONS BOOLEAN_SET Value = TRUE : the atomic operations for routing a CallLeg are supported {IpMultiPartyCall.createCallLeg(), IpCallLeg.eventReportReq(), IpCallLeg.routeReq(), IpCallLeg.attachMediaReq()} Value = FALSE : the convenience function has to be used for routing a CallLeg. P_MEDIA_ATTACH_EXPLICIT BOOLEAN_SET Value = TRUE : the CallLeg shall be explicitly attached to a Call. Value = FALSE : the CallLeg is automatically attached to a Call, no IpCallLeg.attachMediaReq() is needed when a party answers. 7.5.2 Service Property values for the CAMEL Service Environment. Implementations of the MultiParty Call Control API relying on the CSE of CAMEL phase 3 shall have the Service Properties outlined above set to the indicated values : P_OPERATION_SET = { “IpMultiPartyCallControlManager.createNotification”, “IpMultiPartyCallControlManager.destroyNotification”, “IpMultiPartyCallControlManager.changeNotification”, “IpMultiPartyCallControlManager.getNotification”, “IpMultiPartyCallControlManager.setCallLoadControl” “IpMultiPartyCall.getCallLegs”, “IpMultiPartyCall.createCallLeg”, “IpMultiPartyCall.createAndRouteCallLegReq”, “IpMultiPartyCall.release”, “IpMultiPartyCall.deassignCall”, “IpMultiPartyCall.getInfoReq”, “IpMultiPartyCall.setChargePlan”, “IpMultiPartyCall.setAdviceOfCharge”, “IpMultiPartyCall.superviseReq”, “IpCallLeg.routeReq”, “IpCallLeg.eventReportReq”, “IpCallLeg.release”, “IpCallLeg.getInfoReq”, “IpCallLeg.getCall”, “IpCallLeg.continueProcessing” } P_TRIGGERING_EVENT_TYPES = { P_CALL_EVENT_ADDRESS_COLLECTED, P_CALL_EVENT_ADDRESS_ANALYSED, P_CALL_EVENT_ORIGINATING_RELEASE, P_CALL_EVENT_TERMINATING_CALL_ATTEMPT_AUTHORISED, P_CALL_EVENT_TERMINATING_RELEASE } Note: P_CALL_EVENT_ORIGINATING_RELEASE only for the routing failure case, TpReleaseCause = P_ROUTING_FAILURE P_DYNAMIC_EVENT_TYPES = { P_CALL_EVENT_ANSWER, P_CALL_EVENT_ORIGINATING_RELEASE, P_CALL_EVENT_TERMINATING_RELEASE } P_ADDRESS_PLAN = { P_ADDRESS_PLAN_E164 } P_UI_CALL_BASED = { TRUE } P_UI_AT_ALL_STAGES = { FALSE } P_MEDIA_TYPE = { P_AUDIO } P_MAX_CALLLEGS_PER_CALL = { 0, 2 } P_UI_CALLLEG_BASED = { FALSE } P_MEDIA_ATTACH_EXPLICIT = { FALSE } 7.6 Multi-Party Call Control Data Definitions This clause provides the MPCC data definitions necessary to support the API specification. The general format of a data definition specification is described below. • Data Type This shows the name of the data type. • Description This describes the data type. • Tabular Specification This specifies the data types and values of the data type. • Example If relevant, an example is shown to illustrate the data type. All data types referenced but not defined in this clause are either in the common call control data definitions clause of the present document (clause 8) or in the common data definitions which may be found in 3GPP TS 29.198-2. 7.6.1 Event Notification Data Definitions No specific event notification data defined. 7.6.2 Multi-Party Call Control Data Definitions 7.6.2.1 IpCallLeg Defines the address of an IpCallLeg Interface. 7.6.2.2 IpCallLegRef Defines a Reference to type IpCallLeg. 7.6.2.3 IpAppCallLeg Defines the address of an IpAppCallLeg Interface. 7.6.2.4 IpAppCallLegRef Defines a Reference to type IpAppCallLeg. 7.6.2.5 IpMultiPartyCall Defines the address of an IpMultiPartyCall Interface. 7.6.2.6 IpMultiPartyCallRef Defines a Reference to type IpMultiPartyCall. 7.6.2.7 IpAppMultiPartyCall Defines the address of an IpAppMultiPartyCall Interface. 7.6.2.8 IpAppMultiPartyCallRef Defines a Reference to type IpAppMultiPartyCall. 7.6.2.9 IpMultiPartyCallControlManager Defines the address of an IpMultiPartyCallControlManager Interface. 7.6.2.10 IpMultiPartyCallControlManagerRef Defines a Reference to type IpMultiPartyCallControlManager. 7.6.2.11 IpAppMultiPartyCallControlManager Defines the address of an IpAppMultiPartyCallControlManager Interface. 7.6.2.12 IpAppMultiPartyCallControlManagerRef Defines a Reference to type IpAppMultiPartyCallControlManager.. 7.6.2.13 TpAppCallLegRefSet Defines a Numbered Set of Data Elements of IpAppCallLegRef. 7.6.2.14 TpMultiPartyCallIdentifier Defines the Sequence of Data Elements that unambiguously specify the Call object Sequence Element Name Sequence Element Type Sequence Element Description CallReference IpMultiPartyCallRef This element specifies the interface reference for the Multi-party call object. CallSessionID TpSessionID This element specifies the call session ID. 7.6.2.15 TpAppMultiPartyCallBack Defines the Tagged Choice of Data Elements that references the application callback interfaces Tag Element Type TpAppMultiPartyCallBackRefType Tag Element Value Choice Element Type Choice Element Name P_APP_CALLBACK_UNDEFINED NULL Undefined P_APP_MULTIPARTY_CALL_CALLBACK IpAppMultiPartyCallRef AppMultiPartyCall P_APP_CALL_LEG_CALLBACK IpAppCallLegRef AppCallLeg P_APP_CALL_AND_CALL_LEG_CALLBACK TpAppCallLegCallBack AppMultiPartyCallAndCallLeg 7.6.2.16 TpAppMultiPartyCallBackRefType Defines the type application call back interface. Name Value Description P_APP_CALLBACK_UNDEFINED 0 Application Call back interface undefined P_APP_MULTIPARTY_CALL_CALLBACK 1 Application Multi-Party Call interface referenced P_APP_CALL_LEG_CALLBACK 2 Application CallLeg interface referenced P_APP_CALL_AND_CALL_LEG_CALLBACK 3 Application Multi-Party Call and CallLeg interface referenced 7.6.2.17 TpAppCallLegCallBack Defines the Sequence of Data Elements that references a call and a call leg application interface. Sequence Element Name Sequence Element Type AppMultiPartyCall IpAppMultiPartyCallRef AppCallLegSet TpAppCallLegRefSet Specifies the set of all call leg call back references. First in the set is the reference to the call back of the originating callLeg. In case there is a call back to a destination call leg this will be second in the set. 7.6.2.18 TpMultiPartyCallIdentifierSet Defines a Numbered Set of Data Elements of TpMultiPartyCallIdentifier. 7.6.2.19 TpCallAppInfo Defines the Tagged Choice of Data Elements that specify application-related call information. Tag Element Type TpCallAppInfoType Tag Element Value Choice Element Type Choice Element Name P_CALL_APP_ALERTING_MECHANISM TpCallAlertingMechanism CallAppAlertingMechanism P_CALL_APP_NETWORK_ACCESS_TYPE TpCallNetworkAccessType CallAppNetworkAccessType P_CALL_APP_TELE_SERVICE TpCallTeleService CallAppTeleService P_CALL_APP_BEARER_SERVICE TpCallBearerService CallAppBearerService P_CALL_APP_PARTY_CATEGORY TpCallPartyCategory CallAppPartyCategory P_CALL_APP_PRESENTATION_ADDRESS TpAddress CallAppPresentationAddress P_CALL_APP_GENERIC_INFO TpString CallAppGenericInfo P_CALL_APP_ADDITIONAL_ADDRESS TpAddress CallAppAdditionalAddress P_CALL_APP_ORIGINAL_DESTINATION_ADDRESS TpAddress CallAppOriginalDestinationAddress P_CALL_APP_REDIRECTING_ADDRESS TpAddress CallAppRedirectingAddress 7.6.2.20 TpCallAppInfoType Defines the type of call application-related specific information. Name Value Description P_CALL_APP_UNDEFINED 0 Undefined P_CALL_APP_ALERTING_MECHANISM 1 The alerting mechanism or pattern to use P_CALL_APP_NETWORK_ACCESS_TYPE 2 The network access type (e.g. ISDN) P_CALL_APP_TELE_SERVICE 3 Indicates the tele-service (e.g. telephony) P_CALL_APP_BEARER_SERVICE 4 Indicates the bearer service (e.g. 64 kbit/s unrestricted data). P_CALL_APP_PARTY_CATEGORY 5 The category of the calling party P_CALL_APP_PRESENTATION_ADDRESS 6 The address to be presented to other call parties P_CALL_APP_GENERIC_INFO 7 Carries unspecified service-service information P_CALL_APP_ADDITIONAL_ADDRESS 8 Indicates an additional address P_CALL_APP_ORIGINAL_DESTINATION_ADDRESS 9 Contains the original address specified by the originating user when launching the call. P_CALL_APP_REDIRECTING_ADDRESS 10 Contains the address of the user from which the call is diverting. 7.6.2.21 TpCallAppInfoSet Defines a Numbered Set of Data Elements of TpCallAppInfo. 7.6.2.22 TpCallEventRequest Defines the Sequence of Data Elements that specify the criteria relating to call report requests. Sequence Element Name Sequence Element Type CallEventType TpCallEventType AdditionalCallEventCriteria TpAdditionalCallEventCriteria CallMonitorMode TpCallMonitorMode 7.6.2.23 TpCallEventRequestSet Defines a Numbered Set of Data Elements of TpCallEventRequest. 7.6.2.24 TpCallEventType Defines a specific call event report type. Name Value Description P_CALL_EVENT_UNDEFINED 0 Undefined P_CALL_EVENT_ORIGINATING_CALL_ATTEMPT 1 An originating call attempt takes place (e.g. Off-hook event). P_CALL_EVENT_ORIGINATING_CALL_ATTEMPT_AUTHORISED 2 An originating call attempt is authorised P_CALL_EVENT_ADDRESS_COLLECTED 3 The destination address has been collected. P_CALL_EVENT_ADDRESS_ANALYSED 4 The destination address has been analysed. P_CALL_EVENT_ORIGINATING_SERVICE_CODE 5 Mid-call originating service code received. P_CALL_EVENT_ORIGINATING_RELEASE 6 A originating call/call leg is released P_CALL_EVENT_TERMINATING_CALL_ATTEMPT 7 A terminating call attempt takes place P_CALL_EVENT_TERMINATING_CALL_ATTEMPT_AUTHORISED 8 A terminating call is authorized P_CALL_EVENT_ALERTING 9 Call is alerting at the call party. P_CALL_EVENT_ANSWER 10 Call answered at address. P_CALL_EVENT_TERMINATING_RELEASE 11 A terminating call leg has been released or the call could not be routed. P_CALL_EVENT_REDIRECTED 12 Call redirected to new address: an indication from the network that the call has been redirected to a new address (no events disarmed as a result of this). P_CALL_EVENT_TERMINATING_SERVICE_CODE 13 Mid call terminating service code received. P_CALL_EVENT_QUEUED 14 The Call Event has been queued. (no events are disarmed as a result of this) EVENT HANDLING RULES: The following general event handling rules apply to dynamically armed events: When requesting events for one leg; • When the monitor mode is set to P_CALL_MONITOR_MODE_DO_NOT_MONITOR all events armed for that eventtype are disarmed. The additionalEventCriteria are not taken into account. • When requesting two events for the same event type with different criteria and/or different monitor mode the last used criteria and monitor mode apply. • Events that are not applicable to a leg are refused with exception P_INVALID_EVENT_TYPE. The same exception is used when criteria are used that are not applicable to the leg, E.g., requesting P_CALL_EVENT_TERMINATING_SERVICE_CODE on an originating leg is refused with exception P_INVALID_CRITERIA. When P_CALL_EVENT_ORIGINATING_RELEASE is requested with P_BUSY in the criteria the request is refused with the same exception. When receiving events: • If an armed event is met, then it is disarmed, unless explicit stated that it will not to be disarmed. • If an event is met that causes the release of the related leg, then all events related to that leg are disarmed . • When an event is met on a call leg irrespective of the event monitor mode, then only events belonging to that call leg may become disarmed (see table below) . • If a call is released, then all events related to that call are disarmed. NOTE 1: Event disarmed means monitor mode is set to DO_NOT_MONITOR. and event armed means monitor mode is set to INTERRUPT or NOTIFY.. The table below defines the disarming rules for dynamic events. In case such an event occurs on a call leg the table shows which events are disarmed (are not monitored anymore) on that call leg and should be re-armed by eventReportReq() in case the application is still interested in these events. Event Occurred Events Disarmed P_CALL_EVENT_UNDEFINED Not Applicable P_CALL_EVENT_ORIGINATING_CALL_ATTEMPT Not applicable, can only be armed as trigger P_CALL_EVENT_ORIGINATING_CALL_ATTEMPT_AUTHORISED P_CALL_EVENT_ORIGINATING_CALL_ATTEMPT_AUTHORISED P_CALL_EVENT_ADDRESS_COLLECTED P_CALL_EVENT_ADDRESS_COLLECTED P_CALL_EVENT_ADDRESS_ANALYSED P_CALL_EVENT_ADDRESS_COLLECTED P_CALL_EVENT_ADDRESS_ANALYSED P_CALL_EVENT_ALERTING P_CALL_EVENT_ALERTING P_CALL_EVENT_TERMINATING_RELEASE with criteria: P_USER_NOT_AVAILABLE P_BUSY P_NOT_REACHABLE P_ROUTING_FAILURE P_CALL_RESTRICTED P_UNAVAILABLE_RESOURCES P_CALL_EVENT_ANSWER P_CALL_EVENT_ALERTING P_CALL_EVENT_ANSWER P_CALL_EVENT_TERMINATING_RELEASE with criteria: P_USER_NOT_AVAILABLE P_BUSY P_NOT_REACHABLE P_ROUTING_FAILURE P_CALL_RESTRICTED P_UNAVAILABLE_RESOURCES P_NO_ANSWER P_CALL_EVENT_ORIGINATING_RELEASE All pending network events for the call leg are disarmed P_CALL_EVENT_TERMINATING_RELEASE All pending network events for the call leg are disarmed P_CALL_EVENT_ORIGINATING_SERVICE_CODE P_CALL_EVENT_ORIGINATING_SERVICE_CODE *) see NOTE 2 P_CALL_EVENT_TERMINATING_SERVICE_CODE P_CALL_EVENT_TERMINATING_SERVICE_CODE *) see NOTE 2 NOTE 2: Only the detected service code or the range to which the service code belongs is disarmed. 7.6.2.25 TpAdditionalCallEventCriteria Defines the Tagged Choice of Data Elements that specify specific criteria. Tag Element Type TpCallEventType Tag Element Value Choice Element Type Choice Element Name P_CALL_EVENT_UNDEFINED NULL Undefined P_CALL_EVENT_ORIGINATING_CALL_ATTEMPT NULL Undefined P_CALL_EVENT_ORIGINATING_CALL_ATTEMPT_AUTHORISED NULL Undefined P_CALL_EVENT_ADDRESS_COLLECTED TpInt32 MinAddressLength P_CALL_EVENT_ADDRESS_ANALYSED NULL Undefined P_CALL_EVENT_ORIGINATING_SERVICE_CODE TpCallServiceCodeSet OriginatingServiceCode P_CALL_EVENT_ORIGINATING_RELEASE TpReleaseCauseSet OriginatingReleaseCauseSet P_CALL_EVENT_TERMINATING_CALL_ATTEMPT NULL Undefined P_CALL_EVENT_TERMINATING_CALL_ATTEMPT_AUTHORISED NULL Undefined P_CALL_EVENT_ALERTING NULL Undefined P_CALL_EVENT_ANSWER NULL Undefined P_CALL_EVENT_TERMINATING_RELEASE TpReleaseCauseSet TerminatingReleaseCauseSet P_CALL_EVENT_REDIRECTED NULL Undefined P_CALL_EVENT_TERMINATING_SERVICE_CODE TpCallServiceCodeSet TerminatingServiceCode P_CALL_EVENT_QUEUED NULL Undefined 7.6.2.26 TpCallEventInfo Defines the Sequence of Data Elements that specify the event report specific information. Sequence Element Name Sequence Element Type CallEventType TpCallEventType AdditionalCallEventInfo TpCallAdditionalEventInfo CallMonitorMode TpCallMonitorMode CallEventTime TpDateAndTime 7.6.2.27 TpCallAdditionalEventInfo Defines the Tagged Choice of Data Elements that specify additional call event information for certain types of events. Tag Element Type TpCallEventType Tag Element Value Choice Element Type Choice Element Name P_CALL_EVENT_UNDEFINED NULL Undefined P_CALL_EVENT_ORIGINATING_CALL_ATTEMPT NULL Undefined P_CALL_EVENT_ORIGINATING_CALL_ATTEMPT_AUTHORISED NULL Undefined P_CALL_EVENT_ADDRESS_COLLECTED TpAddress CollectedAddress P_CALL_EVENT_ADDRESS_ANALYSED TpAddress CalledAddress P_CALL_EVENT_ORIGINATING_SERVICE_CODE TpCallServiceCode OriginatingServiceCode P_CALL_EVENT_ORIGINATING_RELEASE TpReleaseCause OriginatingReleaseCause P_CALL_EVENT_TERMINATING_CALL_ATTEMPT NULL Undefined P_CALL_EVENT_TERMINATING_CALL_ATTEMPT_AUTHORISED NULL Undefined P_CALL_EVENT_ALERTING NULL Undefined P_CALL_EVENT_ANSWER NULL Undefined P_CALL_EVENT_TERMINATING_RELEASE TpReleaseCause TerminatingReleaseCause P_CALL_EVENT_REDIRECTED TpAddress ForwardAddress P_CALL_EVENT_TERMINATING_SERVICE_CODE TpCallServiceCode TerminatingServiceCode P_CALL_EVENT_QUEUED NULL Undefined 7.6.2.28 TpCallNotificationRequest Defines the Sequence of Data Elements that specify the criteria for an event notification Sequence Element Name Sequence Element Type Description CallNotificationScope TpCallNotificationScope Defines the scope of the notification request. CallEventsRequested TpCallEventRequestSet Defines the events which are requested 7.6.2.29 TpCallNotificationScope Defines a the sequence of Data elements that specify the scope of a notification request. Of the addresses only the Plan and the AddrString are used for the purpose of matching the notifications against the criteria. Sequence Element Name Sequence Element Type Description DestinationAddress TpAddressRange Defines the destination address or address range for which the notification is requested. OriginatingAddress TpAddressRange Defines the origination address or address range for which the notification is requested. 7.6.2.30 TpCallNotificationInfo Defines the Sequence of Data Elements that specify the information returned to the application in a Call notification report. Sequence Element Name Sequence Element Type Description CallNotificationReportScope TpCallNotificationReportScope Defines the scope of the notification report. CallAppInfo TpCallAppInfoSet Contains additional call info. CallEventInfo TpCallEventInfo Contains the event which is reported. 7.6.2.31 TpCallNotificationReportScope Defines the Sequence of Data Elements that specify the scope for which a notification report was sent. Sequence Element Name Sequence Element Type Description DestinationAddress TpAddress Contains the destination address of the call. OriginatingAddress TpAddress Contains the origination address of the call 7.6.2.32 TpNotificationRequested Defines the Sequence of Data Elements that specify the criteria relating to event requests. Sequence Element Name Sequence Element Type AppCallNotificationRequest TpCallNotificationRequest AssignmentID TpInt32 7.6.2.33 TpNotificationRequestedSet Defines a numbered Set of Data Elements of TpNotificationRequested. 7.6.2.34 TpReleaseCause Defines the reason for which a call is released. Name Value Description P_UNDEFINED 0 The reason of release is not known, because no info was received from the network. P_USER_NOT_AVAILABLE 1 The user is not available in the network. This means that the number is not allocated or that the user is not registered. P_BUSY 2 The user is busy. P_NO_ANSWER 3 No answer was received P_NOT_REACHABLE 4 The user terminal is not reachable P_ROUTING_FAILURE 5 A routing failure occurred. For example an invalid address was received P_PREMATURE_DISCONNECT 6 The user disconnected the call / call leg during the setup phase. P_DISCONNECTED 7 A disconnect was received. P_CALL_RESTRICTED 8 The call was subject of restrictions P_UNAVAILABLE_RESOURCE 9 The request could not be carried out as no resources were available. P_GENERAL_FAILURE 10 A general network failure occurred. P_TIMER_EXPIRY 11 The call / call leg was released because an activity timer expired. 7.6.2.35 TpReleaseCauseSet Defines a Numbered Set of Data Elements of TpReleaseCause. 7.6.2.36 TpCallLegIdentifier Defines the Sequence of Data Elements that unambiguously specify the Call Leg object. Sequence Element Name Sequence Element Type Sequence Element Description CallLegReference IpCallLegRef This element specifies the interface reference for the callLeg object. CallLegSessionID TpSessionID This element specifies the callLeg session ID. 7.6.2.37 TpCallLegIdentifierSet Defines a Numbered Set of Data Elements of TpCallLegIdentifier. 7.6.2.38 TpCallLegAttachMechanism Defines how a CallLeg should be attached to the call. Name Value Description P_CALLLEG_ATTACH_IMPLICITLY 0 CallLeg should be attached implicitly to the call. P_CALLLEG_ATTACH_EXPLICITLY 1 CallLeg should be attached explicitly to the call by using the attachMediaReq() operation. This allows e.g. the application to do first user interaction to the party before he/she is placed in the call. 7.6.2.39 TpCallLegConnectionProperties Defines the Sequence of Data Elements that specify the connection properties of the Call Leg object Sequence Element Name Sequence Element Type Sequence Element Description AttachMechanism TpCallLegAttachMechanism Defines how a CallLeg should be attached to the call. 7.6.2.40 TpCallLegInfoReport Defines the Sequence of Data Elements that specify the call leg information requested. Sequence Element Name Sequence Element Type Description CallLegInfoType TpCallLegInfoType The type of call leg information. CallLegStartTime TpDateAndTime The time and date when the call leg was started (i.e. the leg was routed). CallLegConnectedToResourceTime TpDateAndTime The date and time when the call leg was connected to the resource. If no resource was connected the time is set to an empty string. Either this element is valid or the CallConnectedToAddressTime is valid, depending on whether the report is sent as a result of user interaction. CallLegConnectedToAddressTime TpDateAndTime The date and time when the call leg was connected to the destination (i.e. when the destination answered the call). If the destination did not answer, the time is set to an empty string. Either this element is valid or the CallConnectedToResourceTime is valid, depending on whether the report is sent as a result of user interaction. CallLegEndTime TpDateAndTime The date and time when the call leg was released. ConnectedAddress TpAddress The address of the party associated with the leg. If during the call the connected address was received from the party then this is returned, otherwise the destination address (for legs connected to a destination) or the originating address (for legs connected to the origination) is returned. CallLegReleaseCause TpReleaseCause The cause of the termination. May be present with P_CALL_LEG_INFO_RELEASE_CAUSE was specified. CallAppInfo TpCallAppInfoSet Additional information for the leg. May be present with P_CALL_LEG_INFO_APPINFO was specified. 7.6.2.41 TpCallLegInfoType Defines the type of call leg information requested and reported. The values may be combined by a logical 'OR' function. Name Value Description P_CALL_LEG_INFO_UNDEFINED 00h Undefined P_CALL_LEG_INFO_TIMES 01h Relevant call times P_CALL_LEG_INFO_RELEASE_CAUSE 02h Call leg release cause P_CALL_LEG_INFO_ADDRESS 04h Call leg connected address P_CALL_LEG_INFO_APPINFO 08h Call leg application related information 7.6.2.42 TpCallLegSuperviseTreatment Defines the treatment of the call leg by the call control service when the call leg supervision timer expires. The values may be combined by a logical 'OR' function. Name Value Description P_CALL_LEG_SUPERVISE_RELEASE 01h Release the call leg when the call leg supervision timer expires P_CALL_LEG_SUPERVISE_RESPOND 02h Notify the application when the call leg supervision timer expires P_CALL_LEG_SUPERVISE_APPLY_TONE 04h Send a warning tone on the call leg when the call leg supervision timer expires. If call leg release is requested, then the call leg will be released following the tone after an administered time period 8 Common Call Control Data Types The following data types referenced in this clause are defined in 3GPP TS 29.198-5: TpUIInfo All other data types referenced but not defined in this clause are common data definitions which may be found in 3GPP TS 29.198-2. 8.1 TpCallAlertingMechanism This data type is identical to a TpInt32, and defines the mechanism that will be used to alert a call party. The values of this data type are operator specific. 8.2 TpCallBearerService This data type defines the type of call application-related specific information (Q.931: Information Transfer Capability, and 3G TS 22.002) Name Value Description P_CALL_BEARER_SERVICE_UNKNOWN 0 Bearer capability information unknown at this time P_CALL_BEARER_SERVICE_SPEECH 1 Speech P_CALL_BEARER_SERVICE_DIGITALUNRESTRICTED 2 Unrestricted digital information P_CALL_BEARER_SERVICE_DIGITALRESTRICTED 3 Restricted digital information P_CALL_BEARER_SERVICE_AUDIO 4 3,1 kHz audio P_CALL_BEARER_SERVICE_DIGITALUNRESTRICTEDTONES 5 Unrestricted digital information with tones/announcements P_CALL_BEARER_SERVICE_VIDEO 6 Video 8.3 TpCallChargePlan Defines the Sequence of Data Elements that specify the charge plan for the call. Sequence Element Name Sequence Element Type Description ChargeOrderType TpCallChargeOrderCategory Charge order TransparentCharge TpOctetSet Operator specific charge plan specification, e.g. charging table name / charging table entry. The associated charge plan data will be send transparently to the charging records. Only applicable when transparent charging is selected. ChargePlan TpInt32 Pre-defined charge plan. Example of the charge plan set from which the application can choose could be : (0 = normal user, 1 = silver card user, 2 = gold card user). Only applicable when predefined charge plan is selected. AdditionalInfo TpOctetSet Descriptive string which is sent to the billing system without prior evaluation. Could be included in the ticket. PartyToCharge TpCallPartyToChargeType Identifies the entity or party to be charged for the call or call leg. PartyToChargeAdditionalInfo TpCallPartyToChargeAdditionalInfo Contains additional information regarding the charged party. 8.4 TpCallPartyToChargeAdditionalInfo Defines the Tagged Choice of Data Elements that identifies the entity or party to be charged. Tag Element Type TpCallPartyToChargeType Tag Element Value Choice Element Type Choice Element Name P_CALL_PARTY_ORIGINATING NULL Undefined P_CALL_PARTY_DESTINATION NULL Undefined P_CALL_PARTY_SPECIAL TpAddress CallPartySpecial 8.5 TpCallPartyToChargeType Defines the type of call party to charge Name Value Description P_CALL_PARTY_ORIGINATING 0 Calling party, i.e. party that initiated the call. For application initiated calls this indicates the first party of the call P_CALL_PARTY_DESTINATION 1 Called party P_CALL_PARTY_SPECIAL 2 An address identifying e.g. a third party, a service provider 8.6 TpCallChargeOrderCategory Defines the type of charging to be applied Name Value Description P_CALL_CHARGE_TRANSPARENT 0 Operator specific charge plan specification, e.g. charging table name / charging table entry. The associated charge plan data will be send transparently to the charging records P_CALL_CHARGE_PREDEFINED_SET 1 Pre-defined charge plan. Example of the charge plan set from which the application can choose could be : (0 = normal user, 1 = silver card user, 2 = gold card user). 8.7 TpCallEndedReport Defines the Sequence of Data Elements that specify the reason for the call ending. Sequence Element Name Sequence Element Type Description CallLegSessionID TpSessionID The leg that initiated the release of the call. If the call release was not initiated by the leg, then this value is set to –1. Cause TpReleaseCause The cause of the call ending. 8.8 TpCallError Defines the Sequence of Data Elements that specify the additional information relating to a call error. Sequence Element Name Sequence Element Type ErrorTime TpDateAndTime ErrorType TpCallErrorType AdditionalErrorInfo TpCallAdditionalErrorInfo 8.9 TpCallAdditionalErrorInfo Defines the Tagged Choice of Data Elements that specify additional call error and call error specific information. This is also used to specify call leg errors and information errors. Tag Element Type TpCallErrorType Tag Element Value Choice Element Type Choice Element Name P_CALL_ERROR_UNDEFINED NULL Undefined P_CALL_ERROR_INVALID_ADDRESS TpAddressError CallErrorInvalidAddress P_CALL_ERROR_INVALID_STATE NULL Undefined P_CALL_ERROR_RESOURCE_UNAVAILABLE NULL Undefined 8.10 TpCallErrorType Defines a specific call error. Name Value Description P_CALL_ERROR_UNDEFINED 0 Undefined; the method failed or was refused, but no specific reason can be given. P_CALL_ERROR_INVALID_ADDRESS 1 The operation failed because an invalid address was given P_CALL_ERROR_INVALID_STATE 2 The call was not in a valid state for the requested operation P_CALL_ERROR_RESOURCE_UNAVAILABLE 3 There are not enough resources to complete the request successfully 8.11 TpCallInfoReport Defines the Sequence of Data Elements that specify the call information requested. Information that was not requested is invalid. Sequence Element Name Sequence Element Type Description CallInfoType TpCallInfoType The type of call report. CallInitiationStartTime TpDateAndTime The time and date when the call, or follow-on call, was started. CallConnectedToResourceTime TpDateAndTime The date and time when the call was connected to the resource. This data element is only valid when information on user interaction is reported. CallConnectedToDestinationTime TpDateAndTime The date and time when the call was connected to the destination (i.e., when the destination answered the call). If the destination did not answer, the time is set to an empty string. This data element is invalid when information on user interaction is reported with an intermediate report. CallEndTime TpDateAndTime The date and time when the call or follow-on call or user interaction was terminated. Cause TpReleaseCause The cause of the termination. A callInfoReport will be generated at the end of user interaction and at the end of the connection with the associated address. This means that either the destination related information is present or the resource related information, but not both. 8.12 TpCallInfoType Defines the type of call information requested and reported. The values may be combined by a logical 'OR' function. Name Value Description P_CALL_INFO_UNDEFINED 00h Undefined P_CALL_INFO_TIMES 01h Relevant call times P_CALL_INFO_RELEASE_CAUSE 02h Call release cause 8.13 TpCallLoadControlMechanism Defines the Tagged Choice of Data Elements that specify the applied mechanism and associated parameters. Tag Element Type TpCallLoadControlMechanismType Tag Element Value Choice Element Type Choice Element Name P_CALL_LOAD_CONTROL_PER_INTERVAL TpCallLoadControlIntervalRate CallLoadControlPerInterval 8.14 TpCallLoadControlIntervalRate Defines the call admission rate of the call load control mechanism used. This data type indicates the interval (in milliseconds) between calls that are admitted. Name Value Description P_CALL_LOAD_CONTROL_ADMIT_NO_CALLS 0 Infinite interval (do not admit any calls) 1 - 60000 Duration in milliseconds 8.15 TpCallLoadControlMechanismType Defines the type of call load control mechanism to use. Name Value Description P_CALL_LOAD_CONTROL_PER_INTERVAL 0 admit one call per interval 8.16 TpCallMonitorMode Defines the mode that the call will monitor for events, or the mode that the call is in following a detected event. Name Value Description P_CALL_MONITOR_MODE_INTERRUPT 0 The call event is intercepted by the call control service and call processing is interrupted. The application is notified of the event and call processing resumes following an appropriate API call or network event (such as a call release) P_CALL_MONITOR_MODE_NOTIFY 1 The call event is detected by the call control service but not intercepted. The application is notified of the event and call processing continues P_CALL_MONITOR_MODE_DO_NOT_MONITOR 2 Do not monitor for the event 8.17 TpCallNetworkAccessType This data defines the bearer capabilities associated with the call. (3G TS 24.002) This information is network operator specific and may not always be available because there is no standard protocol to retrieve the information. Name Value Description P_CALL_NETWORK_ACCESS_TYPE_UNKNOWN 0 Network type information unknown at this time P_CALL_NETWORK_ACCESS_TYPE_POT 1 POTS P_CALL_NETWORK_ACCESS_TYPE_ISDN 2 ISDN P_CALL_NETWORK_ACCESS_TYPE_DIALUPINTERNET 3 Dial-up Internet P_CALL_NETWORK_ACCESS_TYPE_XDSL 4 xDSL P_CALL_NETWORK_ACCESS_TYPE_WIRELESS 5 Wireless 8.18 TpCallPartyCategory This data type defines the category of a calling party. (Q.763: Calling Party Category / Called Party Category) Name Value Description P_CALL_PARTY_CATEGORY_UNKNOWN 0 calling party's category unknown at this time P_CALL_PARTY_CATEGORY_OPERATOR_F 1 operator, language French P_CALL_PARTY_CATEGORY_OPERATOR_E 2 operator, language English P_CALL_PARTY_CATEGORY_OPERATOR_G 3 operator, language German P_CALL_PARTY_CATEGORY_OPERATOR_R 4 operator, language Russian P_CALL_PARTY_CATEGORY_OPERATOR_S 5 operator, language Spanish P_CALL_PARTY_CATEGORY_ORDINARY_SUB 6 ordinary calling subscriber P_CALL_PARTY_CATEGORY_PRIORITY_SUB 7 calling subscriber with priority P_CALL_PARTY_CATEGORY_DATA_CALL 8 data call (voice band data) P_CALL_PARTY_CATEGORY_TEST_CALL 9 test call P_CALL_PARTY_CATEGORY_PAYPHONE 10 payphone 8.19 TpCallServiceCode Defines the Sequence of Data Elements that specify the service code and type of service code received during a call. The service code type defines how the value string should be interpreted. Sequence Element Name Sequence Element Type CallServiceCodeType TpCallServiceCodeType ServiceCodeValue TpString 8.20 TpCallServiceCodeSet Defines a Numbered Set of Data Elements of TpCallServiceCode. 8.21 TpCallServiceCodeType Defines the different types of service codes that can be received during the call. Name Value Description P_CALL_SERVICE_CODE_UNDEFINED 0 The type of service code is unknown. The corresponding string is operator specific. P_CALL_SERVICE_CODE_DIGITS 1 The user entered a digit sequence during the call. The corresponding string is an ASCII representation of the received digits. P_CALL_SERVICE_CODE_FACILITY 2 A facility information element is received. The corresponding string contains the facility information element as defined in ITU Q.932 P_CALL_SERVICE_CODE_U2U 3 A user-to-user message was received. The associated string contains the content of the user-to-user information element. P_CALL_SERVICE_CODE_HOOKFLASH 4 The user performed a hookflash, optionally followed by some digits. The corresponding string is an ASCII representation of the entered digits. P_CALL_SERVICE_CODE_RECALL 5 The user pressed the register recall button, optionally followed by some digits. The corresponding string is an ASCII representation of the entered digits. 8.22 TpCallSuperviseReport Defines the responses from the call control service for calls that are supervised. The values may be combined by a logical 'OR' function. Name Value Description P_CALL_SUPERVISE_TIMEOUT 01h The call supervision timer has expired P_CALL_SUPERVISE_CALL_ENDED 02h The call has ended, either due to timer expiry or call party release. In case the called party disconnects but a follow-on call can still be made also this indication is used. P_CALL_SUPERVISE_TONE_APPLIED 04h A warning tone has been applied. This is only sent in combination with P_CALL_SUPERVISE_TIMEOUT P_CALL_SUPERVISE_UI_FINISHED 08h The user interaction has finished. 8.23 TpCallSuperviseTreatment Defines the treatment of the call by the call control service when the call supervision timer expires. The values may be combined by a logical 'OR' function. Name Value Description P_CALL_SUPERVISE_RELEASE 01h Release the call when the call supervision timer expires P_CALL_SUPERVISE_RESPOND 02h Notify the application when the call supervision timer expires P_CALL_SUPERVISE_APPLY_TONE 04h Send a warning tone to the originating party when the call supervision timer expires. If call release is requested, then the call will be released following the tone after an administered time period 8.24 TpCallTeleService This data type defines the tele-service associated with the call. (Q.763: User Teleservice Information, Q.931: High Layer Compatibility Information, and 3G TS 22.003) Name Value Description P_CALL_TELE_SERVICE_UNKNOWN 0 Teleservice information unknown at this time P_CALL_TELE_SERVICE_TELEPHONY 1 Telephony P_CALL_TELE_SERVICE_FAX_2_3 2 Facsimile Group 2/3 P_CALL_TELE_SERVICE_FAX_4_I 3 Facsimile Group 4, Class I P_CALL_TELE_SERVICE_FAX_4_II_III 4 Facsimile Group 4, Classes II and III P_CALL_TELE_SERVICE_VIDEOTEX_SYN 5 Syntax based Videotex P_CALL_TELE_SERVICE_VIDEOTEX_INT 6 International Videotex interworking via gateways or interworking units P_CALL_TELE_SERVICE_TELEX 7 Telex service P_CALL_TELE_SERVICE_MHS 8 Message Handling Systems P_CALL_TELE_SERVICE_OSI 9 OSI application P_CALL_TELE_SERVICE_FTAM 10 FTAM application P_CALL_TELE_SERVICE_VIDEO 11 Videotelephony P_CALL_TELE_SERVICE_VIDEO_CONF 12 Videoconferencing P_CALL_TELE_SERVICE_AUDIOGRAPH_CONF 13 Audiographic conferencing P_CALL_TELE_SERVICE_MULTIMEDIA 14 Multimedia services P_CALL_TELE_SERVICE_CS_INI_H221 15 Capability set of initial channel of H.221 P_CALL_TELE_SERVICE_CS_SUB_H221 16 Capability set of subsequent channel of H.221 P_CALL_TELE_SERVICE_CS_INI_CALL 17 Capability set of initial channel associated with an active 3,1 kHz audio or speech call. P_CALL_TELE_SERVICE_DATATRAFFIC 18 Data traffic. P_CALL_TELE_SERVICE_EMERGENCY_CALLS 19 Emergency Calls P_CALL_TELE_SERVICE_SMS_MT_PP 20 Short message MT/PP P_CALL_TELE_SERVICE_SMS_MO_PP 21 Short message MO/PP P_CALL_TELE_SERVICE_CELL_BROADCAST 22 Cell Broadcast Service P_CALL_TELE_SERVICE_ALT_SPEECH_FAX_3 23 Alternate speech and facsimile group 3 P_CALL_TELE_SERVICE_AUTOMATIC_FAX_3 24 Automatic Facsimile group 3 P_CALL_TELE_SERVICE_VOICE_GROUP_CALL 25 Voice Group Call Service P_CALL_TELE_SERVICE_VOICE_BROADCAST 26 Voice Broadcast Service 8.25 TpCallTreatment Defines the Sequence of Data Elements that specify the treatment for calls that will be handled only by the network (for example, call which are not admitted by the call load control mechanism). Sequence Element Name Sequence Element Type CallTreatmentType TpCallTreatmentType ReleaseCause TpReleaseCause AdditionalTreatmentInfo TpCallAdditionalTreatmentInfo 8.26 TpCallTreatmentType Defines the treatment for calls that will be handled only by the network. Name Value Description P_CALL_TREATMENT_DEFAULT 0 Default treatment P_CALL_TREATMENT_RELEASE 1 Release the call P_CALL_TREATMENT_SIAR 2 Send information to the user, and release the call (Send Info & Release) 8.27 TpCallAdditionalTreatmentInfo Defines the Tagged Choice of Data Elements that specify the information to be sent to a call party. Tag Element Type TpCallTreatmentType Tag Element Value Choice Element Type Choice Element Name P_CALL_TREATMENT_DEFAULT NULL Undefined P_CALL_TREATMENT_RELEASE NULL Undefined P_CALL_TREATMENT_SIAR TpUIInfo InformationToSend 8.28 TpMediaType Defines the media type of a media stream. The values may be combined by a logical 'OR' function. Name Value Description P_AUDIO 1 Audio stream P_VIDEO 2 Video stream P_DATA 4 Data stream (e.g., T.120) Annex A (normative): OMG IDL Description of Call Control SCF The OMG IDL representation of this interface specification is contained in text files (contained in archive 2919804V4b0IDL.ZIP) which accompany the present document. Annex B (informative): Change history Change history Date TSG # TSG Doc. CR Rev Subject/Comment Old New Mar 2001 CN_11 NP-010134 047 - CR 29.198: for moving TS 29.198 from R99 to Rel 4 (N5-010158) 3.2.0 1.0.0 June 2001 CN_12 NP-010327 -- -- Approved at TSG CN#12 and placed under Change Control 2.0.0 4.0.0 Sep 2001 CN_13 NP-010467 001 -- Changing references to JAIN 4.0.0 4.1.0 Sep 2001 CN_13 NP-010467 002 -- Correction of text descriptions for methods enableCallNotification and createNotification 4.0.0 4.1.0 Sep 2001 CN_13 NP-010467 003 -- Specify the behaviour when a call leg times out 4.0.0 4.1.0 Sep 2001 CN_13 NP-010467 004 -- Removal of Faulty state in MPCCS Call State Transition Diagram and method callFaultDetected in MPCCS in OSA R4 4.0.0 4.1.0 Sep 2001 CN_13 NP-010467 005 -- Missing TpCallAppInfoSet description in OSA R4 4.0.0 4.1.0 Sep 2001 CN_13 NP-010467 006 -- Redirecting a call leg vs. creating a call leg clarification in OSA R4 4.0.0 4.1.0 Sep 2001 CN_13 NP-010467 007 -- Introduction of MPCC Originating and Terminating Call Leg STDs for IpCallLeg 4.0.0 4.1.0 Sep 2001 CN_13 NP-010467 008 -- Corrections to SetChargePlan() Addition of PartyToCharge parmeter 4.0.0 4.1.0 Sep 2001 CN_13 NP-010467 009 -- Corrections to SetChargePlan() 4.0.0 4.1.0 Sep 2001 CN_13 NP-010467 010 -- Remove distinction between final- and intermediate-report 4.0.0 4.1.0 Sep 2001 CN_13 NP-010467 011 -- Inclusion of TpMediaType 4.0.0 4.1.0 Sep 2001 CN_13 NP-010467 012 -- Corrections to GCC STD 4.0.0 4.1.0 Sep 2001 CN_13 NP-010467 013 -- Introduction of sequence diagrams for MPCC services 4.0.0 4.1.0 Sep 2001 CN_13 NP-010467 014 -- The use of the REDIRECT event needs to be illustrated 4.0.0 4.1.0 Sep 2001 CN_13 NP-010467 015 -- Corrections to SetCallChargePlan() 4.0.0 4.1.0 Sep 2001 CN_13 NP-010467 016 -- Add one additional error indication 4.0.0 4.1.0 Sep 2001 CN_13 NP-010467 017 -- Corrections to Call Control – GCCS Exception handling 4.0.0 4.1.0 Sep 2001 CN_13 NP-010467 018 -- Corrections to Call Control – Errors in Exceptions 4.0.0 4.1.0 Dec 2001 CN_14 NP-010597 019 -- Replace Out Parameters with Return Types 4.1.0 4.2.0 Dec 2001 CN_14 NP-010597 020 -- Removal of time based charging property 4.1.0 4.2.0 Dec 2001 CN_14 NP-010597 021 -- Make attachMedia() and detachMedia() asynchronous 4.1.0 4.2.0 Dec 2001 CN_14 NP-010597 022 -- Correction of treatment datatype in superviseReq on call leg 4.1.0 4.2.0 Dec 2001 CN_14 NP-010597 023 -- Corrections to Call Control Data Types 4.1.0 4.2.0 Dec 2001 CN_14 NP-010597 024 -- Correction to Call Control (CC) 4.1.0 4.2.0 Dec 2001 CN_14 NP-010597 025 -- Amend the Generic Call Control introductory part 4.1.0 4.2.0 Dec 2001 CN_14 NP-010597 026 -- Correction in TpCallEventType 4.1.0 4.2.0 Dec 2001 CN_14 NP-010597 027 -- Addition of missing description of RouteErr() 4.1.0 4.2.0 Dec 2001 CN_14 NP-010597 028 -- Misleading description of createAndRouteCallLegErr() 4.1.0 4.2.0 Dec 2001 CN_14 NP-010597 029 -- Correction to values of TpCallNotificationType, TpCallLoadControlMechanismType 4.1.0 4.2.0 Dec 2001 CN_14 NP-010695 030 -- Correction of method getLastRedirectionAddress 4.1.0 4.2.0 Mar 2002 CN_15 NP-020106 031 -- Add P_INVALID_INTERFACE_TYPE exception to IpService.setCallback() and IpService.setCallbackWithSessionID() 4.2.0 4.3.0 Mar 2002 CN_15 NP-020106 032 -- Correction of Event Subscription/Notification Data Type 4.2.0 4.3.0 Mar 2002 CN_15 NP-020106 033 -- Correction of parameter name in IpCallLeg.routeReq() and in IpCallLeg.setAdviceOfCharge() 4.2.0 4.3.0 Mar 2002 CN_15 NP-020106 034 -- Clarification of ambiguous Event handling rules 4.2.0 4.3.0 Jun 2002 CN_16 NP-020180 035 -- Correction to TpCallChargePlan 4.3.0 4.4.0 Jun 2002 CN_16 NP-020180 036 -- Correction to CAMEL Service Property values 4.3.0 4.4.0 Sep 2002 CN_17 NP-020424 057 -- Correction on use of NULL in Call Control API 4.4.0 4.5.0 Mar 2003 CN_19 NP-030020 058 -- Correction of status of methods to interfaces in clause 6.3 4.5.0 4.6.0 Mar 2003 CN_19 NP-030020 059 -- Correction to TpReleaseCauseSet in Multi Party Call Control 4.5.0 4.6.0 Mar 2003 CN_19 NP-030020 060 -- Correction to Sequence Diagrams to remove incorrect Framework references 4.5.0 4.6.0 Mar 2003 CN_19 NP-030020 061 -- Correction to User Interaction Prepaid Sequence Diagrams 4.5.0 4.6.0 Mar 2003 CN_19 NP-030020 062 -- Correction to remove unused TpCallChargeOrder 4.5.0 4.6.0 Mar 2003 CN_19 NP-030020 063 -- Correction to TpCallEventCriteriaResult in Generic Call Control 4.5.0 4.6.0 Mar 2003 CN_19 NP-030020 064 -- Correction of status of methods to interfaces in clause 7.3 4.5.0 4.6.0 Jun 2003 CN_20 NP-030238 065 -- Correction of the description for callEventNotify & reportNotification 4.6.0 4.7.0 Dec 2003 CN_22 NP-030544 066 -- Correction of description in superviseRes and superviseCallRes 4.7.0 4.8.0 Jun 2004 CN_24 NP-040255 067 -- Correction of continueProcessing method for Generic Call Control Service (GCCS) 4.8.0 4.9.0 Jun 2004 CN_24 NP-040256 068 -- Correct the P_TRIGGERING_ADDRESSES service property 4.8.0 4.9.0 Jun 2004 CN_24 NP-040257 069 -- Correction of callbacks sequence and timing conditions in GCCS and MPCCS 4.8.0 4.9.0 Sep 2004 CN_25 NP-040352 070 -- Correct State Transition Diagram for IpCall 4.9.0 4.10.0 Dec 2004 CN_25 NP-040483 071 -- Correct Behaviour of CallBack sequence and timing 4.10.0 4.11.0
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
1 Scope
The present document deals with the procedures allowing the technical realization of the real time end‑to‑end facsimile group 3 service within the GSM PLMN using non‑transparent network support according to the definition of the Teleservices 61 and 62 specified in GSM 02.03. Within the present document particular attention is given to Teleservice "Alternate speech/facsimile group 3" (Teleservice 61). However, the definitions apply also to Teleservice "Automatic facsimile group 3" (Teleservice 62) with the exception of all actions concerned with the speech phase. Consequently, in the following descriptions the term "Teleservice" denotes both Teleservice 61 and Teleservice 62 as appropriate. NOTE: Some facilities associated with alternate speech/ facsimile group 3 may not be available with version 1 of MAP. In particular, the in‑call modification procedure following an inter MSC handover is not supported by this version. This imposes the limitation that for all calls it will not be possible to change between speech and facsimile following an inter MSC handover.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
2 References
The following documents contain provisions which, through reference in this text, constitute provisions of the present document. • References are either specific (identified by date of publication, edition number, version number, etc.) or non‑specific. • For a specific reference, subsequent revisions do not apply. • For a non-specific reference, the latest version applies. • A non-specific reference to an ETS shall also be taken to refer to later versions published as an EN with the same number. • For this Release 1998 document, references to GSM documents are for Release 1998 versions (version 7.x.y). [1] GSM 01.04: "Digital cellular telecommunications system (Phase 2+); Abbreviations and acronyms". [2] GSM 02.03: "Digital cellular telecommunications system (Phase 2+); Teleservices supported by a GSM Public Land Mobile Network (PLMN)". [3] GSM 03.10: "Digital cellular telecommunications system (Phase 2+); GSM Public Land Mobile Network (PLMN) connection types". [4] GSM 04.02: "Digital cellular telecommunications system (Phase 2+); GSM Public Land Mobile Network (PLMN) access reference configuration". [5] GSM 04.08: "Digital cellular telecommunications system (Phase 2+); Mobile radio interface layer 3 specification". [6] GSM 04.21: "Digital cellular telecommunications system (Phase 2+); Rate adaption on the Mobile Station ‑ Base Station System (MS ‑ BSS) interface". [7] GSM 07.01: "Digital cellular telecommunications system (Phase 2+); General on Terminal Adaptation Functions (TAF) for Mobile Stations (MS)". [8] GSM 07.03: "Digital cellular telecommunications system (Phase 2+); Terminal Adaptation Functions (TAF) for services using synchronous bearer capabilities". [9] GSM 09.07: "Digital cellular telecommunications system (Phase 2+); General requirements on interworking between the Public Land Mobile Network (PLMN) and the Integrated Services Digital Network (ISDN) or Public Switched Telephone Network (PSTN)". [10] CCITT Recommendation F.160: "General operational provisions for the international public facsimile services". [11] CCITT Recommendation T.4: "Standardization of group 3 facsimile apparatus for document transmission". [12] CCITT Recommendation T.30: "Procedures for document facsimile transmission in the general switched telephone network". [13] CCITT Recommendation T.35: "Procedure for the allocation of CCITT members' codes". [14] CCITT Recommendation V.21: "300 bits per second duplex modem standardized for use in the general switched telephone network". [15] CCITT Recommendation V.24: "List of definitions for interchange circuits between data terminal equipment (DTE) and data circuit‑terminating equipment (DCE)". [16] CCITT Recommendation V.25 bis: "Automatic calling and/or answering equipment on the general switched telephone network (GSTN) using the 100‑series interchange circuits". [17] CCITT Recommendation V.27 ter: "4 800/2 400 bits per second modem standardized for use in the general switched telephone network". [18] CCITT Recommendation V.29: "9 600 bits per second modem standardized for use on point‑to‑point 4‑wire leased telephone‑type circuits". [19] CCITT Recommendation X.300: "General principles and arrangements for interworking between public data networks, and between public data networks and other networks".
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
2.1 Abbreviations
In addition to those below abbreviations used in the present document are listed in GSM 01.04. BCS Binary coded signalling CCT Circuit(s) I/F Interface RA1,RA1',RA2 Rate adaptation functions SREJ Selective reject The abbreviations for the facsimile specific protocol elements and signals are listed in appendix I.
1b3a41393e6b9c2d9c5a8ec454e96ca8
03.46
3 Service definition
The fixed network facsimile group 3 service, as basically defined in CCITT Recommendation F.160, is an international telematic service for document transmission between two facsimile group 3 terminals. The service specifications are comprised of two parts: ‑ the control procedures described in CCITT Recommendation T.30 and ‑ the document transmission coding described in CCITT Recommendation T.4. The GSM facsimile group 3 Teleservice is intended to allow connections between facsimile group 3 terminals using: ‑ a GSM PLMN as stand‑alone facility for mobile‑to‑mobile communication; ‑ a GSM PLMN to have access to fixed networks PSTN and/or ISDN for mobile to/from fixed network communication. For this Teleservice, the coding of the facsimile document is as per CCITT Recommendation T.4 and the protocol as per CCITT Recommendation T.30 both modified within the PLMN as detailed in the present document. The interworking between different networks is based on CCITT Recommendation X.300. The particular features of this Teleservice are: ‑ it uses point‑to‑point communication; ‑ the information transfer mode is circuit, duplex, synchronous; ‑ the information transfer capability is alternate speech/ facsimile group 3 or facsimile group 3 only; ‑ both mobile originated and mobile terminated calls are supported; ‑ different end‑to‑end message speeds as per CCITT Recommendation T.30 may be used within the same connection to match the appropriate quality requirements; ‑ use of the standard synchronous terminal adaptation function for non‑transparent network support (as per GSM 07.03) within the MS is envisaged.