SIST ES 201 915-5 V1.4.1:2005

Open Service Access (OSA); Application Programming Interface (API); Part 5: User Interaction SCF (Parlay 3)

Maintenance update of ES 201 915-5 v.1.3.1.  Updated document will also be known as Parlay 3.3.  Only those parts requiring modification will be updated ( most parts require maintenance fixes )

Odprti dostop do storitve (OSA) – Vmesnik za aplikacijsko programiranje (API) – 5. del: Medsebojno vplivanje porabnikov SCF

General Information

• Status: Published
• Publication Date: 31-Dec-2004
• ICS: 33.040.01 - Telecommunication systems in general
• Technical Committee: SPN - Services and Protocols for Networks
• Current Stage: 6060 - National Implementation/Publication (Adopted Project)
• Start Date: 01-Jan-2005
• Due Date: 01-Jan-2005
• Completion Date: 01-Jan-2005
• Ref Project: ETSI ES 201 915-5 V1.4.1 (2003-07) - Open Service Access (OSA); Application Programming Interface (API); Part 5: User Interaction SCF (Parlay 3)

Standards Content (Sample)

SLOVENSKI STANDARD
SIST ES 201 915-5 V1.4.1:2005
01-januar-2005
Odprti dostop do storitve (OSA) – Vmesnik za aplikacijsko programiranje (API) – 5.
del: Medsebojno vplivanje porabnikov SCF
Open Service Access (OSA); Application Programming Interface (API); Part 5: User
Interaction SCF (Parlay 3)
Ta slovenski standard je istoveten z: ES 201 915-5 Version 1.4.1
ICS:
33.040.01 Telekomunikacijski sistemi Telecommunication systems
na splošno in general
SIST ES 201 915-5 V1.4.1:2005 en
2003-01.Slovenski inštitut za standardizacijo. Razmnoževanje celote ali delov tega standarda ni dovoljeno.

---------------------- Page: 1 ----------------------

SIST ES 201 915-5 V1.4.1:2005

---------------------- Page: 2 ----------------------

SIST ES 201 915-5 V1.4.1:2005

ETSI ES 201 915-5 V1.4.1 (2003-07)
ETSI Standard


Open Service Access (OSA);
Application Programming Interface (API);
Part 5: User Interaction SCF
(Parlay 3)



�

---------------------- Page: 3 ----------------------

SIST ES 201 915-5 V1.4.1:2005
 2 ETSI ES 201 915-5 V1.4.1 (2003-07)



Reference
RES/SPAN-120095-5
Keywords
API, OSA, IDL, UML
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE

Tel.: [phone]  Fax: [phone]

Siret N° 348 623 562 00017 - NAF 742 C
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88

Important notice
Individual copies of the present document can be downloaded from:
http://www.etsi.org
The present document may be made available in more than one electronic version or in print. In any case of existing or
perceived difference in contents between such versions, the reference version is the Portable Document Format (PDF).
In case of dispute, the reference shall be the printing on ETSI printers of the PDF version kept on a specific network drive
within ETSI Secretariat.
Users of the present document should be aware that the document may be subject to revision or change of status.
Information on the current status of this and other ETSI documents is available at
http://portal.etsi.org/tb/status/status.asp
If you find errors in the present document, send your comment to:
[e-mail]
Copyright Notification
No part may be reproduced except as authorized by written permission.
The copyright and the foregoing restriction extend to reproduction in all media.

© European Telecommunications Standards Institute 2003.
© The Parlay Group 2003.
All rights reserved.

TM TM TM
DECT , PLUGTESTS and UMTS are Trade Marks of ETSI registered for the benefit of its Members.
TM
TIPHON and the TIPHON logo are Trade Marks currently being registered by ETSI for the benefit of its Members.
TM
3GPP is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners.
ETSI

---------------------- Page: 4 ----------------------

SIST ES 201 915-5 V1.4.1:2005
 3 ETSI ES 201 915-5 V1.4.1 (2003-07)
Contents
Intellectual Property Rights.5
Foreword.5
1 Scope.6
2 References.6
3 Definitions and abbreviations.6
3.1 Definitions.6
3.2 Abbreviations.6
4 Generic and Call User Interaction SCF.6
4.1 General requirements on support of methods.8
5 Sequence Diagrams.8
5.1 Alarm Call.8
5.2 Call Barring 1 .10
5.3 Prepaid.11
5.4 Pre-Paid with Advice of Charge (AoC).13
6 Class Diagrams.16
7 The Service Interface Specifications.17
7.1 Interface Specification Format .17
7.1.1 Interface Class.17
7.1.2 Method descriptions.17
7.1.3 Parameter descriptions.17
7.1.4 State Model.17
7.2 Base Interface.17
7.2.1 Interface Class IpInterface .17
7.3 Service Interfaces.18
7.3.1 Overview.18
7.4 Generic Service Interface .18
7.4.1 Interface Class IpService .18
8 Generic User Interaction Interface Classes .19
8.1 Interface Class IpUIManager .19
8.2 Interface Class IpAppUIManager.22
8.3 Interface Class IpUI.25
8.4 Interface Class IpAppUI.27
8.5 Interface Class IpUICall.29
8.6 Interface Class IpAppUICall .31
9 State Transition Diagrams.34
9.1 State Transition Diagrams for IpUIManager.34
9.1.1 Active State.34
9.1.2 Notification Terminated State.35
9.2 State Transition Diagrams for IpUI.35
9.2.1 Active State.35
9.2.2 Release Pending State.35
9.2.3 Finished State.35
9.3 State Transition Diagrams for IpUICall .36
9.3.1 Active State.36
9.3.2 Release Pending State.36
9.3.3 Finished State.37
10 Service Properties.37
10.1 User Interaction Service Properties .37
11 Data Definitions.37
11.1 TpUIFault.37
ETSI

---------------------- Page: 5 ----------------------

SIST ES 201 915-5 V1.4.1:2005
 4 ETSI ES 201 915-5 V1.4.1 (2003-07)
11.2 IpUI.37
11.3 IpUIRef.38
11.4 IpAppUI.38
11.5 IpAppUIRef.38
11.6 IpAppUIManager.38
11.7 IpAppUIManagerRef.38
11.8 TpUICallIdentifier.38
11.9 TpUICollectCriteria.38
11.10 TpUIError.39
11.11 TpUIEventCriteria.39
11.12 TpUIEventCriteriaResultSet.40
11.13 TpUIEventCriteriaResult.40
11.14 TpUIEventInfo.40
11.15 TpUIEventInfoDataType.40
11.16 TpUIIdentifier.40
11.17 TpUIInfo.41
11.18 TpUIInfoType.41
11.19 TpUIMessageCriteria.41
11.20 TpUIReport.42
11.21 TpUIResponseRequest.42
11.22 TpUITargetObjectType.42
11.23 TpUITargetObject.42
11.24 TpUIVariableInfo.43
11.25 TpUIVariableInfoSet.43
11.26 TpUIVariablePartType.43
11.27 TpUIEventNotificationInfo.43
12 Exception Classes.44
Annex A (normative): OMG IDL Description of User Interaction SCF.45
Annex B (informative): Contents of 3GPP OSA R4 User Interaction.46
Annex C (informative): Record of changes .47
C.1 Interfaces.47
C.1.1 New.47
C.1.2 Deprecated.47
C.1.3 Removed.47
C.2 Methods.47
C.2.1 New.47
C.2.2 Deprecated.47
C.2.3 Modified.48
C.2.4 Removed.48
C.3 Data Definitions.48
C.3.1 New.48
C.3.2 Modified.48
C.3.3 Removed.48
C.4 Service Properties.48
C.4.1 New.48
C.4.2 Deprecated.49
C.4.3 Modified.49
C.4.4 Removed.49
C.5 Exceptions.49
C.5.1 New.49
C.5.2 Modified.49
C.5.3 Removed.49
C.6 Others.49
History .50
ETSI

---------------------- Page: 6 ----------------------

SIST ES 201 915-5 V1.4.1:2005
 5 ETSI ES 201 915-5 V1.4.1 (2003-07)

Intellectual Property Rights
IPRs essential or potentially essential to the present document may have been declared to ETSI. The information
pertaining to these essential IPRs, if any, is publicly available for ETSI members and non-members, and can be found
in ETSI SR 000 314: "Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to ETSI in
respect of ETSI standards", which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web
server (http://webapp.etsi.org/IPR/home.asp).
Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETSI. No guarantee
can be given as to the existence of other IPRs not referenced in ETSI SR 000 314 (or the updates on the ETSI Web
server) which are, or may be, or may become, essential to the present document.
Foreword
This ETSI Standard (ES) has been produced by ETSI Technical Committee Services and Protocols for Advanced
Networks (SPAN).
The present document is part 5 of a multi-part deliverable covering Open Service Access (OSA); Application
Programming Interface (API), as identified below. The API specification (ES 201 915) is structured in the following
parts:
Part 1: "Overview";
Part 2: "Common Data Definitions";
Part 3: "Framework";
Part 4: "Call Control SCF";
Part 5: "User Interaction SCF";
Part 6: "Mobility SCF";
Part 7: "Terminal Capabilities SCF";
Part 8: "Data Session Control SCF";
Part 9: "Generic Messaging SCF";
Part 10: "Connectivity Manager SCF";
Part 11: "Account Management SCF";
Part 12: "Charging SCF".
The present document has been defined jointly between ETSI, The Parlay Group (http://www.parlay.org) and the 3GPP,
in co-operation with a number of JAIN™ Community (http://www.java.sun.com/products/jain) member companies.
The present document forms part of the Parlay 3.3 set of specifications.
The present document is equivalent to 3GPP TS 29.198-5 V4.6.0 (Release 4).
ETSI

---------------------- Page: 7 ----------------------

SIST ES 201 915-5 V1.4.1:2005
 6 ETSI ES 201 915-5 V1.4.1 (2003-07)
1 Scope
The present document is part 5 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 present document specifies the User Interaction (UI) Service Capability Feature (SCF) aspects of the interface. All
aspects of the User Interaction 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).
2 References
The references listed in clause 2 of ES 201 915-1 contain provisions which, through reference in this text, constitute
provisions of the present document.
ETSI ES 201 915-1: "Open Service Access (OSA); Application Programming Interface (API); Part 1: Overview
(Parlay 3)".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in ES 201 915-1 apply.
3.2 Abbreviations
For the purposes of the present document, the abbreviations defined in ES 201 915-1 apply.
4 Generic and Call User Interaction SCF
The Generic User Interaction service capability feature is used by applications to interact with end users. It consists of
three interfaces:
1) User Interaction Manager, containing management functions for User Interaction related issues;
2) Generic User Interaction, containing methods to interact with an end-user.
3) Call User Interaction, containing methods to interact with an end-user engaged in a call.
ETSI

---------------------- Page: 8 ----------------------

SIST ES 201 915-5 V1.4.1:2005
 7 ETSI ES 201 915-5 V1.4.1 (2003-07)
The Generic User Interaction service capability feature is described in terms of the methods in the Generic User
Interaction interfaces.
Table 1 gives an overview of the Generic User Interaction methods and to which interfaces these methods belong.
Table 1: Overview of Generic User Interaction interfaces and their methods
User Interaction Manager Generic User Interaction
createUI sendInfoReq
createUICall sendInfoRes
createNotification sendInfoErr
destroyUINotification sendInfoAndCollectReq
reportNotification sendInfoAndCollectRes
userInteractionAborted sendInfoAndCollectErr
userInteractionNotificationInterrupted release
userInteractionNotificationContinued userInteractionFaultDetected
changeNotification
getNotification

Table 2 gives an overview of the Call User Interaction methods and to which interfaces these methods belong.
Table 2: Overview of Call User Interaction interfaces and their methods
User Interaction Manager Call User Interaction
As defined for the Generic User Interaction SCF Inherits from Generic User Interaction and adds:
recordMessageReq
recordMessageRes
recordMessageErr
deleteMessageReq
deleteMessageRes
deleteMessageErr
abortActionReq
abortActionRes
abortActionErr

The IpUI Interface provides functions to send information to, or gather information from the user, i.e. this interface
allows applications to send SMS and USSD messages. An application can use this interface independently of other
SCFs. The IpUICall Interface provides functions to send information to, or gather information from the user (or call
party) attached to a call.
The following clauses describe each aspect of the Generic User Interaction Service Capability Feature (SCF).
The order is as follows:
• The Sequence diagrams give the reader a practical idea of how each of the SCFs is implemented.
• The Class relationships clause show 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. This clause also includes Call User interaction.
• The State Transition Diagrams (STD) show the 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.
ETSI

---------------------- Page: 9 ----------------------

SIST ES 201 915-5 V1.4.1:2005
 8 ETSI ES 201 915-5 V1.4.1 (2003-07)
4.1 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 Sequence Diagrams
5.1 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.
ETSI

---------------------- Page: 10 ----------------------

SIST ES 201 915-5 V1.4.1:2005
 9 ETSI ES 201 915-5 V1.4.1 (2003-07)
: (Logical : IpAppCall : : : IpCall : IpUIManager : IpUICall
View::IpAppLogic) IpAppUICall IpCallControlManager
1: new()
2: createCall( )
3: new()
4: routeReq(    )
5: routeRes(  )
6: 'forward event'
7: createUICall( )
8: new()
9: sendInf oReq(   )
10: sendInfoRes(  )
11: 'f orward ev ent'
12: release( )
13: release( )

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) are 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.
ETSI

---------------------- Page: 11 ----------------------

SIST ES 201 915-5 V1.4.1:2005
 10 ETSI ES 201 915-5 V1.4.1 (2003-07)
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 UICa
...