5 Structure and content of session log XML files

32.6153GPPBulk CM Integration Reference Point (IRP): eXtensible Markup Language (XML) file format definitionConfiguration Management (CM)Release 9Telecommunication managementTS

The present clause defines the file format of session log XML files exchanged between an IRPManager and an IRPAgent as part of getSessionLog operation of the Bulk CM IRP IS (see [1]).

This file format is defined by the XML schema in Annex D and by the following clauses.

The use of an XML schema enables to ensure session log XML files have the proper structure and to some extent the proper content.

Location of the XML schemas used for session log XML files is outside the scope of this document.

5.1 Global structure

The content of a session log XML file is the succession of:

– the standard XML declaration with specification of the version of XML and of the character encoding being used (see [2]);

– a bulkCmSessionLogFile XML element; this is the root XML element of session log XML files.

The definition of the allowed character encoding(s) is outside the scope of this document.

As defined by the following extract of XML schema sessionLog.xsd (see Annex D):

<element name "bulkCmSessionLogFile">
<complexType>
<sequence>
<element name="fileHeader">
[…]
</element>
<element name="activity" maxOccurs="unbounded">
[…]
</element>
<element name="fileFooter">
[…]
</element>
</sequence>
</complexType>
</element>

the XML content of a bulkCmSessionLogFile XML element is the succession of:

– a fileHeader XML element (see clause 5.2);

– one or several activity XML elements (see clause 5.3);

– a fileFooter XML element (see clause 5.2).

XML elements fileHeader and fileFooter are empty XML elements (see clause 5.2).

The bulkCmSessionLogFile XML element shall also have all the XML attribute specifications that declare the XML namespaces (see [6]) used in the XML file.

Only the default XML namespace is used in session log XML files. It is associated with the session log file XML schema sessionLog.xsd (see Annex D).

The following is an example of a session log XML file, without presentation of the XML attribute specifications and XML content of fileHeader, activity and fileFooter XML elements (replaced by […]; see clauses 5.2 and 5.3):

<?xml version="1.0" encoding="UTF-8"?>
<bulkCmSessionLogFile
xmlns=
"http://www.3gpp.org/ftp/specs/archive/32_series/32.615#sessionLog"
[…]
>
<fileHeader […]/>
<activity […]>
[…]
</activity>
<activity […]>
[…]
</activity>
<fileFooter […]/>
</bulkCmSessionLogFile>

5.2 XML elements fileHeader and fileFooter

The XML elements fileHeader and fileFooter for session log XML files have the same definition, structure and content as the XML elements fileHeader and fileFooter for configuration data XML files (see clause 4.2).

5.3 XML element activity

As defined by the following extract of XML schema sessionLog.xsd (see Annex D):

<element name="activity" minOccurs="0" maxOccurs="unbounded">
<complexType>
<sequence>
<element name="log" maxOccurs="unbounded">
[…]
</element>
</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>
</complexType>
</element>

an activity XML element:

– has the following XML attribute specifications:

– a dateTime XML attribute specification; this attribute specification carries the date and time the Bulk CM activity was started;

– a type XML attribute specification; this attribute specification carries the type of the Bulk CM activity triggered by the IRPManager, upload, download, validate, preactivate, activate or fallback;

– and its XML content is the succession of one or several log XML elements.

As defined by the following extract of XML schema sessionLog.xsd (see Annex D):

<element name="log" maxOccurs="unbounded">
<complexType>
<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>
</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>
</complexType>
</element>

a log XML element:

– has the following XML attribute specifications:

– a time XML attribute specification; this attribute specification carries the time the logged Bulk CM internal event occurred;

– a type XML attribute specification; this attribute specification carries the type of the logged Bulk CM internal event, being either informative or error;

– an optional dn XML attribute specification; this attribute specification carries the DN of the NRM instance associated with the logged Bulk CM internal event, if any;

– an optional modifier XML attribute specification; this attribute specification carries the value of the modifier (see clause 4.4) associated with the NRM instance, if any;

– and it has an XML content; this XML content carries the description of the logged Bulk CM internal event.

The following is an example of an activity XML element (in bold) in a session log XML file:

<?xml version="1.0" encoding="UTF-8"?>
<bulkCmSessionLogFile
xmlns=
"http://www.3gpp.org/ftp/specs/archive/32_series/32.615#sessionLog"
[…]
>
[…]
<activity dateTime="2001-05-07T12: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>