1 Introduction
This document is a guideline for implementing CAI3G customer adaptations in Ericsson™ Dynamic Activation (EDA).
Customer Administration Interface Third Generation (CAI3G) is a synchronous provisioning interface based on Simple Object Access Protocol (SOAP). This is further described in document Generic CAI3G Interface 1.2, Reference [2].
Dynamic Activation implements CAI3G as its provisioning interface which extends generic CAI3G, but is not fully compliant to the generic interface in some points.
1.1 Purpose and Scope
The purpose of this document is to inform about what criteria, restrictions, and recommendations that are needed to follow when implementing CAI3G customer adaptations in Dynamic Activation.
1.2 Target Groups
The target groups for this document are as follows:
- CA developers
- Solution architects
1.3 Typographic Conventions
Typographic conventions are described in the Library Overview, Reference [1].
For information about abbreviations used throughout this document, see Glossary of Terms and Acronyms, Reference [4].
1.4 Prerequisites
The readers of this document must meet the following prerequisites:
- Knowledge of Dynamic Activation
- Knowledge of Linux™
- Knowledge of the Java language, Eclipse, and Maven
2 MO Namespace
Standard Dynamic Activation CAI3G MOs must use the following namespace syntax:
http://schemas.ericsson.com/ma/<service or NE>
MOs that are implemented as Customer Adaptations must use the following namespace syntax:
http://schemas.ericsson.com/ma/CA/<service or NE>
3 MO Key Attributes
MO Attributes are identified by one or more key attributes, which can also be represented by MO Id. The key attributes can be XML attributes or XML elements in MO attributes at the top level of different methods. The following table describes how MO key attributes are handled in Dynamic Activation.
|
CAI3G Method |
MO Key Attributes |
|---|---|
|
Create Request |
Key attributes should be defined as XML attributes, and XML elements at the top level. |
|
Create Response |
|
|
Set Request |
Key attributes should be defined as XML attributes. An XML element can also be defined for MO identifier changeover if needed. |
|
Set Response |
|
|
Get Request |
|
|
Get Response |
Key attributes should be defined as XML attributes, and XML elements at the top level. |
|
Delete Request |
|
|
Delete Response |
4 MO Attribute Restrictions
MO Attribute restrictions can either be defined per CAI3G operation, or one common restriction that is used for all CAI3G operations.
Recommendation is to have one common attribute restriction for all MO operations, unless different operations require different restrictions.
5 Fault Message
For subordinate CAI3G Faults, it is recommended to use Fault type PGFault with the following namespace syntax:
http://schemas.ericsson.com/pg/1.0
For details, refer to CAI3G Implementation, Reference [3].
6 WSDL and XSD Examples
An example of WSDL and XSD files that describe the provisioning interface, can be found in the downloadable zip file. The zip file contains the following files:
- myService.wsdl - defines the MO Type, and the MO Ids
- myService.xsd - defines the MO Attributes
- myService_types.xsd - defines the MO Id and MO Attribute restrictions
- PGFault.xsd - defines the PGFault
Download this zip file by following the instruction below:
- Save the zip file, Northbound_Interface_Templates, to a local folder.
- Unpack the zip file.
- Use an appropriate text editor to read and update the templates.
Reference List
| Ericsson Documents |
|---|
| [1] Library Overview, 18/1553-CSH 109 628 Uen |
| [2] Generic CAI3G Interface 1.2, 2/155 19-FAY 302 0003 Uen |
| [3] CAI3G Implementation, 26/155 19-CSH 109 628 Uen |
| [4] Glossary of Terms and Acronyms, 0033-CSH 109 628 Uen |

Contents