ETSI TS V ( )

Transcription

1 TS V ( ) TECHNICAL SPECIFICATION Digital cellular telecommunications system (Phase 2+) (GS); Universal obile Telecommunications System (UTS); LTE; Telecommunication management; Configuration anagement (C); Bulk C Integration Reference Point (IRP); Solution Set (SS) definitions (3GPP TS version Release 14)

2 1 TS V ( ) Reference RTS/TSGS ve10 Keywords GS,LTE,UTS 650 Route des Lucioles F Sophia Antipolis Cedex - FRANCE Tel.: Fax: Siret N NAF 742 C Association à but non lucratif enregistrée à la Sous-Préfecture de Grasse (06) N 7803/88 Important notice The present document can be downloaded from: The present document may be made available in electronic versions and/or in print. The content of any electronic and/or print versions of the present document shall not be modified without the prior written authorization of. In case of any existing or perceived difference in contents between such versions and/or in print, the only prevailing document is the print of the Portable Document Format (PDF) version kept on a specific network drive within 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 documents is available at If you find errors in the present document, please send your comment to one of the following services: Copyright Notification No part may be reproduced or utilized in any form or by any means, electronic or mechanical, including photocopying and microfilm except as authorized by written permission of. The content of the PDF version shall not be modified without the written authorization of. The copyright and the foregoing restriction extend to reproduction in all media All rights reserved. DECT T, PLUGTESTS T, UTS T and the logo are trademarks of registered for the benefit of its embers. 3GPP T and LTE are trademarks of registered for the benefit of its embers and of the 3GPP Organizational Partners. one2 logo is protected for the benefit of its embers. GS and the GS logo are trademarks registered and owned by the GS Association.

3 2 TS V ( ) Intellectual Property Rights IPRs essential or potentially essential to the present document may have been declared to. The information pertaining to these essential IPRs, if any, is publicly available for members and non-members, and can be found in SR : "Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to in respect of standards", which is available from the Secretariat. Latest updates are available on the Web server ( Pursuant to the IPR Policy, no investigation, including IPR searches, has been carried out by. No guarantee can be given as to the existence of other IPRs not referenced in SR (or the updates on the Web server) which are, or may be, or may become, essential to the present document. Foreword This Technical Specification (TS) has been produced by 3rd Generation Partnership Project (3GPP). The present document may refer to technical specifications or reports using their 3GPP identities, UTS identities or GS identities. These should be interpreted as being references to the corresponding deliverables. The cross reference between GS, UTS, 3GPP and identities can be found under odal verbs terminology In the present document "shall", "shall not", "should", "should not", "may", "need not", "will", "will not", "can" and "cannot" are to be interpreted as described in clause 3.2 of the Drafting Rules (Verbal forms for the expression of provisions). "must" and "must not" are NOT allowed in deliverables except when used in direct citation.

4 3 TS V ( ) Contents Intellectual Property Rights... 2 Foreword... 2 odal verbs terminology... 2 Foreword... 6 Introduction Scope References Definitions and abbreviations Definitions Abbreviations Solution Set Definitions Annex A (normative): CORBA Solution Set A.1 Architectural features A.1.1 Syntax for Distinguished Names A.1.2 BulkCIRPNotifications Interface A ethod push () A.2 apping A.2.1 General mappings A.2.2 Operation and Notification mapping A.2.3 Operation parameter mapping A.2.4 Notification parameter mapping A.2.5 Two modes of operations A.2.6 apping from IS State Names to SS equivalents A.2.7 Package apping A.3 Solution Set definitions A.3.1 IDL definition structure A.3.2 IDL specification "BulkCmIRPConstDefs.idl" A.3.3 IDL specification "BulkCIRPSystem.idl" A.3.4 IDL specification "BulkCIRPNotifications.idl" Annex B (normative): XL Definitions B.1 Architectural Features B.1.1 Syntax for Distinguished Names B.2 Structure and content of configuration data XL files B.2.1 Global structure B.2.2 XL elements fileheader and filefooter B XL element fileheader B XL element filefooter B.2.3 XL element configdata B.2.4 NR-specific XL elements B NR-specific XL schemas B Generic mapping rules B.2.5 XL attribute specification modifier B.2.6 XL elements VsDataContainer, vsdata and vsdataformatversion B.3 Structure and content of session log XL files B.3.1 Global structure B.3.2 XL elements fileheader and filefooter B.3.3 XL element activity... 52

5 4 TS V ( ) B.4 Solution Set definitions B.4.1 XL definition structure B.4.2 Graphical Representation B.4.3 XL Schema configdata.xsd B.4.4 Example XL Schema NNRncHandOver.1.1.xsd B.4.5 XL Schema sessionlog.xsd B.4.6 XL Schema bulkcirpnotif.xsd Annex C (normative): SOAP Solution Set C.1 Architectural features C.1.1 Syntax for Distinguished Names C.1.2 Supported W3C specifications C.1.3 Prefixes and namespaces C.1.4 Filter language C.2 apping C.2.1 Operation and notification mapping C.2.2 Operation parameter mapping C Operation startsession C Input parameters C Output parameters C Fault definition C Operation endsession C Input parameters C Output parameters C Fault definition C Operation abortsessionoperation C Input parameters C Output parameters C Fault definition C Operation getsessionids C Input parameters C Output parameters C Fault definition C Operation getsessionstatus C Input parameters C Output parameters C Fault definition C Operation getsessionlog C Input parameters C Output parameters C Fault definition C Operation upload C Input parameters C Output parameters C Fault definition C Operation download C Input parameters C Output parameters C Fault definition C Operation validate C Input parameters C Output parameters C Fault definition C Operation preactivate C Input parameters C Output parameters C Fault definition C Operation activate C Input parameters C Output parameters... 73

6 5 TS V ( ) C C C C C Fault definition Operation fallback Input parameters Output parameters Fault definition C.3 Solution Set definitions C.3.1 WSDL definition structure C.3.2 Graphical Representation C.3.3 WSDL specification BulkCIRPSystem.wsdl Annex D (informative): Change history History... 86

7 6 TS V ( ) Foreword This Technical Specification has been produced by the 3 rd Generation Partnership Project (3GPP). The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: Version x.y.z where: x the first digit: 1 presented to TSG for information; 2 presented to TSG for approval; 3 or greater indicates TSG approved document under change control. y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. z the third digit is incremented when editorial only changes have been incorporated in the document. Introduction The present document is part of a TS-family covering the 3 rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Telecommunication management; as identified below: : "Configuration anagement (C); Bulk C Integration Reference Point (IRP): Requirements" : "Configuration anagement (C); Bulk C Integration Reference Point (IRP): Information Service (IS)" : "Configuration anagement (C); Bulk C Integration Reference Point (IRP): Solution Set (SS) definitions". Configuration anagement (C), in general, provides the operator with the ability to assure correct and effective operation of the 3G network as it evolves. C actions have the objective to control and monitor the actual configuration on the Network Element (NEs) and Network Resources (NRs), and they may be initiated by the operator or functions in the Operations Systems (OSs) or NEs. C actions may be requested as part of an implementation programme (e.g. additions and deletions), as part of an optimisation programme (e.g. modifications), and to maintain the overall Quality of Service. The C actions are initiated either as a single action on a NE of the 3G network or as part of a complex procedure involving actions on many NEs.

8 7 TS V ( ) 1 Scope The present document specifies the Solution Sets for the IRP whose semantics are specified in Bulk C IRP: Information Service (3GPP TS [9]). This Solution Set specification is related to 3GPP TS V14.0.X [9]. 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 GS 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 : "Telecommunication management; Principles and high level requirements". [2] 3GPP TS : "Telecommunication management; Architecture". [3] 3GPP TS : "Telecommunication management; Integration Reference Point (IRP) Concept and definitions". [4] 3GPP TS : "Telecommunication management; Configuration anagement (C); Name convention for anaged Objects". [5] 3GPP TS : "Telecommunication management; Configuration anagement (C); Notification Integration Reference Point (IRP): Solution Set (SS) definitions". [6] 3GPP TS : "Telecommunication management; Generic Integration Reference Point (IRP) management; Information Service (IS)". [7] 3GPP TS : "Telecommunication management; Generic Integration Reference Point (IRP) management: Solution Set (SS) definitions". [8] 3GPP TS : " Technical Specification Group Services and System Aspects; Telecommunication management; Configuration anagement (C); Bulk C Integration Reference Point (IRP): Requirements ". [9] 3GPP TS : "Telecommunication management; Configuration anagement (C); Bulk C Integration Reference Point (IRP); Information Service (IS)". [10] 3GPP TS : "Telecommunication management; Configuration anagement (C); Generic network resources Integration Reference Point (IRP): Network Resource odel (NR)". [11] 3GPP TS : "Telecommunication management; Configuration anagement (C); Generic network resources Integration Reference Point (IRP): Solution Set (SS) definitions". [12] 3GPP TS : "Telecommunication management; Configuration anagement (C); CN network resources Integration Reference Point (IRP): Network Resource odel (NR)". [13] 3GPP TS : "Telecommunication management; Configuration anagement (C); Core network resources Integration Reference Point (IRP): Solution Set (SS) definitions". [14] 3GPP TS : "Telecommunication management; Configuration anagement (C); UTRAN network resources Integration Reference Point (IRP): Network Resource odel (NR)".

9 8 TS V ( ) [15] 3GPP TS : "Telecommunication management; Configuration anagement (C); UTRAN network resources Integration Reference Point (IRP): Solution Set (SS) definitions". [16] 3GPP TS : "Telecommunication management; Configuration anagement (C); GERAN network resources Integration Reference Point (IRP): Network Resource odel (NR)". [17] 3GPP TS : "Telecommunication management; Configuration anagement (C); GERAN network resources Integration Reference Point (IRP): Solution Set (SS) definitions". [18] 3GPP TS "Inventory anagement (I) network resources Integration Reference Point (IRP): Network Resource odel (NR)". [19] 3GPP TS : "Telecommunication management; Inventory anagement (I) Network Resource odel (NR); Integration Reference Point (IRP): Solution Set (SS) definitions". [20] 3GPP TS : "Telecommunication management; Configuration anagement (C); Transport Network (TN) interface Network Resource odel (NR) Integration Reference Point (IRP): Solution Set (SS) definitions". [21] 3GPP TS : "IP ultimedia Subsystem (IS) Network Resource odel (NR) Integration Reference Point (IRP): Solution Set (SS) definitions". [22] 3GPP TS : "Telecommunication management; Configuration anagement (C); Signalling Transport Network (STN) Interface Network Resource odel (NR) Integration Reference Point (IRP): Information Service (IS)". [23] 3GPP TS : "Telecommunication management; Configuration anagement (C); Signalling Transport Network (STN) Interface Network Resource odel (NR) Integration Reference Point (IRP): Solution Set (SS) definitions". [24] 3GPP TS : " Telecommunication management; Evolved Packet Core (EPC) Network Resource odel (NR) Integration Reference Point (IRP): Solution Set (SS) definitions". [25] 3GPP TS : "Telecommunication management; Evolved Universal Terrestrial Radio Access Network (E UTRAN) Network Resource odel (NR) Integration Reference Point (IRP): Solution Set (SS) definitions". [26] OG Notification Service, Version 1.0. [27] W3C REC-xml : "Extensible arkup Language (XL) 1.0 (Second Edition)". [28] W3C REC-xmlschema : "XL Schema Part 0: Primer". [29] W3C REC-xmlschema : "XL Schema Part 1: Structures". [30] W3C REC-xmlschema : "XL Schema Part 2: Datatypes". [31] W3C REC-xml-names : "Namespaces in XL". [32] W3C SOAP 1.1 specification ( [33] W3C XPath 1.0 specification ( [34] W3C WSDL 1.1 specification ( [35] W3C SOAP 1.2 specification ( [36] 3GPP TS : "Telecommunication management; Subscription anagement (Su) Network Resource odel (NR) Integration Reference Point (IRP): Information Service (IS)". [37] 3GPP TS : "Telecommunication management; Subscription anagement (Su) Network Resource odel (NR) Integration Reference Point (IRP): Solution Set (SS) definitions". [38] 3GPP TS : "Telecommunication management; Self-Organizing Networks (SON) Policy Network Resource odel (NR) Integration Reference Point (IRP): Information Service (IS)".

10 9 TS V ( ) [39] 3GPP TS : "Telecommunication management; Self-Organizing Networks (SON) Policy Network Resource odel (NR) Integration Reference Point (IRP): Solution Set (SS) definitions". [40] 3GPP TS : "Telecommunication management; Configuration anagement (C); Transport Network (TN) Network Resource odel (NR) Integration Reference Point (IRP): Information Service (IS)". [41] 3GPP TS : "Telecommunication management; Configuration anagement (C); Repeater network resources Integration Reference Point (IRP); information Service (IS)". [42] 3GPP TS : "Telecommunication management; Configuration anagement (C); Repeater network resources Integration Reference Point (IRP): Solution Set (SS) definitions". [43] 3GPP TS : "Telecommunication management; IP ultimedia Subsystem (IS) Network Resource odel (NR) Integration Reference Point (IRP): Information Service (IS)". [44] 3GPP TS : "Telecommunication management; Evolved Packet Core (EPC) Network Resource odel (NR) Integration Reference Point (IRP): Information Service (IS)". [45] 3GPP TS : "Telecommunication management; Evolved Universal Terrestrial Radio Access Network (E UTRAN) Network Resource odel (NR) Integration Reference Point (IRP): Information Service (IS)". [46] 3GPP TS : "Telecommunication management; Home Node B (HNB) Subsystem (HNS); Network Resource odel (NR); Integration Reference Point (IRP): Information Service (IS)". [47] 3GPP TS : "Telecommunication management; Home Node B (HNB) Subsystem (HNS); Network Resource odel (NR); Integration Reference Point (IRP): Solution Set (SS) definitions". [48] 3GPP TS : "Telecommunication management; Home enhanced Node B (HeNB) Subsystem (HeNS); Network Resource odel (NR); Integration Reference Point (IRP): Information Service (IS)". [49] 3GPP TS : "Telecommunication management; Home enhanced Node B (HeNB) Subsystem (HeNS); Network Resource odel (NR); Integration Reference Point (IRP): Solution Set (SS) definitions". [50] 3GPP TS : "Telecommunication management; Generic Radio Access Network (RAN) Network Resource odel (NR) Integration Reference Point (IRP): Solution Set (SS) definitions".

11 10 TS V ( ) 3 Definitions and abbreviations 3.1 Definitions For terms and definitions please refer to TS [1], TS [2], TS [3], TS [36], TS [38], TS [8], TS [9], TS [10], TS [12], TS [14], TS [16], TS [18], TS [40], [41], TS [43], TS [22], TS [44], TS [45], TS [46] and TS [48]. For the purposes of the present document, the following terms and definitions apply. IRP document version number string (or "IRPVersion"): See 3GPP TS [6]. XL file: a file containing an XL document. XL document: see [27]; in the scope of this specification, an XL document is composed of the succession of an optional XL declaration followed by a root XL element. XL declaration: see [27]; it specifies the version of XL and the character encoding being used. XL element: see [27]; an XL element has a type, is identified by a name, may have a set of XL attribute specifications and is either composed of the succession of an XL start-tag followed by the XL content of the XL element followed by an XL end-tag, or composed simply of an XL empty-element tag; each XL element may contain other XL elements. empty XL element: see [27]; an XL element having an empty XL content; an empty XL element still possibly has a set of XL attribute specifications; an empty XL element is either composed of the succession of an XL start-tag directly followed by an XL end-tag, or composed simply of an XL empty-element tag. XL content (of an XL element): empty if the XL element is simply composed of an XL empty-element tag; otherwise the part, possibly empty, of the XL element between its XL start-tag and its XL end-tag. XL start-tag: see [27]; the beginning of a non-empty XL element is marked by an XL start-tag containing the name and the set of XL attribute specifications of the XL element. XL end-tag: see [27]; the end of a non-empty XL element is marked by an XL end-tag containing the name of the XL element. XL empty-element tag: see [27]; an empty XL element is composed simply of an empty-element tag containing the name and the set of XL attribute specifications of the XL element. XL attribute specification: see [27]; an XL attribute specification has a name and a value. DTD: see [27]; a DTD defines structure and content constraints to be respected by an XL document to be valid with regard to this DTD. XL schema: see [28], [29] and [30]; more powerful than a DTD, an XL schema defines structure and content constraints to be respected by an XL document to conform with this XL schema; through the use of XL namespaces several XL schemas can be used together by a single XL document; an XL schema is itself also an XL document that shall conform with the XL schema for XL schemas. XL namespace: see [31]; in the scope of this specification, enables qualifying element and attribute names used in XL documents by associating them with namespaces identified by different XL schemas. XL complex type: see [28], [29] and [30]; defined in an XL schema; cannot be directly used in an XL document; can be the concrete type or the derivation base type for an XL element type or for another XL complex type; ultimately defines constraints for an XL element on its XL attribute specifications and/or its XL content. XL element type: see [28], [29] and [30]; declared by an XL schema; can be directly used in an XL document; as the concrete type of an XL element, directly or indirectly defines constraints on its XL attribute specifications and/or its XL content; can also be the concrete type or the derivation base type for another XL element type.

12 11 TS V ( ) 3.2 Abbreviations For the purposes of the present document, the following abbreviations apply: CORBA C DN DTD EDGE GERAN GS IDL IRP IS O OC NR OG RDN SS UTS UTRAN WSDL XL Common Object Request Broker Architecture Configuration anagement Distinguished Name Document Type Definition Enhanced Data for GS Evolution GS/EDGE Radio Access Network Global System for obile communication Interface Definition Language (OG) Integration Reference Point Information Service anaged Object anaged Object Class Network Resource odel Object anagement Group Relative Distinguished Name Solution Set Universal obile Telecommunications System Universal Terrestrial Radio Access Network Web Service Description Language extensible arkup Language 4 Solution Set Definitions This specification defines the following 3GPP Bulk C IRP Solution Set Definitions: Annex A provides the CORBA Solution Set. Annex B provides the XL Definitions. Annex C provides the SOAP Solution Set.

13 12 TS V ( ) Annex A (normative): CORBA Solution Set This annex specifies the CORBA Solution Set for the IRP whose semantics are specified in 3GPP TS [9]. A.1 Architectural features The overall architectural feature of Bulk C IRP is specified in 3GPP TS [9]. This clause specifies features that are specific to the CORBA SS. A.1.1 Syntax for Distinguished Names The syntax of a Distinguished Name is defined in 3GPP TS [4]. A.1.2 BulkCIRPNotifications Interface OG CORBA Notification push operation is used to realise the notification of BulkCIRPNotifications. All the notifications in this interface are implemented using this push_structured_event method. A ethod push () module CosNotifyComm { Interface SequencePushConsumer : NotifyPublish { void push_structured_events( in CosNotification::EventBatch notifications) raises( CosEventComm::Disconnected); }; // SequencePushConsumer }; // CosNotifyComm NOTE 1: The push_structured_events method takes an input parameter of type EventBatch as defined in the OG CosNotification module (OG Notification Service [26]). This data type is the same as a sequence of Structured Events. Upon invocation, this parameter will contain a sequence of Structured Events being delivered to IRPanager by IRPAgent to which it is connected. NOTE 2: The maximum number of events that will be transmitted within a single invocation of this operation is controlled by IRPAgent wide configuration parameter. NOTE 3: The amount of time the supplier (IRPAgent) of a sequence of Structured Events will accumulate individual events into the sequence before invoking this operation is controlled by IRPAgent wide configuration parameter as well. NOTE 4: IRPAgent may push EventBatch with only one Structured Event.

14 13 TS V ( ) A.2 apping A.2.1 General mappings All Os are arranged in a containment structure, according to the containment relations defined in the NR. This structure is held internally by the IRPAgent. Externally, the O containment structure is defined by the semantics in the distinguished name syntax. The distinguished name (DN) for a O contains the distinguished name of the parent plus the Relative DN for the O itself. Associations as defined in the NR (UL) are in this document mapped to attributes in the IB. The names of the roles for an association in the NR are used for defining attribute names in the IB. When the cardinality for a role is 0..1 or 1..1 the datatype for the attribute is defined as a O reference. The value of a O reference contains the distinguished name of the referred O. When the cardinality for a role allows more than one referred O instances, the attribute will contain a sequence of O references (i.e., DNs). A.2.2 Operation and Notification mapping The IS part of Bulk C: IRP defines semantics of operations and notifications visible across the Bulk Configuration IRP. The table below indicates mapping of these operations and notifications to their equivalents defined in this document. There are 3 qualifications for each row of the following mapping table. The 3 qualifications correspond to the three IS-defined packages: Controlled Upload & Provisioning, Controlled Upload and Simple Upload. Not all operations/notifications specified in the following table are required for all 3 packages. An - indicates that the subject operation or notification is not allowed by that corresponding package.

15 14 TS V ( ) Table A.2.2: apping from I Notification/Operation to SS equivalents IS Operation/ notification SS ethod Qualifier startsession start_session,,- endsession end_session,,- upload upload,, download download,-,- activate activate,-,- getsessionstatus get_session_status,,- getsessionids get_session_ids,,- getsessionlog get_session_log,,- fallback fallback,-,- abortsessionoperation abort_session_operation,,- getirpversion notifysessionstatechanged notifygetsessionlogended get_bulk_cm_irp_versions get_controlled_upload_bulk_cm_irp_versions get_simple_upload_bulk_cm_irp_versions push_structured_event Note that OG Notification Service OG Notification Service [26] defines this method. See clause A.1.2. push_structured_event Note that OG Notification Service OG Notification Service [26] defines this method. See clause A.1.2.,-,- -,,- -,-,,, preactivate preactivate O,-,- validate validate O,-,- getoperationprofile get_bulk_cm_irp_operation_profile get_controlled_upload_bulk_cm_irp_operation_profile get_simple_upload_bulk_cm_irp_operation_profile O,-,- -,O,- -,-,O getnotificationprofile get_bulk_cm_irp_notification_profile get_controlled_upload_bulk_cm_irp_notification_profile get_simple_upload_bulk_cm_irp_notification_profile,,- O,-,- -,O,- -,-,O

16 15 TS V ( ) A.2.3 Operation parameter mapping Reference Bulk C IRP; Information Service [9] defines semantics of parameters carried in operations. The tables below indicate the mapping of these parameters, as per operation, to their equivalents defined in this SS. Table A.2.3.1: apping from IS startsession parameters to SS equivalents IS Operation parameter SS parameter Qualifier sessionid BulkCmIRPConstDefs::SessionId session_id status Exceptions: StartSessionException, SessionIdInUseException, axsessionreachedexception, anagedgenericirpsystem::invalidparameter Table A.2.3.2: apping from IS endsession parameters to SS equivalents IS Operation parameter SS ethod parameter Qualifier sessionid BulkCmIRPConstDefs::SessionId session_id status Exceptions: EndSessionException, UnknownSessionIdException, NotValidInCurrentStateException, anagedgenericirpsystem::invalidparameter Table A.2.3.3: apping from IS upload parameters to SS equivalents IS Operation parameter SS ethod parameter Qualifier sessionid BulkCmIRPConstDefs::SessionId session_id uploaddatafilereference BulkCmIRPConstDefs::FileDestination sink baseobjectinstance BulkCmIRPConstDefs::DistinguishedName base_object scope, filter BulkCmIRPConstDefs::SearchControl search_control status Exceptions: UploadException, UnknownSessionIdException, axsessionreachedexception, NotValidInCurrentStateException, ConcurrencyException, IllegalDNFormatException, IllegalFilterFormatException, IllegalScopeTypeException, IllegalScopeLevelException, IllegalURLFormatException, anagedgenericirpsystem::invalidparameter NOTE: The IllegalURLFormatException does not imply that the transfer protocol used must be a URL. The transfer protocol is dependant on the file format definition, i.e. in the case of XL, FileDestination will be a URL. Table A.2.3.4: apping from IS download parameters to SS equivalents IS Operation parameter SS ethod parameter Qualifier sessionid BulkCmIRPConstDefs::SessionId session_id downloaddatafilereference BulkCmIRPConstDefs::FileDestination source status Exceptions: DownloadException, UnknownSessionIdException, axsessionreachedexception, NotValidInCurrentStateException, IllegalURLFormatException, anagedgenericirpsystem::invalidparameter NOTE: The IllegalURLFormatException does not imply that the transfer protocol used must be a URL. The transfer protocol is dependant on the file format definition, i.e. in the case of XL, FileDestination will be a URL.

17 16 TS V ( ) Table A.2.3.5: apping from IS activate parameters to SS equivalents IS Operation parameter SS ethod parameter Qualifier sessionid BulkCmIRPConstDefs::SessionId session_id activationode BulkCmIRPConstDefs::ActivationodeTypeOpt activation_mode O fallbackenabled boolean fallback status Exceptions: ActivateException, UnknownSessionIdException, NotValidInCurrentStateException, ConcurrencyException, IllegalActivationodeException, anagedgenericirpsystem::parameternotsupported, anagedgenericirpsystem::invalidparameter Table A.2.3.6: apping from IS fallback parameters to SS equivalents IS Operation parameter SS ethod parameter Qualifier sessionid BulkCmIRPConstDefs::SessionId session_id status Exceptions: FallbackException, UnknownSessionIdException, NoFallbackException, NotValidInCurrentStateException, ConcurrencyException, anagedgenericirpsystem::invalidparameter Table A.2.3.7: apping from IS abortsessionoperation parameters to SS equivalents IS Operation parameter SS ethod parameter Qualifier sessionid BulkCmIRPConstDefs::SessionId session_id status Exceptions: AbortSessionOperationException, UnknownSessionIdException, NotValidInCurrentStateException, anagedgenericirpsystem::invalidparameter Table A.2.3.8: apping from IS getsessionids parameters to SS equivalents IS Operation parameter SS ethod parameter Qualifier sessionidlist Return value of type BulkCmIRPConstDefs::SessionIdList status Exceptions: GetSessionIdsException, anagedgenericirpsystem::invalidparameter Table A.2.3.9: apping from IS getsessionstatus parameters to SS equivalents IS Operation parameter SS ethod parameter Qualifier sessionid BulkCmIRPConstDefs::SessionId session_id sessionstate Return value of type BulkCmIRPConstDefs::SessionState Not specified in IS BulkCmIRPConstDefs::ErrorInformation error_information status Exceptions: GetSessionStatusException, UnknownSessionIdException, anagedgenericirpsystem::invalidparameter Table A : apping from IS getsessionlog parameters to SS equivalents IS Operation parameter SS ethod parameter Qualifier sessionid BulkCmIRPConstDefs::SessionId session_id

18 17 TS V ( ) IS Operation parameter SS ethod parameter Qualifier logfilereference BulkCmIRPConstDefs::FileDestination sink contenttype boolean only_error_info status Exceptions: GetSessionLogException, UnknownSessionIdException, IllegalURLFormatException, anagedgenericirpsystem::invalidparameter NOTE: The IllegalURLFormatException does not imply that the transfer protocol used must be a URL. The transfer protocol is dependant on the file format definition, i.e. in the case of XL, FileDestination will be a URL. Table A : apping from IS getbulkcmirpversion parameters to SS equivalents IS Operation parameter SS ethod parameter Qualifier versionnumberlist Return value of type anagedgenericirpconstdefs::versionnumberset status Exceptions: GetBulkCmIRPVersionsException Table A : apping from IS validate parameters to SS equivalents IS Operation parameter SS ethod parameter Qualifier sessionid BulkCmIRPConstDefs::SessionId session_id activationode BulkCmIRPConstDefs::ActivationodeTypeOpt activation_mode O status Exceptions: ValidateException, UnknownSessionIdException, NotValidInCurrentStateException, ConcurrencyException, IllegalActivationodeException, anagedgenericirpsystem::parameternotsupported, anagedgenericirpsystem::invalidparameter, anagedgenericirpsystem::operationnotsupported Table A : apping from IS preactivate parameters to SS equivalents IS Operation parameter SS ethod parameter Qualifier sessionid BulkCmIRPConstDefs::SessionId session_id verificationode BulkCmIRPConstDefs::VerificationodeTypeOpt O verification_mode activationode BulkCmIRPConstDefs::ActivationodeTypeOpt activation_mode O fallbackenabled boolean fallback status Exceptions: PreactivateException, UnknownSessionIdException, NotValidInCurrentStateException, ConcurrencyException, IllegalActivationodeException, IllegalVerificationodeException, anagedgenericirpsystem::parameternotsupported, anagedgenericirpsystem::invalidparameter, anagedgenericirpsystem::operationnotsupported Table A : apping from IS getoperationprofile parameters to SS equivalents IS Operation parameter SS ethod parameter Qualifier irpversion anagedgenericirpconstdefs::versionnumber bulk_cm_irp_version operationnameprofile, operationparameterprofile Return value of type anagedgenericirpconstdefs::ethodlist

19 18 TS V ( ) IS Operation parameter SS ethod parameter Qualifier status Exceptions: GetBulkCIRPOperationProfileException, anagedgenericirpsystem::operationnotsupported, anagedgenericirpsystem::invalidparameter Table A : apping from IS getnotificationprofile parameters to SS equivalents IS Operation parameter SS ethod parameter Qualifier irpversion anagedgenericirpconstdefs::versionnumber bulk_cm_irp_version notificationnameprofile, Return value of type notificationparameterprofile anagedgenericirpconstdefs::ethodlist status Exceptions: GetBulkCIRPNotificationProfileException, anagedgenericirpsystem::operationnotsupported, anagedgenericirpsystem::invalidparameter

20 19 TS V ( ) A.2.4 Notification parameter mapping Reference 3GPP TS [9] defines semantics of parameters carried in notifications. The following tables indicate the mapping of these parameters to their OG CORBA Structured Event (defined in OG Notification Service [26]) equivalents. The composition of OG Structured Event, as defined in the OG Notification Service [26], is: Header Fixed Header domain_name type_name event_name Variable Header Body filterable_body_fields remaining_body The following tables list all OG Structured Event attributes in the second column. The first column identifies the Bulk C IRP: IS [9] defined notification parameters. Table A.2.4.1: apping from IS notifygetsessionlogended parameters to SS equivalents

21 20 TS V ( ) IS Parameter There is no corresponding IS attribute. OG CORBA Structured Event Attribute Qualifie r Comment domain_name It carries the IRP document version number string. See 3GPP TS [6]. It indicates the syntax and semantics of the Structured Event as defined by this specification. notificationtype type_name It carries the string NOTIFY_GET_SESSION_LOG_ENDED. sessionlogstatus event_name It carries either the string GET_SESSION_LOG_COPLETED_SUCCESSFULLY or GET_SESSION_LOG_COPLETED_UNSUCCESSFULLY. In the case of the latter, the NV pair indicating ERROR_INFORATION may be present. There is no corresponding IS attribute. Variable Header managedobjectclass, managedobjectinstanc e One NV pair of filterable_body_field s NV stands for name-value pair. Order arrangement of NV pairs is not significant. The name of NV-pair is always encoded in string. Name of NV pair is the ANAGED_OBJECT_INSTANCE of interface AttributeNameValue of module NotificationIRPConstDefs. Value of NV pair is a string. See encoding of this string in [4]. These are attributes of Header defined in the IS. notificationid One NV pair of remaining_body Name of NV pair is the NOTIFICATION_ID of interface AttributeNameValue of module NotificationIRPConstDefs. Value of NV pair is a long. This is an attribute of Header defined in the IS. eventtime One NV pair of filterable_body_field s Name of NV pair is the EVENT_TIE of interface AttributeNameValue of module NotificationIRPConstDefs. Value of NV pair is a IRPTime. This is an attribute of Header of the IS. systemdn One NV pair of filterable_body_field s Name of NV pair is the SYSTE_DN of interface AttributeNameValue of module NotificationIRPConstDefs. Value of NV pair is a string. This is an attribute of Header defined in the IS. sessionid One NV pair of remaining_body Name of NV pair is the SESSION_ID of interface NotifyGetSessionLogEnded of module BulkCIRPNotifications. Value of NV pair is a string. sourceindicator One NV pair of remaining_body O Name of NV pair is the SOURCE_INDICATOR of interface NotifyGetSessionLogEnded of module BulkCIRPNotifications. Value of NV pair is a string. There is no corresponding IS attribute. One NV pair of remaining_body Name of NV pair is the ERROR_INFORATION of interface NotifyGetSessionLogEnded of module BulkCIRPNotifications. Value of NV pair is a string.

22 21 TS V ( ) Table A.2.4.2: apping from IS notifysessionstatechanged parameters to SS equivalents

23 22 TS V ( ) IS Parameter There is no corresponding IS attribute. OG CORBA Structured Event attribute Qualifier Comment domain_name It carries the IRP document version number string. See 3GPP TS [6]. It indicates the syntax and semantics of the Structured Event as defined by this specification. notificationtype type_name It carries the string NOTIFY_SESSION_STATE_CHANGED. This is an attribute of Header defined in the IS. sessionstate event_name It carries one of the following: UPLOAD_FAILED, UPLOAD_COPLETED, DOWNLOAD_FAILED, DOWNLOAD_COPLETED, ACTIVATION_FAILED, ACTIVATION_PARTLY_REALISED, ACTIVATION_COPLETED, FALLBACK_FAILED, FALLBACK_PARTLY_REALISED, FALLBACK_COPLETED, VALIDATION_FAILED, VALIDATION_COPLETED, PREACTIVATION_FAILED, PREACTIVATION_PARTLY_REALISED, PREACTIVATION_COPLETED. In the case of XXX_FAILED and XXX_PARTLY_REALISED, the NV pair indicating ERROR_INFORATION may be present. There is no corresponding IS attribute. Variable Header managedobjectclass, managedobjectinstance One NV pair of filterable_body_fields NV stands for name-value pair. Order arrangement of NV pairs is not significant. The name of NV-pair is always encoded in string. Name of NV pair is the ANAGED_OBJECT_INSTANCE of interface AttributeNameValue of module NotificationIRPConstDefs. Value of NV pair is a string. See encoding of this string in [4]. These are attributes of Header defined in the IS. notificationid One NV pair of remaining_body Name of NV pair is the NOTIFICATION_ID of interface AttributeNameValue of module NotificationIRPConstDefs. Value of NV pair is a long. This is an attribute of Header defined in the IS. eventtime One NV pair of filterable_body_fields Name of NV pair is the EVENT_TIE of interface AttributeNameValue of module NotificationIRPConstDefs. Value of NV pair is a IRPTime. This is an attribute of Header of the IS.

24 23 TS V ( ) IS Parameter OG CORBA Structured Event attribute Qualifier Comment systemdn One NV pair of filterable_body_fields Name of NV pair is the SYSTE_DN of interface AttributeNameValue of module NotificationIRPConstDefs. Value of NV pair is a string. This is an attribute of Header defined in the IS. Name of NV pair is the SESSION_ID of interface NotifySessionStateChange of module BulkCIRPNotifications. sessionid One NV pair of remaining_body Value of NV pair is a string. Name of NV pair is the SOURCE_INDICATOR of interface NotifySessionStateChange of module BulkCIRPNotifications. sourceindicator One NV pair of remaining_body O Value of NV pair is a string. Name of NV pair is the ERROR_INFORATION of interface NotifySessionStateChange of module BulkCIRPNotifications. There is no corresponding IS attribute. One NV pair of remaining _body Value of NV pair is a string. A.2.5 Two modes of operations The upload, download, validate, preactivate, activate, get_session_log, and fallback are methods that use asynchronous mode of operation. The IRPanager uses the methods to request a task to be done. The IRPAgent, via the method return, indicates that it has understood the request and has begun to perform the task requested. When the IRPAgent has completed the requested task, either successfully or not, the IRPAgent will emit a notification, e.g., notifysessionstatechanged() defined in IS level and mapped to push() in SS level, to indicate the completion status of the requested task. If the IRPanager has subscribed (e.g., via the attach_push() of Notification IRP) for notifications, then the IRPanager will receive the notification. The start_session, end_session, abort_session_operation, get_session_status, get_session_ids, get_bulk_c_irp_operation_profile, get_bulk_c_irp_notification_profile and get_bulkc_irp_version are methods that use synchronous mode of operation. The IRPanager uses these methods to request some information or a task to be done. The IRPAgent performs the requested task and, via the method return, indicates the requested information or if the requested task has completed successfully or not.

25 24 TS V ( ) A.2.6 apping from IS State Names to SS equivalents State names, as defined in the IS part of Bulk C, consists of two sub-parts in this SS, namely SubPhase and SubState. The table below shows the mapping between these substates and the IS state name. All combinations of SubPhase and SubState not described below are considered invalid. Table A.2.6: apping from IS State Names to SS equivalents IS State Name SS SubPhase SS SubState IDLE IDLE_PHASE COPLETED UPLOAD_FAILED UPLOAD_PHASE FAILED UPLOAD_IN_PROGRESS UPLOAD_PHASE IN_PROGRESS UPLOAD_COPLETED UPLOAD_PHASE COPLETED DOWNLOAD_FAILED DOWNLOAD_PHASE FAILED DOWNLOAD_IN_PROGRESS DOWNLOAD_PHASE IN_PROGRESS DOWNLOAD_COPLETED DOWNLOAD_PHASE COPLETED ACTIVATION_FAILED ACTIVATION_PHASE FAILED ACTIVATION_IN_PROGRESS ACTIVATION_PHASE IN_PROGRESS ACTIVATION_COPLETED ACTIVATION_PHASE COPLETED ACTIVATION_PARTLY_COPLETED ACTIVATION_PHASE PARTLY_REALISED FALLBACK_FAILED FALLBACK_PHASE FAILED FALLBACK_IN_PROGRESS FALLBACK_PHASE IN_PROGRESS FALLBACK_COPLETED FALLBACK_PHASE COPLETED FALLBACK_PARTLY_COPLETED FALLBACK_PHASE PARTLY_REALISED VALIDATION_FAILED VALIDATION_PHASE FAILED VALIDATION_IN_PROGRESS VALIDATION_PHASE IN_PROGRESS VALIDATION_COPLETED VALIDATION_PHASE COPLETED PREACTIVATION_FAILED PREACTIVATION_PHASE FAILED PREACTIVATION_IN_PROGRESS PREACTIVATION_PHASE IN_PROGRESS PREACTIVATION_COPLETED PREACTIVATION_PHASE COPLETED PREACTIVATION_PARTLY_COPLETED PREACTIVATION_PHASE PARTLY_REALISED A.2.7 Package apping The Bulk C IRP: IS (3GPP TS [9]) clause 7 specifies packages of capabilities. The IS-defined packages are mapped into IDL module constructs. Specifically: The operations named in the IS-defined packages Simple Upload, Controlled Upload and Controlled Upload & Provisioning are mapped to methods in SimpleUploadBulkCIRSystem::SimpleUploadBulkCIRP, ControlledUploadBulkCIRPSystem::ControlledUploadBulkCIRP and BulkCmIRPSystem::BulkCmIRP respectively (see clause A.3.3). The notifications named in the IS-defined Simple Upload, Controlled Upload and Controlled Upload & Provisioning are mapped to SS Interfaces defined in IDL module BulkCIRPNotifications (see clause A.3.4).

26 25 TS V ( ) A.3 Solution Set definitions A.3.1 IDL definition structure Clause A.3.2 defines the constants and types used by the Bulk C IRP. Clause A.3.3 defines the operations which are performed by the Bulk C IRP agent. Clause A.3.4 defines the notifications which are emitted by the Bulk C IRP agent.

27 26 TS V ( ) A.3.2 IDL specification "BulkCmIRPConstDefs.idl" //File: BulkCmIRPConstDefs.idl #ifndef _BULK_C_IRP_CONST_DEFS_IDL_ #define _BULK_C_IRP_CONST_DEFS_IDL_ // This statement must appear after all include statements #pragma prefix "3gppsa5.org" ## odule: BulkCmIRPConstDefs This module contains type definitions for the Bulk C IRP ================================================================ module BulkCmIRPConstDefs { This block identifies the notification types defined by this Bulk C IRP version. This string is used in the second field of the Structured Event. interface NotificationType { const string NOTIFY_SESSION_STATE_CHANGED = "x1"; const string NOTIFY_GET_SESSION_LOG_ENDED = "x2"; }; This block assigns value for the name of the NV of the Structured Event. interface AttributeNameValue { const string SESSION_ID = "k"; const string SOURCE_INDICATOR = "m"; const string ERROR_INFORATION = "n"; }; This block defines all possible values for sessionstate. One of these strings appear in the event_name of the Structured Event of notifysessionstatechanged notification. interface SessionStateChangeNotification { const string UPLOAD_FAILED = "x1"; const string UPLOAD_COPLETED = "x2"; const string DOWNLOAD_FAILED = "x3"; const string DOWNLOAD_COPLETED = "x4"; const string ACTIVATION_FAILED = "x5"; const string ACTIVATION_PARTLY_REALISED = "x6"; const string ACTIVATION_COPLETED = "x7"; const string FALLBACK_FAILED = "x8"; const string FALLBACK_PARTLY_REALISED = "x9"; const string FALLBACK_COPLETED = "x10"; const string VALIDATION_FAILED = "x11"; const string VALIDATION_COPLETED = "x12"; const string PREACTIVATION_FAILED = "x13"; const string PREACTIVATION_PARTLY_REALISED = "x14"; const string PREACTIVATION_COPLETED = "x15"; }; This block defines all possible values for sessionlogstatus One of these strings appear in the event_name of the Structured Event of notifygetsessionlogended notification. interface LogStateNotification { const string GET_SESSION_LOG_COPLETED_SUCCESSFULLY = "x1"; const string GET_SESSION_LOG_COPLETED_UNSUCESSFULLY = "x2"; }; For each started configuration session a unique identifier is generated by the IRPanager. An sessionid can not be used for an upload if it is already in use of a download configuration and vice versa.

28 27 TS V ( ) typedef string SessionId; This string field is used in order to provide additional error information if an operation has failed. typedef string ErrorInformation; Defines the different subphases of a configuration session e.g. thus it is easy to implement a detection of an upload or a download/activate session. enum SubPhase {IDLE_PHASE, DOWNLOAD_PHASE, UPLOAD_PHASE, ACTIVATION_PHASE, FALLBACK_PHASE, PREACTIVATION_PHASE, VALIDATION_PHASE}; Defines the different substates of a configuration session. This includes the transition state as well. enum SubState {COPLETED, FAILED, PARTLY_REALISED, IN_PROGRESS}; Defines state of a configuration session with the phase and the substate of the configuration. struct SessionState { SubPhase sub_phase; SubState sub_state; }; Contains the list of all current sessionids typedef sequence <SessionId> SessionIdList; Specifies a complete destination path (including filename). typedef string FileDestination; The format of Distinguished Name is specified in the Naming Conventions for anaged Objects; TS e.g. "SubNetwork=10001,anagedElement=400001" identifies a anagedelement instance of the object model. typedef string DistinguishedName; Used within the upload method to give filter critera typedef string Filter; Defines the kind of scope to use in a search together with SearchControl.level, in a SearchControl value. SearchControl.level is always >= 0. If a level is bigger than the depth of the tree there will be no exceptions thrown. enum ScopeType {BASE_ONLY, BASE_NTH_LEVEL, BASE_SUBTREE, BASE_ALL}; Controls the searching for Os during upload, and contains: the type of scope ("type" field), the level of scope ("level" field), the filter ("filter_" field), The type and level fields are mandatory. The filter field is mandatory (The filter will have to be set to an empty string if it has no other value). struct SearchControl { ScopeType type; unsigned long level; Filter filter_; };

29 28 TS V ( ) This indicates how the activation is executed, either with least service impact or least elapsed time. enum Activationode {LEAST_SERVICE_IPACT, LEAST_ELAPSED_TIE}; This indicates the level of verification of bulk configuration data done, either full or limited checking. enum Verificationode {FULL_CHECKING, LIITED_CHECKING}; ActivationodeTypeOpt is a type carrying an optional parameter. If the boolean is TRUE, the value is present. Otherwise, the value is absent. union ActivationodeTypeOpt switch(boolean) { case TRUE: Activationode activation_mode; }; VerificationodeTypeOpt is a type carrying an optional parameter. If the boolean is TRUE, the value is present. Otherwise, the value is absent. union VerificationodeTypeOpt switch(boolean) { case TRUE: Verificationode verification_mode; }; }; #endif // _BULK_C_IRP_CONST_DEFS_IDL_

30 29 TS V ( ) A.3.3 IDL specification "BulkCIRPSystem.idl" //File: BulkCIRPSystem.idl #ifndef _BULK_C_IRP_SYSTE_IDL_ #define _BULK_C_IRP_SYSTE_IDL_ #include <BulkCmIRPConstDefs.idl> #include <anagedgenericirpconstdefs.idl> #include <anagedgenericirpsystem.idl> // This statement must appear after all include statements #pragma prefix "3gppsa5.org" ## odule: BulkCmIRPSystem This module implements capabilities of Bulk C IRP. ================================================================ module BulkCmIRPSystem { The request cannot be processed due to a situation of concurrency. E.g. two concurrent activation requests involving the same anagedelement instance. The semantics carried in reason is outside the scope of this IRP. exception ConcurrencyException { string reason; }; The provided filter is malformed or invalid. The semantics carried in reason is outside the scope of this IRP. exception IllegalFilterFormatException { string reason; }; The provided Distinguished Name is malformed or invalid. The semantics carried in reason is outside the scope of this IRP. exception IllegalDNFormatException { string reason; }; The provided scope type is illegal. The semantics carried in reason is outside the scope of this IRP. exception IllegalScopeTypeException { string reason; }; The provided scope level is illegal. The semantics carried in reason is outside the scope of this IRP. exception IllegalScopeLevelException { string reason; }; The request cannot be processed because no fallback data is available, i.e. fallback capability was previously not asked for. exception NoFallbackException {}; The provided sessionid value is already used for another configuration session. The semantics carried in reason is outside the scope of this IRP. exception SessionIdInUseException { string reason; }; The provided URL is malformed or invalid. The semantics carried in reason is outside the scope of this IRP. exception IllegalURLFormatException{ string reason; }; The provided sessionid value does not identify any existing configuration session. exception UnknownSessionIdException {}; The request cannot be processed because it is not valid in the current state of the configuration session.

31 30 TS V ( ) exception NotValidInCurrentStateException { BulkCmIRPConstDefs::SessionState current_state; }; The request cannot be processed because the maximum number of simultaneously running configuration sessions has been reached. The semantics carried in reason is outside the scope of this IRP. exception axsessionreachedexception { string reason; }; The provided Activationode type is illegal. The semantics carried in reason is outside the scope of this IRP. exception IllegalActivationodeException { string reason; }; The provided Verificationode type is illegal. The semantics carried in reason is outside the scope of this IRP. exception IllegalVerificationodeException { string reason; }; System otherwise fails to complete the operation. System can provide reason to qualify the exception. The semantics carried in reason is outside the scope of this IRP. exception GetBulkCmIRPVersionsException { string reason; }; exception UploadException { string reason; }; exception DownloadException { string reason; }; exception ActivateException { string reason; }; exception ValidateException { string reason; }; exception PreactivateException { string reason; }; exception GetBulkCIRPOperationProfileException { string reason; }; exception GetBulkCIRPNotificationProfileException { string reason; }; exception GetSessionLogException { string reason; }; exception StartSessionException { string reason; }; exception GetSessionStatusException { string reason; }; exception FallbackException { string reason; }; exception EndSessionException { string reason; }; exception AbortSessionOperationException { string reason; }; exception GetSessionIdsException { string reason; }; Defines the System interface of a E. It defines all methods which are necessary to control a configuration session from a IRPanager. interface BulkCmIRP { Return the list of all supported Bulk C IRP versions. anagedgenericirpconstdefs::versionnumberset get_bulk_cm_irp_versions ( ) raises (GetBulkCmIRPVersionsException); Return the list of all supported operations and their supported parameters for a specific BulkC IRP version. anagedgenericirpconstdefs::ethodlist get_bulk_cm_irp_operation_profile ( in anagedgenericirpconstdefs::versionnumber bulk_cm_irp_version ) raises (GetBulkCIRPOperationProfileException, anagedgenericirpsystem::operationnotsupported, anagedgenericirpsystem::invalidparameter); Return the list of all supported notifications and their supported parameters for a specific BulkC IRP version. anagedgenericirpconstdefs::ethodlist get_bulk_cm_irp_notification_profile ( in anagedgenericirpconstdefs::versionnumber bulk_cm_irp_version

32 31 TS V ( ) ) raises (GetBulkCIRPNotificationProfileException, anagedgenericirpsystem::operationnotsupported, anagedgenericirpsystem::invalidparameter); Uploads a configuration from the subnetwork. The result is put in a configuration data file in an area specified by the IRPanager. The IB of the subnetwork is iterated by means of containment search, using a SearchControl to control the search and the returned results. All Os in the scope constitutes a set that the filter works on. In case of a concurrent running session the function will return an exception. If the value of the given baseobject or Filter does not exist then this asynchronous error condition will be notified. void upload ( in BulkCmIRPConstDefs::SessionId session_id, in BulkCmIRPConstDefs::FileDestination sink, in BulkCmIRPConstDefs::DistinguishedName base_object, in BulkCmIRPConstDefs::SearchControl search_control ) raises (UploadException, UnknownSessionIdException, axsessionreachedexception, NotValidInCurrentStateException, ConcurrencyException, IllegalDNFormatException, IllegalFilterFormatException, IllegalScopeTypeException, IllegalScopeLevelException, IllegalURLFormatException, anagedgenericirpsystem::invalidparameter); Indicates the E that it can download a configuration data file from a given configuration data file storage area. The E will check the consistence of the configuration data and the software compatibilty. void download ( in BulkCmIRPConstDefs::SessionId session_id, in BulkCmIRPConstDefs::FileDestination source ) raises (DownloadException, UnknownSessionIdException, axsessionreachedexception, NotValidInCurrentStateException, IllegalURLFormatException, anagedgenericirpsystem::invalidparameter); Activates a previously downloaded and sucessfully parsed configuration inside a session. This means that the configuration will be introduced in the live sub-network. In case of a concurrent running session the function will return an exception. void activate ( in BulkCmIRPConstDefs::SessionId session_id, in BulkCmIRPConstDefs::ActivationodeTypeOpt activation_mode, in boolean fallback ) raises (ActivateException, UnknownSessionIdException, NotValidInCurrentStateException, ConcurrencyException, IllegalActivationodeException, anagedgenericirpsystem::parameternotsupported, anagedgenericirpsystem::invalidparameter); Uploads a log from the subnetwork which is usally used for error analysis. The log is put in a logfile in the filesystem which can be accessed by the E. If there are no log entries an empty log file is uploaded. void get_session_log ( in BulkCmIRPConstDefs::FileDestination sink, in BulkCmIRPConstDefs::SessionId session_id, in boolean only_error_info ) raises (GetSessionLogException, UnknownSessionIdException, IllegalURLFormatException, anagedgenericirpsystem::invalidparameter); Creates an instance of the configuration session state machine. The IDLE_PHASE & COPLETED is notified

33 32 TS V ( ) void start_session ( in BulkCmIRPConstDefs::SessionId session_id ) raises (StartSessionException, SessionIdInUseException, axsessionreachedexception, anagedgenericirpsystem::invalidparameter); Returns the state of a configuration session. BulkCmIRPConstDefs::SessionState get_session_status ( in BulkCmIRPConstDefs::SessionId session_id, out BulkCmIRPConstDefs::ErrorInformation error_information ) raises (GetSessionStatusException, UnknownSessionIdException, anagedgenericirpsystem::invalidparameter); Actives a fallback area. Each time a configuration is activated a fallback area can be created, s. activate parameter. This area is backup of the complete configuration which can be restored by this method. The process is as follows: 1. When the method activate(...,..., TRUE) is used, a copy of the valid area is taken before the activation of the new planned data has started. Only one fallback area can exists at a time for a specific scope of the subnetwork. 2. When a fallback area is avilable and triggered by this method, the previous valid area is replaced with the data stored in the fall back area. If the E detects that the former configuration has never been changed it returns an exception because it does not trigger an activation of the former data. void fallback ( in BulkCmIRPConstDefs::SessionId session_id ) raises (FallbackException, UnknownSessionIdException, NoFallbackException, NotValidInCurrentStateException, ConcurrencyException, anagedgenericirpsystem::invalidparameter); The IRPanager invokes this operation to delete all its temporary entities and the related sessionid which belong to the scope of a configuration session. This includes the related error and log informationen too. void end_session ( in BulkCmIRPConstDefs::SessionId session_id ) raises (EndSessionException, UnknownSessionIdException, NotValidInCurrentStateException, anagedgenericirpsystem::invalidparameter); The IRPanager invokes this operation to abort an active operation during a configuration session. It is only effecting a configuration session in state IN_PROGRESS. In this case the current session task is interrupted, e.g. the activating in progress, using best effort strategy, and a state change is notified void abort_session_operation ( in BulkCmIRPConstDefs::SessionId session_id ) raises (AbortSessionOperationException, UnknownSessionIdException, NotValidInCurrentStateException, anagedgenericirpsystem::invalidparameter); Returns a list all sessionids of current running configuration sessions. BulkCmIRPConstDefs::SessionIdList get_session_ids ( ) raises (GetSessionIdsException); Validates previously downloaded bulk configuration data inside a session. Detects errors in the data prior to requesting preactivation or

34 33 TS V ( ) activation. void validate ( in BulkCmIRPConstDefs::SessionId session_id, in BulkCmIRPConstDefs::ActivationodeTypeOpt activation_mode ) raises (ValidateException, UnknownSessionIdException, NotValidInCurrentStateException, ConcurrencyException, IllegalActivationodeException, anagedgenericirpsystem::parameternotsupported, anagedgenericirpsystem::invalidparameter, anagedgenericirpsystem::operationnotsupported); Preactivates previously downloaded bulk configuration data inside a session. This operation validates configuration data changes in the context of the current data and pre-processes the configuration data changes. void preactivate ( in BulkCmIRPConstDefs::SessionId session_id, in BulkCmIRPConstDefs::VerificationodeTypeOpt verification_mode, in BulkCmIRPConstDefs::ActivationodeTypeOpt activation_mode, in boolean fallback ) raises (PreactivateException, UnknownSessionIdException, NotValidInCurrentStateException, ConcurrencyException, IllegalActivationodeException, IllegalVerificationodeException, anagedgenericirpsystem::parameternotsupported, anagedgenericirpsystem::invalidparameter, anagedgenericirpsystem::operationnotsupported); }; }; module SimpleUploadBulkCIRPSystem { exception GetSimpleUploadBulkCmIRPVersionsException { string reason; }; exception GetSimpleUploadBulkCIRPOperationProfileException { string reason; }; exception GetSimpleUploadBulkCIRPNotificationProfileException { string reason; }; interface SimpleUploadBulkCIRP { Return the list of all supported Bulk C IRP versions. anagedgenericirpconstdefs::versionnumberset get_simple_upload_bulk_cm_irp_versions ( ) raises (GetSimpleUploadBulkCmIRPVersionsException); Return the list of all supported operations and their supported parameters for a specific BulkC IRP version. anagedgenericirpconstdefs::ethodlist get_simple_upload_bulk_cm_irp_operation_profile ( in anagedgenericirpconstdefs::versionnumber bulk_cm_irp_version ) raises (GetSimpleUploadBulkCIRPOperationProfileException, anagedgenericirpsystem::operationnotsupported, anagedgenericirpsystem::invalidparameter); Return the list of all supported notifications and their supported parameters for a specific BulkC IRP version. anagedgenericirpconstdefs::ethodlist get_simple_upload_bulk_cm_irp_notification_profile ( in anagedgenericirpconstdefs::versionnumber bulk_cm_irp_version ) raises (GetSimpleUploadBulkCIRPNotificationProfileException, anagedgenericirpsystem::operationnotsupported, anagedgenericirpsystem::invalidparameter);

35 34 TS V ( ) }; Uploads a configuration from the subnetwork. The result is put in a configuration data file in an area specified by the IRPanager. The IB of the subnetwork is iterated by means of containment search, using a SearchControl to control the search and the returned results. All Os in the scope constitutes a set that the filter works on. In case of a concurrent running session the function will return an exception. If the value of the given baseobject or Filter does not exist then this asynchronous error condition will be notified. void upload ( in BulkCmIRPConstDefs::SessionId session_id, in BulkCmIRPConstDefs::FileDestination sink, in BulkCmIRPConstDefs::DistinguishedName base_object, in BulkCmIRPConstDefs::SearchControl search_control ) raises ( BulkCmIRPSystem::UploadException, BulkCmIRPSystem::UnknownSessionIdException, BulkCmIRPSystem::axSessionReachedException, BulkCmIRPSystem::NotValidInCurrentStateException, BulkCmIRPSystem::ConcurrencyException, BulkCmIRPSystem::IllegalDNFormatException, BulkCmIRPSystem::IllegalFilterFormatException, BulkCmIRPSystem::IllegalScopeTypeException, BulkCmIRPSystem::IllegalScopeLevelException, BulkCmIRPSystem::IllegalURLFormatException, anagedgenericirpsystem::invalidparameter); }; // end of module SimpleUploadBulkCIRPSystem module ControlledUploadBulkCIRPSystem { exception GetControlledUploadBulkCmIRPVersionsException { string reason; }; exception GetControlledUploadBulkCIRPOperationProfileException { string reason; }; exception GetControlledUploadBulkCIRPNotificationProfileException { string reason; }; interface ControlledUploadBulkCIRP { Return the list of all supported Bulk C IRP versions. anagedgenericirpconstdefs::versionnumberset get_controlled_upload_bulk_cm_irp_versions ( ) raises (GetControlledUploadBulkCmIRPVersionsException); Return the list of all supported operations and their supported parameters for a specific BulkC IRP version. anagedgenericirpconstdefs::ethodlist get_controlled_upload_bulk_cm_irp_operation_profile ( in anagedgenericirpconstdefs::versionnumber bulk_cm_irp_version ) raises (GetControlledUploadBulkCIRPOperationProfileException, anagedgenericirpsystem::operationnotsupported, anagedgenericirpsystem::invalidparameter); Return the list of all supported notifications and their supported parameters for a specific BulkC IRP version. anagedgenericirpconstdefs::ethodlist get_controlled_upload_bulk_cm_irp_notification_profile ( in anagedgenericirpconstdefs::versionnumber bulk_cm_irp_version ) raises (GetControlledUploadBulkCIRPNotificationProfileException, anagedgenericirpsystem::operationnotsupported, anagedgenericirpsystem::invalidparameter); Uploads a configuration from the subnetwork. The result is put in a configuration data file in an area specified by the IRPanager.

36 35 TS V ( ) The IB of the subnetwork is iterated by means of containment search, using a SearchControl to control the search and the returned results. All Os in the scope constitutes a set that the filter works on. In case of a concurrent running session the function will return an exception. If the value of the given baseobject or Filter does not exist then this asynchronous error condition will be notified. void upload ( in BulkCmIRPConstDefs::SessionId session_id, in BulkCmIRPConstDefs::FileDestination sink, in BulkCmIRPConstDefs::DistinguishedName base_object, in BulkCmIRPConstDefs::SearchControl search_control ) raises ( BulkCmIRPSystem::UploadException, BulkCmIRPSystem::UnknownSessionIdException, BulkCmIRPSystem::axSessionReachedException, BulkCmIRPSystem::NotValidInCurrentStateException, BulkCmIRPSystem::ConcurrencyException, BulkCmIRPSystem::IllegalDNFormatException, BulkCmIRPSystem::IllegalFilterFormatException, BulkCmIRPSystem::IllegalScopeTypeException, BulkCmIRPSystem::IllegalScopeLevelException, BulkCmIRPSystem::IllegalURLFormatException, anagedgenericirpsystem::invalidparameter); Uploads a log from the subnetwork which is usally used for error analysis. The log is put in a logfile in the filesystem which can be accessed by the E. If there are no log entries an empty log file is uploaded. void get_session_log ( in BulkCmIRPConstDefs::FileDestination sink, in BulkCmIRPConstDefs::SessionId session_id, in boolean only_error_info ) raises ( BulkCmIRPSystem::GetSessionLogException, BulkCmIRPSystem::UnknownSessionIdException, BulkCmIRPSystem::IllegalURLFormatException, anagedgenericirpsystem::invalidparameter); Creates an instance of the configuration session state machine. The IDLE_PHASE & COPLETED is notified void start_session ( in BulkCmIRPConstDefs::SessionId session_id ) raises ( BulkCmIRPSystem::StartSessionException, BulkCmIRPSystem::SessionIdInUseException, BulkCmIRPSystem::axSessionReachedException, anagedgenericirpsystem::invalidparameter); Returns the state of a configuration session. BulkCmIRPConstDefs::SessionState get_session_status ( in BulkCmIRPConstDefs::SessionId session_id, out BulkCmIRPConstDefs::ErrorInformation error_information ) raises ( BulkCmIRPSystem::GetSessionStatusException, BulkCmIRPSystem::UnknownSessionIdException, anagedgenericirpsystem::invalidparameter); The IRPanager invokes this operation to delete all its temporary entities and the related sessionid which belong to the scope of a configuration session. This includes the related error and log informationen too. void end_session ( in BulkCmIRPConstDefs::SessionId session_id ) raises (

37 36 TS V ( ) BulkCmIRPSystem::EndSessionException, BulkCmIRPSystem::UnknownSessionIdException, BulkCmIRPSystem::NotValidInCurrentStateException, anagedgenericirpsystem::invalidparameter); The IRPanager invokes this operation to abort an active operation during a configuration session. It is only effecting a configuration session in state IN_PROGRESS. In this case the current session task is interrupted, e.g. the activating in progress, using best effort strategy, and a state change is notified void abort_session_operation ( in BulkCmIRPConstDefs::SessionId session_id ) raises ( BulkCmIRPSystem::AbortSessionOperationException, BulkCmIRPSystem::UnknownSessionIdException, BulkCmIRPSystem::NotValidInCurrentStateException, anagedgenericirpsystem::invalidparameter); Returns a list all sessionids of current running configuration sessions. BulkCmIRPConstDefs::SessionIdList get_session_ids ( ) raises ( BulkCmIRPSystem::GetSessionIdsException); }; }; // end of module ControlledUploadBulkCIRPSystem #endif // _BULK_C_IRP_SYSTE_IDL_

38 37 TS V ( ) A.3.4 IDL specification "BulkCIRPNotifications.idl" //File: BulkCNotifications.idl #ifndef _BULK_C_IRP_NOTIFICATIONS_IDL_ #define _BULK_C_IRP_NOTIFICATIONS_IDL_ #include <NotificationIRPNotifications.idl> #include <BulkCmIRPConstDefs.idl> // This statement must appear after all include statements #pragma prefix "3gppsa5.org" module BulkCIRPNotifications { interface NotifySessionStateChange: NotificationIRPNotifications::Notify { // This is the type_name (2nd field) of the fixed header. const string EVENT_TYPE = BulkCmIRPConstDefs::NotificationType::NOTIFY_SESSION_STATE_CHANGED; // // One of the strings here is the event_name (3rd field) of the // fixed header. // The first 2 are relevant for IS-defined packages Simple // Upload and Controlled Upload. // All are relevant for IS-defined package // Controlled Upload & Provisioning. const string UPLOAD_FAILED = BulkCmIRPConstDefs:: SessionStateChangeNotification::UPLOAD_FAILED; const string UPLOAD_COPLETED = BulkCmIRPConstDefs:: SessionStateChangeNotification::UPLOAD_COPLETED; const string DOWNLOAD_FAILED = BulkCmIRPConstDefs:: SessionStateChangeNotification::DOWNLOAD_FAILED; const string DOWNLOAD_COPLETED = BulkCmIRPConstDefs:: SessionStateChangeNotification::DOWNLOAD_COPLETED; const string ACTIVATION_FAILED = BulkCmIRPConstDefs:: SessionStateChangeNotification::ACTIVATION_FAILED; const string ACTIVATION_PARTLY_REALISED = BulkCmIRPConstDefs:: SessionStateChangeNotification::ACTIVATION_PARTLY_REALISED; const string ACTIVATION_COPLETED = BulkCmIRPConstDefs:: SessionStateChangeNotification::ACTIVATION_COPLETED; const string FALLBACK_FAILED = BulkCmIRPConstDefs:: SessionStateChangeNotification::FALLBACK_FAILED; const string FALLBACK_PARTLY_REALISED = BulkCmIRPConstDefs:: SessionStateChangeNotification::FALLBACK_PARTLY_REALISED; const string FALLBACK_COPLETED = BulkCmIRPConstDefs:: SessionStateChangeNotification::FALLBACK_COPLETED; const string VALIDATION_FAILED = BulkCmIRPConstDefs:: SessionStateChangeNotification::VALIDATION_FAILED; const string VALIDATION_COPLETED = BulkCmIRPConstDefs:: SessionStateChangeNotification::VALIDATION_COPLETED; const string PREACTIVATION_FAILED = BulkCmIRPConstDefs:: SessionStateChangeNotification::PREACTIVATION_FAILED; const string PREACTIVATION_PARTLY_REALISED = BulkCmIRPConstDefs:: SessionStateChangeNotification::PREACTIVATION_PARTLY_REALISED; const string PREACTIVATION_COPLETED = BulkCmIRPConstDefs:: SessionStateChangeNotification::PREACTIVATION_COPLETED; // const string SESSION_ID = BulkCmIRPConstDefs::AttributeNameValue::SESSION_ID; }; const string SOURCE_INDICATOR = BulkCmIRPConstDefs::AttributeNameValue::SOURCE_INDICATOR; interface NotifyGetSessionLogEnded: NotificationIRPNotifications::Notify { // This is the type_name (2nd field) of the fixed header. const string EVENT_TYPE = BulkCmIRPConstDefs::NotificationType::NOTIFY_GET_SESSION_LOG_ENDED; // // One of the 2 strings here is the event_name (3rd field) of the // fixed header.

39 38 TS V ( ) const string GET_SESSION_LOG_COPLETED_SUCCESSFULLY = BulkCmIRPConstDefs::LogStateNotification:: GET_SESSION_LOG_COPLETED_SUCCESSFULLY; const string GET_SESSION_LOG_COPLETED_UNSUCESSFULLY = BulkCmIRPConstDefs::LogStateNotification:: GET_SESSION_LOG_COPLETED_UNSUCESSFULLY; // const string SESSION_ID = BulkCmIRPConstDefs::AttributeNameValue::SESSION_ID; }; const string SOURCE_INDICATOR = BulkCmIRPConstDefs::AttributeNameValue::SOURCE_INDICATOR; }; #endif // _BULK_C_IRP_NOTIFICATIONS_IDL_

40 39 TS V ( ) Annex B (normative): XL Definitions This annex contains the XL Definitions for the Bulk C Integration Reference Point. B.1 Architectural Features The overall architectural feature of Bulk C IRP is specified in 3G TS [9]. This clause specifies features that are specific to the XL definitions. The present document provides the main part of the XL file format definition for the Bulk Configuration anagement IRP IS in 3GPP TS [9]. The other parts of this XL definition are NR-specific parts. All NR IRPs that include SS-level XL definition are in the scope of the Bulk C IRP. Bulk C XL file formats are based on XL [27], XL Schema [28] [29] [30] and XL Namespace [31] standards. B.1.1 Syntax for Distinguished Names The syntax of a Distinguished Name is defined in 3GPP TS [4]. B.2 Structure and content of configuration data XL files The present clause defines the file format of configuration data XL files exchanged between an IRPanager and an IRPAgent as part of upload and download operations of the Bulk C IRP IS (see [9]). Upload and download configuration data XL files share a common file format defined by the XL schema in clause B.4.3 and by the following clauses. Additionally, vendor-specific XL schemas shall be provided to enable configuration data XL files to carry vendorspecific data (see clause B.2.6). The use of XL schemas enables to ensure configuration data XL files have the proper structure and to some extent the proper content, and in particular to ensure: - for a given NR instance, it is properly named/positioned with regard to the global NR naming tree; - for a given NR instance, only attributes of the corresponding NR class are present; - for a given NR attribute, its value is of the proper type. Location of the XL schemas used for configuration data XL files is outside the scope of this document. B.2.1 Global structure The content of a configuration data XL file is the succession of: - the standard XL declaration with specification of the version of XL and of the character encoding being used (see [27]); - a bulkcmconfigdatafile XL element; this is the root XL element of configuration data XL files. The definition of the allowed character encoding(s) is outside the scope of this document. As defined by the following extract of XL schema configdata.xsd (see clause B.4.3):

41 40 TS V ( ) <element name="bulkcmconfigdatafile"> <sequence> <element name="fileheader"> <element name="configdata" maxoccurs="unbounded"> <element name="filefooter"> </sequence> the XL content of a bulkcmconfigdatafile XL element is the succession of: - a fileheader XL element (see clause B.2.2); - one or several configdata XL elements (see clause B.2.3); - a filefooter XL element (see clause B.2.2). XL elements fileheader and filefooter are empty XL elements (see clause B.2.2). The bulkcmconfigdatafile XL element shall also have all the XL attribute specifications that declare the XL namespaces (see [31]) used in the XL file. The following XL namespaces are potentially used in configuration data XL files: - the default XL namespace is associated with the configuration data files base XL schema configdata.xsd (see clause B.4.3); - for each NR-specific XL schema, a specific XL namespace prefix is defined for the associated XL namespace (see clause B.2.4.1); - XL namespaces prefixes starting with vs, e.g. vsrho11, are reserved for the XL namespaces associated with the vendor-specific XL schemas (see clause B.2.6). Each configdata XL element (see clause B.2.3) carries: - NR instances with or without their NR attribute values in a NR naming tree organized structure together with modifier XL attribute specification (see clause B.2.5); - possibly vendor-specific data (see clause B.2.6). A configdata XL element can carry an entire tree of NR instances with their NR attribute values and the related vendor-specific data or any subset of it. The following is an example of a configuration data XL file, without presentation of the XL attribute specifications and XL content of fileheader, configdata and filefooter XL elements (replaced by ; see clauses B.2.2, B.2.3, B.2.5 and B.2.6): <?xml version="1.0" encoding="utf-8"?> <bulkcmconfigdatafile xmlns= " > <fileheader /> <configdata > </configdata> <configdata > </configdata> <filefooter /> </bulkcmconfigdatafile>

42 41 TS V ( ) B.2.2 XL elements fileheader and filefooter B XL element fileheader As defined by the following extract of XL schema configdata.xsd (see clause B.4.3): <element name="fileheader"> <attribute name="fileformatversion" type="string" use="required"/> <attribute name="sendername" type="string" use="optional"/> <attribute name="vendorname" type="string" use="optional"/> a fileheader XL element: - has the following XL attribute specifications: - a fileformatversion XL attribute specification; this attribute specification carries the abridged number and version of this 3GPP document (see below); this identifies the version of the file format used for assembling the XL file; - a conditional sendername XL attribute specification; this attribute specification shall be present only in XL files generated by the IRPAgent; it carries the DN of the IRPAgent that assembled the XL file, i.e. the value of the systemdn NR attribute of the IRPAgent NR instance (see [10]); - a conditional vendorname XL attribute specification; this attribute specification shall be present only in XL files generated by the IRPAgent; it carries the name of the vendor of the IRPAgent that assembled the XL file; - and has an empty XL content. The abridged number and version of a 3GPP document is constructed from its version specific full reference "3GPP (yyyy-mm)" by: - removing the leading "3GPP TS"; - removing everything including and after the version third digit, representing editorial only changes, together with its preceding dot character; - from the resulting string, removing leading and trailing white space, replacing every multi character white space by a single space character and changing the case of all characters to uppercase. The following is an example of a fileheader XL element: <fileheader fileformatversion=" V10.0" sendername="dc=a1.companynn.com,subnetwork=1,irpagent=1" vendorname="company NN" /> B XL element filefooter As defined by the following extract of XL schema configdata.xsd (see clause B.4.3): <element name="filefooter"> <attribute name="datetime" type="datetime" use="required"/> a filefooter XL element: - has a datetime XL attribute specification; this attribute specification carries the date and time the XL file was assembled;

43 42 TS V ( ) - and has an empty XL content. The following is an example of a filefooter XL element: <filefooter datetime=" t12:00:00+02:00"/> B.2.3 XL element configdata As defined by the following extract of XL schema configdata.xsd (see clause B.4.3): <element name="configdata" maxoccurs="unbounded"> <choice> <element ref="xn:subnetwork"/> <element ref="xn:econtext"/> <element ref="xn:anagedelement"/> </choice> <attribute name="dnprefix" type="string" use="optional"/> a configdata XL element: - has an optional dnprefix XL attribute specification; this attribute specification carries the DN Prefix information as defined in Annex C of 3GPP TS [4]; - and its XL content is an instance of the specific type of XL element (see below) corresponding to one of the NR classes SubNetwork, econtext or anagedelement (see [10]); depending on the System Context of the IRP (see [9]) the used NR class shall be: - in case of System Context A, only SubNetwork NR class, or; - in case of System Context B, only econtext or anagedelement NR class. This instance of SubNetwork/eContext/anagedElement NR class corresponding specific XL element type is the starting point for a configdata XL element to possibly contain several NR instances in a NR naming tree organized structure (see clause B.2.4.2). The following is an example of a configdata XL element: <configdata dnprefix="dc=a1.companynn.com"> <xn:subnetwork > </xn:subnetwork> </configdata>

44 43 TS V ( ) B.2.4 NR-specific XL elements NR-specific XL element types are generically defined under the mapping rules defined in clause B NR-specific XL element types are explicitly declared by NR-specific XL schemas as defined in clause B B NR-specific XL schemas NR-specific XL schemas are defined in the NR-specific parts (see clause 1) of the XL file format definition for the Bulk Configuration anagement IRP IS [9]. NR-specific XL schemas with definition of corresponding XL namespace prefixes (see clause B.2.1) are listed by the following table: Table B.2.4.1: NR-specific XL schemas, corresponding 3GPP TSs and XL namespace prefixes NR XL schema 3GPP TS no. XL namespace prefix Core Network Resources corenrm.xsd [13] cn Generic Network Resources genericnrm.xsd [11] xn GERAN Network Resources gerannrm.xsd [17] gn I Network Resources inventorynrm.xsd [19] in IS NR imsnrm.xsd [21] im STN Network Resources stnnrm.xsd [23] stn TN Network Resources transportnrm.xsd [20] tn UTRAN Network Resources utrannrm.xsd [15] un E-UTRAN Network eutrannrm.xsd [25] en Resources EPC Network Resources epcnrm.xsd [24] epc SON Policy Network sonpolicynrm.xsd [39] sp Resources Subscription anagement sumnrm.xsd [37] sn Network Resources Repeater Network RepeaterNrm.xsd [42] rn Resources HNS Network Resources hnsnrm.xsd [47] hn HeNS Network Resources hensnrm.xsd [49] hen Generic RAN Network Resources genericrannrm.xs d [50] gr Each NR-specific XL schema explicitly declares NR-specific XL element types for the related NR. Additionally, XL schema genericnrm.xsd (see [11]) also provides global XL declarations and definitions for the support of: - NR-specific XL element type declaration; - vendor-specific XL element type declaration (see clause B.2.6). B Generic mapping rules NR-specific XL element types are generically defined under the following mapping rules: - to each NR class corresponds a specific type of XL element having the following characteristics: - its name is the name of the NR class; - it derives by extension (see [28], [29] and [30]) the NrmClass XL complex type defined in the XL schema genericnrm.xsd (see [11]); - it has the following XL attribute specifications, inherited from NrmClass XL complex type:

45 44 TS V ( ) - an id XL attribute specification; this attribute specification carries the attribute value part of the RDN of the NR instance carried by the XL element, i.e. the value of the naming attribute of this NR instance; - an optional modifier XL attribute specification (see clause B.2.5); - and its XL content is the succession of: - an optional attributes XL element whose XL content is the succession of: - zero or more specific XL elements (see below) corresponding to attributes of the NR class, each occurring not more than once; - zero or more similar specific XL elements corresponding to direct subordinate NR classes of the NR class to which the current XL element corresponds; - to each NR attribute of each NR class, except for the following NR attributes: - the naming NR attribute of each NR class, whose value is already carried by the id XL attribute specification of the specific XL element corresponding to the NR class; - the conditional dnprefix NR attribute of SubNetwork, econtext and anagedelement NR classes (see [10]), whose value is already carried by the dnprefix XL attribute specification of the configdata XL element; corresponds a specific type of XL element having the following characteristics: - its name is constructed from the name of the NR attribute by removing any contained dash character; - and it has an XL content; this XL content carries the value of the NR attribute. For example for the SubNetwork NR class (see [10]), the corresponding extract of XL schema genericnrm.xsd (see [11]) is the following: <element name="subnetwork"> <complexcontent> <extension base="xn:nrmclass"> <sequence> <element name="attributes" minoccurs="0"> <all> <element name="userlabel" minoccurs="0"/> <element name="userdefinednetworktype" minoccurs="0"/> </all> <choice minoccurs="0" maxoccurs="unbounded"> <element ref="xn:subnetwork"/> <element ref="xn:anagedelement"/> <element ref="xn:econtext"/> <element ref="xn:anagementnode"/> <element ref="xn:irpagent"/> <element ref="xn:subnetworkoptionallycontainednrmclass"/> </choice> </sequence> </extension> </complexcontent> supported by the following extract of XL schema genericnrm.xsd (see [11]): <complextype name="nrmclass"> <attribute name="id" type="string" use="required"/> <attribute name="modifier" use="optional"> </attribute>

46 45 TS V ( ) Exceptions to the generic mapping rules for the definition of NR-specific XL element types are listed by the following table: Table B.2.4.2: Generic mapping rule exceptions NR classes / attributes NR 3GPP TS no. Exception description references vsdata attribute of VsDataContainer class [10] clause B.2.6 of the present document and annex A of 3GPP TS [11] The following is an example of a configdata XL element with regard to NR-specific XL elements (in bold) in a configuration data XL file: <?xml version="1.0" encoding="utf-8"?> <bulkcmconfigdatafile xmlns= " xmlns:xn= " > <configdata dnprefix="dc=a1.companynn.com"> <xn:subnetwork id="1"> <xn:attributes> <xn:userlabel>paris SN1</xn:userLabel> <xn:userdefinednetworktype>uts</xn:userdefinednetworktype> </xn:attributes> <xn:anagementnode id="1"> <xn:attributes> <xn:userlabel>paris N1</xn:userLabel> <xn:vendorname>company NN</xn:vendorName> <xn:userdefinedstate>commercial</xn:userdefinedstate> <xn:locationname>ontparnasse</xn:locationname> </xn:attributes> </xn:anagementnode> <xn:anagedelement id="1"> <xn:attributes> <xn:managedelementtype>rnc</xn:managedelementtype> <xn:userlabel>paris RN1</xn:userLabel> <xn:vendorname>company NN</xn:vendorName> <xn:userdefinedstate>commercial</xn:userdefinedstate> <xn:locationname>champ de ars</xn:locationname> </xn:attributes> </xn:anagedelement> <xn:anagedelement id="2"> <xn:attributes> <xn:managedelementtype>rnc</xn:managedelementtype> <xn:userlabel>paris RN2</xn:userLabel> <xn:vendorname>company NN</xn:vendorName> <xn:userdefinedstate>commercial</xn:userdefinedstate> <xn:locationname>concorde</xn:locationname> </xn:attributes> </xn:anagedelement> </xn:subnetwork> </configdata> </bulkcmconfigdatafile>

47 46 TS V ( ) B.2.5 XL attribute specification modifier As defined by the following extract of XL schema genericnrm.xsd (see [11]): <attribute name="modifier" use="optional"> <simpletype> <restriction base="string"> <enumeration value="create"/> <enumeration value="delete"/> <enumeration value="update"/> </restriction> </simpletype> </attribute> the value of the optional modifier XL attribute specification of the specific XL elements corresponding to the classes of the NR is one of the following: create, delete, or update. The semantic carried by a modifier XL attribute specification applies only to the NR instance corresponding to the containing XL element and not to any explicit or implicit subordinate NR instances of this NR instance. The following rules apply for the modifier XL attribute specification: - in upload XL configuration files, no modifier XL attribute specification should be present; on the contrary those are to be considered as meaningless and shall be ignored; - in download XL configuration files: - if an XL element carrying an NR instance has a modifier XL attribute specification of value create, then all directly or indirectly contained XL element carrying NR instances, if any, shall also have a modifier XL attribute specification of value create; - if an XL element carrying an NR instance has a modifier XL attribute specification of value delete, then all directly or indirectly contained XL element carrying NR instances, if any, shall also have a modifier XL attribute specification of value delete; - if an XL element carrying an NR instance has a modifier XL attribute specification of value update, then all directly contained XL element carrying NR instances, if any, may also have a modifier XL attribute specification, this one being of either value create, delete, or update; - if an XL element carrying an NR instance has no modifier XL attribute specification or a modifier XL attribute specification of value delete, then it shall not directly contain an attributes XL element. A tree of XL elements corresponding to a tree of NR instances with all XL elements having a modifier XL attribute specification of value create is considered to be in accordance with the following rule from Bulk C IRP IS 3GPP TS [9]: "When part or a whole NR subtree is to be created, in the configuration data file the IRPanager shall first action the create action of parents O instances before actioning the create of any child O instances contained in the NR subtree i.e. create actions on O instances shall be specified in recursive manner following the NR hierarchy subtree from the highest O instances to the lowest O instances the IRPanager requires to be created." In such a tree of NR instances, the XL element carrying a given NR instance does not accurately appear before XL elements carrying subordinate NR instances. The latter XL elements rather appear as the last part of the XL content of the former XL element. Nevertheless, XL parsing of such a tree of NR instances can still enable the above Bulk C IRP IS rule to be fully respected. Example of an XL parsing enabling such compliance is one effectively actioning the creation of each NR instance when having parsed the XL start-tag of the XL element carrying the NR instance and, if any, the contained attributes XL element.

48 47 TS V ( ) A tree of XL elements corresponding to a tree of NR instances with all XL elements having a modifier XL attribute specification of value delete is considered to be in accordance with the following rule from Bulk C IRP IS 3GPP TS [9]: "When part or whole NR subtree is to be deleted, in the configuration data file the IRPanager shall first action delete of all associated child instances contained in the NR subtree before actioning delete of O parents instances i.e. delete actions on O instances shall be specified in a recursive manner following the NR hierarchy subtree from the lowest O instances to the highest O instances the IRPanager requires to be deleted." In such a tree of NR instances, the XL elements carrying subordinate NR instances do not appear before the XL element carrying the parent NR instance. The former XL elements rather appear as the XL content of the latter XL element. Nevertheless, XL parsing of such a tree of NR instances can still enable the above Bulk C IRP IS rule to be fully respected. Example of an XL parsing enabling such compliance is one effectively actioning the delete of each NR instance when parsing the XL end-tag of the XL element carrying the NR instance. The following are examples of legal configdata XL element with regard to modifier XL attribute specification (in bold) in configuration data XL files: - example 1: <?xml version="1.0" encoding="utf-8"?> <bulkcmconfigdatafile xmlns= " xmlns:xn= " > <configdata dnprefix="dc=a1.companynn.com"> <xn:subnetwork id="1" modifier="create"> <xn:attributes> <xn:userlabel>paris SN1</xn:userLabel> <xn:userdefinednetworktype>uts</xn:userdefinednetworktype> </xn:attributes> <xn:anagementnode id="1" modifier="create"> <xn:attributes> <xn:userlabel>paris N1</xn:userLabel> <xn:locationname>ontparnasse</xn:locationname> </xn:attributes> </xn:anagementnode> <xn:anagedelement id="1" modifier="create"> <xn:attributes> <xn:managedelementtype>rnc</xn:managedelementtype> <xn:locationname>champ de ars</xn:locationname> </xn:attributes> </xn:anagedelement> <xn:anagedelement id="2" modifier="create"> <xn:attributes> <xn:managedelementtype>rnc</xn:managedelementtype> <xn:locationname>concorde</xn:locationname> </xn:attributes> </xn:anagedelement> </xn:subnetwork> </configdata> </bulkcmconfigdatafile> - example 2: <?xml version="1.0" encoding="utf-8"?> <bulkcmconfigdatafile xmlns= " xmlns:xn= "

49 48 TS V ( ) > <configdata dnprefix="dc=a1.companynn.com"> <xn:subnetwork id="1"> <xn:anagedelement id="1" modifier="create"> <xn:attributes> <xn:managedelementtype>rnc</xn:managedelementtype> <xn:locationname>champ de ars</xn:locationname> </xn:attributes> </xn:anagedelement> <xn:anagedelement id="2" modifier="create"> <xn:attributes> <xn:managedelementtype>rnc</xn:managedelementtype> <xn:locationname>concorde</xn:locationname> </xn:attributes> </xn:anagedelement> </xn:subnetwork> </configdata> </bulkcmconfigdatafile> - example 3: <?xml version="1.0" encoding="utf-8"?> <bulkcmconfigdatafile xmlns= " xmlns:xn= " > <configdata dnprefix="dc=a1.companynn.com"> <xn:subnetwork id="1" modifier="delete"> <xn:anagementnode id="1" modifier="delete"> </xn:anagementnode> <xn:anagedelement id="1" modifier="delete"> </xn:anagedelement> <xn:anagedelement id="2" modifier="delete"> </xn:anagedelement> </xn:subnetwork> </configdata> </bulkcmconfigdatafile> - example 4: <?xml version="1.0" encoding="utf-8"?> <bulkcmconfigdatafile xmlns= " xmlns:xn= " > <configdata dnprefix="dc=a1.companynn.com"> <xn:subnetwork id="1"> <xn:anagedelement id="1" modifier="delete"> </xn:anagedelement> <xn:anagedelement id="2" modifier="delete"> </xn:anagedelement> </xn:subnetwork> </configdata> </bulkcmconfigdatafile> - example 5: <?xml version="1.0" encoding="utf-8"?> <bulkcmconfigdatafile

50 49 TS V ( ) xmlns= " xmlns:xn= " xmlns:un= " > <configdata dnprefix="dc=a1.companynn.com"> <xn:subnetwork id="1" modifier="update"> <xn:attributes> <xn:userlabel>paris SN1</xn:userLabel> </xn:attributes> <xn:anagementnode id="1" modifier="update"> <xn:attributes> <xn:userlabel>paris N1</xn:userLabel> </xn:attributes> </xn:anagementnode> <xn:anagedelement id="1" modifier="delete"> <un:rncfunction id="1" modifier="delete"> </un:rncfunction> </xn:anagedelement> <xn:anagedelement id="2" modifier="create"> <xn:attributes> <xn:managedelementtype>rnc</xn:managedelementtype> <xn:locationname>concorde</xn:locationname> </xn:attributes> <un:rncfunction id="2" modifier="create"> <un:attributes> <un:userlabel>paris RF2</un:userLabel> <un:rncid>2</un:rncid> </un:attributes> </un:rncfunction> </xn:anagedelement> <xn:anagedelement id="3"> <un:rncfunction id="3" modifier="update"> <un:attributes> <un:userlabel>paris RF3</un:userLabel> </un:attributes> </un:rncfunction> </xn:anagedelement> </xn:subnetwork> </configdata> </bulkcmconfigdatafile>

51 50 TS V ( ) B.2.6 XL elements VsDataContainer, vsdata and vsdataformatversion As all XL element types corresponding to NR classes (see clause B.2.4.2), the VsDataContainer XL element type, explicitly declared in 3GPP TS [11], corresponds to the VsDataContainer NR class defined in 3GPP TS [10]. Contained in an attributes XL element type, itself contained in a VsDataContainer XL element, as all XL element types corresponding to NR attributes (see clause B.2.4.2), the vsdata and vsdataformatversion XL element types, explicitly declared in 3GPP TS [11], correspond to the vsdata and vsdataformatversion NR attributes defined in 3GPP TS [10]. As an exception to the generic mapping rules for the definition of NR-specific XL element types (see clause B.2.4.2), the vsdata XL element type has an empty XL content. Each vendor-specific XL schema shall declare one ore more vendor-specific XL element types that: - have a name starting with vsdata, e.g. vsdatarho; - derive by extension (see [28], [29] and [30]) the vsdata XL element type declared by the XL schema genericnrm.xsd (see [11]); - are designated as members of the substitution group (see [28], [29] and [30]) headed by the vsdata XL element type. Beyond the above statement, the definition of vendor-specific XL schemas is outside the scope of this document. The XL content of those vendor-specific XL elements carry vendor-specific data. The XL content of the vsdataformatversion XL element shall be the filename, without the ".xsd" file extension and without any path specification, of the vendor-specific XL schema used for the related VsDataContainer XL element. See clause B.4.4 for an example of a vendor-specific XL schema. The following is an example of a vendor-specific XL element (in bold) deriving and extending the vsdata XL element in a configuration data XL file: <?xml version="1.0" encoding="utf-8"?> <bulkcmconfigdatafile xmlns= " xmlns:xn= " xmlns:un= " xmlns:vsrho11=" > <configdata dnprefix="dc=a1.companynn.com"> <xn:subnetwork id="1"> <xn:anagedelement id="1"> <un:rncfunction id="1"> <xn:vsdatacontainer id="1"> <xn:attributes> <xn:vsdatatype>rnchandover</xn:vsdatatype> <xn:vsdataformatversion>nnrnchandover.1.1</xn:vsdataformatversion> <vsrho11:vsdatarho> <vsrho11:abcin>12</vsrho11:abcin> <vsrho11:abcax>34</vsrho11:abcax> </vsrho11:vsdatarho> </xn:attributes> </xn:vsdatacontainer> </un:rncfunction> </xn:anagedelement> </xn:subnetwork> </configdata> </bulkcmconfigdatafile>

52 51 TS V ( ) B.3 Structure and content of session log XL files The present clause defines the file format of session log XL files exchanged between an IRPanager and an IRPAgent as part of getsessionlog operation of the Bulk C IRP IS (see [9]). This file format is defined by the XL schema in clause B.4.5 and by the following clauses. The use of an XL schema enables to ensure session log XL files have the proper structure and to some extent the proper content. Location of the XL schemas used for session log XL files is outside the scope of this document. B.3.1 Global structure The content of a session log XL file is the succession of: - the standard XL declaration with specification of the version of XL and of the character encoding being used (see [27]); - a bulkcmsessionlogfile XL element; this is the root XL element of session log XL files. The definition of the allowed character encoding(s) is outside the scope of this document. As defined by the following extract of XL schema sessionlog.xsd (see clause B.4.5): <element name "bulkcmsessionlogfile"> <sequence> <element name="fileheader"> <element name="activity" maxoccurs="unbounded"> <element name="filefooter"> </sequence> the XL content of a bulkcmsessionlogfile XL element is the succession of: - a fileheader XL element (see clause B.3.2); - one or several activity XL elements (see clause B.3.3); - a filefooter XL element (see clause B.3.2). XL elements fileheader and filefooter are empty XL elements (see clause B.3.2). The bulkcmsessionlogfile XL element shall also have all the XL attribute specifications that declare the XL namespaces (see [31]) used in the XL file. Only the default XL namespace is used in session log XL files. It is associated with the session log file XL schema sessionlog.xsd (see clause B.4.5). The following is an example of a session log XL file, without presentation of the XL attribute specifications and XL content of fileheader, activity and filefooter XL elements (replaced by ; see clauses B.3.2 and B.3.3): <?xml version="1.0" encoding="utf-8"?> <bulkcmsessionlogfile xmlns= " >

53 52 TS V ( ) <fileheader /> <activity > </activity> <activity > </activity> <filefooter /> </bulkcmsessionlogfile> B.3.2 XL elements fileheader and filefooter The XL elements fileheader and filefooter for session log XL files have the same definition, structure and content as the XL elements fileheader and filefooter for configuration data XL files (see clause B.2.2). B.3.3 XL element activity As defined by the following extract of XL schema sessionlog.xsd (see clause B.4.5): <element name="activity" minoccurs="0" maxoccurs="unbounded"> <sequence> <element name="log" maxoccurs="unbounded"> </sequence> <attribute name="datetime" type="datetime" use="required"/> <attribute name="type" use="required"> <simpletype> <restriction base="string"> <enumeration value="upload"/> <enumeration value="download"/> <enumeration value="validate"/> <enumeration value="preactivate"/> <enumeration value="activate"/> <enumeration value="fallback"/> </restriction> </simpletype> </attribute> an activity XL element: - has the following XL attribute specifications: - a datetime XL attribute specification; this attribute specification carries the date and time the Bulk C activity was started; - a type XL attribute specification; this attribute specification carries the type of the Bulk C activity triggered by the IRPanager, upload, download, validate, preactivate, activate or fallback; - and its XL content is the succession of one or several log XL elements. As defined by the following extract of XL schema sessionlog.xsd (see clause B.4.5): <element name="log" maxoccurs="unbounded"> <simplecontent> <extension base="string"> <attribute name="time" type="time" use="required"/> <attribute name="type" use="required"> <simpletype> <restriction base="string"> <enumeration value="informative"/> <enumeration value="error"/> </restriction>

54 53 TS V ( ) </simpletype> </attribute> <attribute name="dn" type="string" use="optional"/> <attribute name="modifier" use="optional"> <simpletype> <restriction base="string"> <enumeration value="create"/> <enumeration value="delete"/> <enumeration value="update"/> </restriction> </simpletype> </attribute> </extension> </simplecontent> a log XL element: - has the following XL attribute specifications: - a time XL attribute specification; this attribute specification carries the time the logged Bulk C internal event occurred; - a type XL attribute specification; this attribute specification carries the type of the logged Bulk C internal event, being either informative or error; - an optional dn XL attribute specification; this attribute specification carries the DN of the NR instance associated with the logged Bulk C internal event, if any; - an optional modifier XL attribute specification; this attribute specification carries the value of the modifier (see clause B.2.5) associated with the NR instance, if any; - and it has an XL content; this XL content carries the description of the logged Bulk C internal event. The following is an example of an activity XL element (in bold) in a session log XL file: <?xml version="1.0" encoding="utf-8"?> <bulkcmsessionlogfile xmlns= " > <activity datetime=" t12:00:00+02:00" type="download"> <log time="12:00:01+02:00" type="informative"> Download requested with: downloaddatafilereference="ftp://a1.companynn.com/data/upld123.xml" </log> <log time="12:00:02+02:00" type="error" dn="dc=a1.companynn.com,subnetwork=1" modifier="update" > No such instance </log> </activity> </bulkcmsessionlogfile>

55 54 TS V ( ) B.4 Solution Set definitions B.4.1 XL definition structure Clause B.4.2 provides a graphical representation of the XL elements. Clause B.4.3 provides the base schema for configuration data XL files. Clause B.4.4 provides an example of vendor-specific schema for configuration data XL files. Clause B.4.5 provides the schema for session log XL files. Clause B.4.6 provides the BulkCIRP Notification XL Schema.

56 55 TS V ( ) B.4.2 Graphical Representation This clause provides XL definitions of Notification Log IRP notifications as defined in [9]. The structure of the BulkCIRP Notification XL Definitions is shown in graphical depiction below: The use of XL schema key word "sequence" to support IS-defined set (not sequence) is for the purpose of XL processor efficiency. This shall not imply the use of "sequence" in other technology.