Contents

1   Introduction

This document describes synchronous CAI3G implementation 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 [1].

Dynamic Activation implements CAI3G as its provisioning interface which extends generic CAI3G, but is not fully compliant to the generic interface in some points.

2   Extensions to CAI3G Interface

The Context element is supported in CAI3G request header.

3   Deviations from the CAI3G Interface

The following subsections hold information about deviations from the CAI3G interface.

3.1   SequenceId Is Not Enforced

The sequeneceId element is supported in CAI3G request header, but currently it is not enforced in Dynamic Activation for the coming CAI3G request. Dynamic Activation does not have a verification on this value.

3.2   TransactionId Is Not Enforced

The TransactionId element is supported in CAI3G request header, but currently it is not enforced in Dynamic Activation for the coming CAI3G request. Dynamic Activation does not have a verification on this value.

3.3   Final Parameter

The final parameter is not used in the header type definitions in the Dynamic Activation schema files, for example. headerfault, despite being part of the Generic CAI3G 1.2 interface, see Generic CAI3G Interface 1.2, Reference [1].

As an example, see first row <xs:complexType name="SessionIdFault" final="restriction">:

<xs:complexType name="SessionIdFault" final="restriction">
  <xs:complexContent>
    <xs:extension base="HeaderFaultType">
      <xs:sequence>
        <xs:element name="faultcode">
          <xs:simpleType>
            <xs:restriction base="xs:string">
              <xs:enumeration value="Invalid SessionId"/>
              <xs:enumeration value="Session Timeout"/>
              <xs:enumeration value="SessionId Syntax Error"/>
            </xs:restriction>
          </xs:simpleType>
        </xs:element>
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

3.4   Element Instead of Type

The element attribute is used instead of the type attribute for certain header type definitions. This is because of code validation and generation tools not having support for type definitions.

As an example, see first row <xs:element name="SessionIdFault">:

<xs:element name="SessionIdFault">
 <xs:complexType>
  <xs:complexContent>
   <xs:extension base="HeaderFaultType">
    <xs:sequence>
     <xs:element name="faultcode">
      <xs:simpleType>
       <xs:restriction base="xs:string">
        <xs:enumeration value="Invalid SessionId"/>
        <xs:enumeration value="Session Timeout"/>
        <xs:enumeration value="SessionId Syntax Error"/>
       </xs:restriction>
      </xs:simpleType>
     </xs:element>
    </xs:sequence>
   </xs:extension>
  </xs:complexContent>
 </xs:complexType>
</xs:element>

4   CAI3G Implementation

This section holds information about the CAI3G implementation.

4.1   CAI3G Versions

The following is supported:

• CAI3G version 1.2.
• SOAP version 1.1, see http://schemas.xmlsoap.org/soap/envelope/
• WSDL version 1.2, see http://schemas.xmlsoap.org/wsdl/
• XML schema version 2001, see http://www.w3.org/2001/XMLSchema

4.2   CAI3G Operation

The following table lists supported CAI3G operations in Dynamic Activation versions respectively:

4.3   Schema Validation

The following table holds information about schema validation:

4.4   Security

The following subsections hold information about CAI3G security methods.

4.4.1   User Authentication

The following table holds information regarding user authentication:

4.4.2   Traffic Encryption

The Dynamic Activation CAI3G agent supports Hypertext Transfer Protocol over Secure Socket Layer (HTTPS) for traffic encryption. The CAI3G manager is able to use HTTPS on the specific port with default Secure Socket Layer (SSL) certification or its own certification.

For details on how to deploy CAI3G SSL certification, refer to System Administrators Guide for Native Deployment, Reference [2] for Native deployment, or System Administrators Guide for Virtual and Cloud Deployment, Reference [3] for Virtual deployment.

HTTPS is suggested to be used together above CAI3G authentication mechanism to protect user information from being eavesdropped.

4.5   SOAP HTTP

The following subsections hold information about SOAP HTTP implantation in Dynamic Activation.

4.5.1   SOAP Action

The header field of a SOAPAction HTTP request is used for indicating the CAI3G operation of the SOAP HTTP request. It is defined in each specific provisioning WSDL file. This header field is optional, and is not enforced to be used by the client.

4.5.2   Content-Length

Generally HTTP 1.1 requires a message-body that must include a valid Content-Length for compatibility with HTTP 1.0 applications. For requests, all HTTP 1.1 clients must accept the chunked Transfer-Encoding, which is used for message when the message length cannot be determined in advance.

4.5.3   Keep-Alive

HTTP keep-alive connections are closed by Dynamic Activation when 100 HTTP requests has been executed, or when the connection has been idle for 5 seconds.

4.5.4   Response Status Codes

Successful SOAP operations are using HTTP response status code 200 (OK), and 500 (Internal Server Error), when the response contains a SOAP Fault.

4.6   SOAP JMS

SOAP JMS is not supported in Dynamic Activation.

4.7   Session Id

The sessionId is the system unique session identifier automatically generated by Dynamic Activation. The generated sessionId is replicated to all payload nodes before it is returned to the CAI3G Manager.

A sessionId is valid at least 10 minutes after its last provisioning operation. The idle time-out can vary depending on internal timers. At most it can be valid up to 16 minutes.

5   CAI3G Fault Response

The SOAP Fault element is used to hold error or status information within a CAI3G response. It includes Cai3gFault and details about the fault.

5.1   CAI3G Fault Codes

The following table lists all current implemented CAI3G fault codes in Dynamic Activation. Severity of these fault codes and suggested action to recover them are provided in the table. The meaning of each severity is identified as following.

The following table holds information about the implemented CAI3G fault codes.

5.2   Dynamic Activation Fault Types

The details element in the Cai3gFault is used to hold information about the Dynamic Activation error details.

The following table covers all Fault Types that are handled in Dynamic Activation:

(1)  This Fault type does not use the standard elements described in Table 6, it uses the elements respCode and respDescription

The following table covers the elements that can be included in a Fault type.

5.3   General Dynamic Activation Internal Error Codes

The following table lists all Dynamic Activation internal error codes. They can appear in any CAI3G fault respons.

Reference List