C.1 Rules
32.1533GPPIntegration Reference Point (IRP) technology specific templates, rules and guidelinesRelease 17Telecommunication managementTS
C.1.1 Introduction
The intent of this annex is threefold.
1) The first intent is for 3GPP internal use to document how a 3GPP SOAP SS is produced and how it is structured.
2) The second intent with the annex is to give the reader or implementer of a SOAP SS a better understanding on how to interpret the SOAP SS specification.
3) The third and maybe most important intent is to put requirement on an implementer of a SOAP SS.
It is expected that this annex is to be extended in later versions of the present document.
C.1.2 Rules for specification of SOAP Solution Sets
C.1.2.1 Introduction
This subclause identifies rules for specification of SOAP SSs. This subclause is mainly for 3GPP-internal use. It is only for information for the implementer of a SOAP SS.
C.1.2.2 File names
The WSDL files should follow the naming convention:
WSDLTarget.wsdl
with:
WSDLTarget being the text after the character ‘#’ in the target namespace of the definitions
Examples:
If the 3GPP WSDL document contains
<definitions … targetNamespace="http://www.3gpp.org/ftp/specs/archive/32_series/32.666#KernelCMIRPSystem">,
then the WSDL filename shall be KernelCMIRPSystem.wsdl.
If the WSDL document contains
<definitions … targetNamespace="http://www.3gpp.org/ftp/specs/archive/32_series/32.111-6#AlarmIRPSystem">,
then the WSDL filename shall be AlarmIRPSystem.wsdl.
C.1.2.3 Void
C.1.2.4 XML version encoding
The first line of each wsdl and xsd file shall indicate the XML version and encoding. The supported XML version is defined in the subject TS. The supporting encoding is UTF-8 (refer to [16]).
Therefore, an example for the wsdl and xsd fileis :
<?xml version="1.0" encoding="UTF-8"?>
C.1.2.5 Namespaces
The WSDL namespace URI shall follow the naming convention:
http://www.3gpp.org/ftp/specs/archive/IRP_series/IRPNumber#SchemaName
with:
– IRP_series is the 3GPP specification series;
– IRPNumber is the number before the 3GPP document version number, corresponding to the 3GPP document which defines the resource;
– SchemaName isthe name of the WSDL specification or the name of the XML Schema.in which the resource is defined.
Examples:
The 3GPP document "3GPP TS 32.111-6 V11.0.0 (2012-09)" defines the resource “AlarmIRPSystem” . It defines the WSDL specification "AlarmIRPsystem.wsdl" in which the resource AlarmIRPSystem is defined. T hen thenamespace URI shall be:
http://www.3gpp.org/ftp/specs/archive/32_series/32.111-6#AlarmIRPSystem
The 3GPP document "3GPP TS 28.623 V11.1.0 (2013-06)" defines the resource "SubNetwork". It defines the XML schema "genericNrm.xsd" in which the resource SubNetwork is defined. Then the namespace URI shall be:
http://www.3gpp.org/ftp/specs/archive/28_series/28.623#genericNrm
http://www.3gpp.org/ftp/specs/archive/32_series/32.127#AAMIRPData
C.1.3 Implementation aspects of Interface IRP SOAP Solution Sets
C.1.3.1 Introduction
This subclause identifies rules for the implementation of SOAP SSs. This subclause is normative for the implementer of a SOAP SS.
C.1.3.n XXXX rule
C.2 Guidelines (Style Guide for SOAP SS WSDL)
This subclause describes the style guide for writing WSDL documents for Interface IRP.
The guide sets out consistent naming, structural conventions and usage of SS interface for the WSDL in IRP SOAP SS specifications.
C.2.1 File structure
The structure of the wsdl file shall follow the W3C WSDL Document Structure defined in [10] specifications.
C.2.1.1 Definitions
Guidelines for the Definitions section.
C.2.1.2 Namespaces
Guidelines for the Namespaces section.
C.2.1.3 Documentation
Guidelines for the optional Documentation section.
C.2.1.4 Types
Guidelines for Types
C.2.1.5 Message
Guidelines for Messages
C.2.1.6 Port type
Guidelines for Port types
C.2.1.7 Binding
Guidelines for Bindings
C.2.1.8 Port
Guidelines for Ports
C.2.1.9 Service
Guidelines for Services
C.2.2 Identifiers
C.2.2.n Rule n
Identify the categories of identifiers which follow the Rule n rules.