TGW 1.0.3 Billing Spec

Nokia Multimedia Terminal Gateway Release 1.0.3Part of the Multimedia Messaging Service Application Suite

Billing Interface SpecificationReference Document

DN027687 1Issue 1-3 en Copyright © Nokia Corporation 2002.

PURPOSE. This document describes the product(s) defined in the introduction of this document and is subject to change without notice. This document is intended for the use of Nokia Corporation’s customers for the sole purposes of the agreement under which it is submitted. It has been prepared to be used by professional and properly trained personnel, and the customer assumes full responsibility when using it.PROVIDED “AS IS”. Nokia Corporation has used reasonable efforts to ensure that the instructions contained in the document are adequate and free of material errors and omissions. This document is provided on an “AS IS” basis, with no warranty of any kind. NOKIA CORPORATION SPECIFICALLY DISCLAIMS ANY AND ALL IMPLIED WARRANTIES, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF FITNESS, MERCHANTABILITY AND TITLE. Further, the information or statements contained in this document concerning the suitability, capacity or performance of the product(s) concerned are not binding, except as may explicitly be agreed to by Nokia Corporation in the agreement under which this document is submitted.Limitation of Liability. Nokia Corporation’ liability for any errors in the document is limited to the documentary correction of errors. IN NO EVENT SHALL Nokia Corporation HAVE ANY LIABILITY FOR ANY DAMAGES OF WHATEVER NATURE, WHETHER DIRECT, INDIRECT, SPECIAL, INCIDENTAL, ECONOMIC OR CONSEQUENTIAL, that might arise from the use of or inability to use this document or anything contained herein.Intellectual Property Rights. This document and the product it describes are protected by copyright according to applicable laws. No part of this document may be reproduced or transmitted in any form or by any means without the prior written permission of Nokia Corporation. Nokia and Nokia Connecting People are registered trademarks of Nokia Corporation.Product names mentioned in this document may be trademarks of their respective companies and are mentioned for identification purposes only.Copyright © Nokia Corporation 2002. All rights reserved.

2Copyright © Nokia Corporation 2002.

Table of contents
1 Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.1 Product description for TGW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51.2 About this document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51.3 Audience. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51.4 Scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51.5 Typographic conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61.6 If you have documentation comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71.7 Revision history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

2 Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

3 Creating and Processing Call Detail Records (CDRs) . . . . . . . . . . . . . . . . 113.1 Specifying billable events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113.2 Specifying how to process CDRs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

3.2.1 CDR file names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123.2.2 Post-processing CDRs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123.2.3 Billing properties used in CDR processing . . . . . . . . . . . . . . . . . . . . . . 13

4 Accessing and reading CDRs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174.1 Accessing CDRs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

4.1.1 Manually transferring files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174.1.2 Automatically transferring CDRs in XML format. . . . . . . . . . . . . . . . . 17

4.2 Reading CDRs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184.2.1 CDR file format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184.2.2 CDR field descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194.2.3 XML format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204.2.4 XML Document Type Definition (DTD). . . . . . . . . . . . . . . . . . . . . . . . 20

Appendix A: Description of available TGW events . . . . . . . . . . . . . . . . . . . . . . 23

Appendix B: Description of events common to both TGW and the MMSC . . . 39


Preface

1 PrefaceThe preface provides the following introductory topics:• Product description for TGW• About this document• Audience• Scope• Typographic conventions• TGW documentation• Related documentation• If you have documentation comments• Revision history

1.1 Product description for TGW

Nokia Multimedia Terminal Gateway (TGW) is a companion application to the Nokia Artuse™ Multimedia Messaging Service Center (MMS Center). The MMS Center delivers messages composed of text, images, and other media types between multimedia terminals.TGW extends the MMS Center by providing storage and views of multimedia messages. In addition, TGW provides multimedia support for legacy phone owners via SMS notification, allowing legacy phone owners to view their multimedia messages via the Web.

1.2 About this document

This document describes the billing interface for the Nokia Multimedia Terminal Gateway Release 1 (TGW R1). TGW is part of the Multimedia Messaging Service Application Suite.

1.3 Audience

This document is intended for operator personnel involved in the billing operation.

1.4 Scope

The following table describes the major sections in this document.


1.5 Typographic conventions

The following notes and table provide a list of the typographic conventions that appear in this document.

Warning: This information helps avoid damage to the phone, personal injury, orproperty damage.

Caution: This information helps avoid loss of data.

The task icon marks the beginning of a procedure or task sequence.

1.2.3.

Note: This information provides explanatory information.

Section Description

Overview This section provides a general descriptio of the TGW billing system.

Creating and Processing Call Detail Records (CDRs)

This section describes how the TGW system creates and processes CDRs.

Accessing and reading CDRs This description describes how to access CDRs, and how to read CDR files.

Appendix A: Description of available events

This appendix describes all available events as well as explains when TGW generates these events.

Appendix B: Description of events common to both TGW and the MMSC

This appendix identifies events that occur in both TGW and the Multimedia Messaging Service Center (MMSC), so as to ensure that the operator’s customers do not get billed twice.

Table 1 Document contents


Preface

Tip: This information provides helpful guidelines for easy operation.

1.6 If you have documentation comments

The Application Gateways product line at Nokia is always interested in improving its documentation. We value your comments about this guide and other Nokia documentation.Simply e-mail your documentation comments to Application Gateways [email protected] all your correspondence, please include the title of the document, its document number, release version, and the specific section upon which you are commenting.

Convention Description

Courier Font Used for file names, lines ofcode, names of processes, andcommands.

Heavy courier Used for command line user input.

Bold Used for textual parts of graphical user interface, including menu items, buttons, toolbar names and options, and tabs.

Italics Used for screen names and document titles.

Bold Italics Used for emphasis.

<Italics> (Angle Brackets) With italics text, used for variable data.

[___] (Square Brackets) Used for optional data such as command line arguments and database fields.

\ Backslash at the end of lines indicates that there is insufficient space and the line is continued in the space below.

| Vertical bar used between choices, for example in variable data in configuration file arguments.

“” Used for section and chapter titles.

Table 2 Typographic conventions


1.7 Revision history

Table 3 shows a list of all revisions for this document.

Date Issue Release version

January 2002 1-0 en TGW 1.0

April 2002 1-1 en TGW 1.0.2

July 2002 1-2 en TGW 1.0.3

August 2002 1-3 en TGW 1.0.3

Table 3 Revision history


Overview

2 OverviewNokia Multimedia Terminal Gateway (TGW) enables operators to collect charging data directly from TGW’s logging subsystem. By collecting this data, operators can charge their customers for album services on a transaction basis. Charging data is stored in a format called a Call Detail Record (CDR). CDRs contain all the information necessary for a billing system to provide an invoice for a subscriber.Using MMS Application Administrator, TGW’s administrative interface, the administrator specifies the events that generate charging data for billing. Any event available in the TGW system can be selected for billing. These events are described in the appendices of this book.The administrator can also specify configuration parameters that determine the type, frequency of generation, and location of this charging data. These billing parameters are accessible from the System tab of the Configuration screen in the MMS Application Administrator. Transactions for billable events are stored in a buffer. At configurable intervals during the day CDRs go through post-processing. During post processing currently open buffers are closed, new buffers are opened, and the existing .cdr files are moved to a post-processed directory on the file system. The administrator can configure the number of buffers used, and maximum size of the each buffer. When the maximum size of a buffer is reached, the buffer is closed, a new buffer is opened, and the transactions are stored in a .cdr file. The administrator can specify the location of the post processed files. The administrator can optionally configure the system to generate CDRs in XML format. If the administrator turns on XML generation, during post-processing the XML content is generated from the .cdr file using the format specified in the Document Type Definition (DTD). If XML generation is used, all .cdr files being parsed are renamed to .old, to prevent the XML generator from generating the same XML content during the subsequent post-processing cycles. The XML file generated during post-processing is put into a separate directory.Operators can transfer the CDR files from the TGW system to the billing system using FTP (File Transfer Protocol) or NFS (Network File System). If XML CDRs are generated, they can be automatically sent to the outside billing system.



3 Creating and Processing Call Detail Records (CDRs)This chapter describes how the TGW system creates, processes, and post-processe CDRs. The creation and procesing of CDRs involves the following:• Specifying billable events – The events specified are recorded as transactions in the

CDR file.• Specifying how to process CDRs – The configuration parameters enable the

administrator to specify various factors including the format, frequency of generation, and location of CDRs.

3.1 Specifying billable events

Events are transactions that occur through the Web, WAP, or Nokia Artuse Multimedia Messaging Service Center (MMSC). Using the MMS Application Administrator, the TGW administrator can specify which of these events are recorded in the TGW billing log. When the events occur, the transactions are recorded in the billing log, and saved as CDRs during post processing.To select events:

1. From the MMS Application Administrator, click the Configuration button.2. Click the Event tab.3. From the Event tab of the Configuration screen, select billable events by putting a

check next to the event name in the CDR column.

Note: TGW and the MMSC share some common events. See Appendix B for more information.

See appendix A for a list and description of all the events that can be selected as billable.

3.2 Specifying how to process CDRs

The MMS Application Administrator includes billing properties that define how CDRs are created and processed. These billing properties are available from the System tab of the Configuration screen. To access the billing properties:

1. From the MMS Application Administrator, click the Configuration button.2. From the System tab of the Configuration screen, click the billing folder under

Configuration Parameters. The billing properties display to the right under the Properties toolbar.


3.2.1 CDR file names

TGW stores transaction information generated by billable events in a buffer. When the maximum size of a buffer is reached, the buffer is closed, and the CDR content is stored in a file. The buffer file size is specified using the cdrFileSize property. The CDR file name has the following format:• The timestamp when TGW opened the buffer• An underscore• The buffer sequence number • The extension .cdr The following example illustrates a CDR filename:

1001022755661_3.cdr

Note: In the event of a system failure, transaction information is saved in the raw file. When you restart the system, files for buffers that were open when the system failed will have the timestamp and buffer sequence number, but no extension. You can add the .cdr extension to these files and manually copy them to the post-processing directory.

3.2.2 Post-processing CDRs

At scheduled intervals throughout the day, specified using the cdrXmlProcessingStartTimes property in the MMS Application Administrator, the .cdr files are moved to a post-processed directory on the file system, and a new buffer is opened. You can define multiple buffers using the numberOfCdrFiles property. Using multiple buffers improves efficiency if you have a large number of concurrent transactions. If multiple buffers are used, TGW buffers transaction information to CDRs in a round-robin fashion. As a general rule you should start with five buffers, and increase to a maximum of 10 as increased transaction activity warrants.Using the generateXmlCdrs property, the administrator can specify whether CDRs are generated in XML. If XML generation is activated, the XML content is generated using the format specified in the Document Type Definition (DTD). If the administrator activates XML CDR generation, the storeXmlCdrs property must be set to True to store the XML generated CDR. The XML file is placed in a separate directory during post-processing. When XML generation is used, all .cdr files being parsed are renamed to .old, to prevent the XML generator from overwriting XML content during the subsequent post-processing cycles.The post processed CDRs in XML format can be sent to the billing center using HTTP (HTTP POST) at regular pre-configured intervals. To send the XML CDRs the sendXMLCdrs property must be set to True. The administrator must also specify the locations for posting the files using the billingCenterUrlSet property.



Note: The billing center operator must provide the server, and URL, for receiving the XML CDRs.

The administrator can specify (in hours) how long the post-processed flat and XML files remain on the system using the maximumStorageTimeForCdrFiles property. TGW automatically deletes all .xml, .cdr and .old files from the system that exceed the time limit specified by the administrator.

3.2.3 Billing properties used in CDR processing

The following two tables provide a reference for reviewing all the billing properties, default values, and descriptions. Table 4 lists all the billing properties the administrator can configure for setting up CDR processing. Table 5 lists all the billing properties that the administrator should not change.

Property Default value Description

cdrFileSize 1000 Range: 1:*

Maximum allowed size of CDR files (in bytes)

numberOfCdrFiles 1Range: 1:*

Number of simultaneous CDR and XML files to be generated

maximumStorageTimeForCdrFiles 72 Range: 1:*

Maximum storage time allowed for CDR and XML files (specified in hours)

processedCdrFileSystemName /opt/wluser/TGWBilling

Specification of path where post-processed flat CDR files are stored

rawCdrFileSystemName /opt/wluser/TGWBilling

Specification of path where raw (in-process) CDR files are stored

generateXmlCdrs false Range: true;false

Turn on or off the generation of CDRs in XML format.

Table 4 Billing configuration properties


cdrXmlProcessingStartTimes 0130 Comma-separated start times for CDR and XML post-processing (specified as hhmm, in 24 hour clock format)

billingCenterUrlSet http://localhost/ Comma-separated list of billing center URLs

storeXmlCdrs false Range: true;false

Indicates whether to store XML CDRs in the file system or not

sendXmlCdrs falseRange: true;false

Boolean value to indicate whether XML CDRs should be sent to the billing center

locationOfXmlCdrFiles /opt/wluser/TGWBilling

Specification of path where XML CDR files are stored


cdrXmlElementNameSet product,version,operation-type,event-time,logging-time,originating-address,destination-address,subscriber-address,transaction-id,message-id,mmsc-host,agw-host,tariff-class,message-octet-size,message-content-type,error-cause

Comma-separated list of field elements to use in an XML CDR

locationOfXmlCdrTemplate http://localhost/TestCDR.xml

Specification of path or URL where the XML CDR template is stored

cdrXmlElementName CDR Name of CDR element to use in XML CDR document

Table 5 Billing configuration properties that should not be changed


Table 4 Billing configuration properties



cdrXmlRootElementName CDRSet Name of root element in XML CDR document

cdrXmlAttributeIDName cdrID Name of ID attribute to use in XML CDR document

debugMode falseRange: true;false

Debug mode for the billing subsystem


Table 5 Billing configuration properties that should not be changed


Accessing and reading CDRs

4 Accessing and reading CDRs This chapter describes methods for:• Accessing CDRs• Reading CDRs

4.1 Accessing CDRs

There are two methods for transferring files between the TGW and billing systems. The following topics describe the following methods:• Manually transferring files • Automatically transferring CDRs in XML format

4.1.1 Manually transferring files

To transfer CDR files between the TGW system and the billing system, the billing operator must manually access them using one of the following methods:• File transfer protocol (FTP) - FTP is part of the Transmission Control Protocol/

Internet Protocol (TCP/IP). The FTP protocol includes rules that ensure a file is transmitted properly between the computer that stores the files (the FTP server) and the computer copying the files (the FTP client). To enhance security, the TGW system administrator should limit access to the TGW server for FTP transfers. To access CDRs on the TGW server, the billing system operator needs to know the IP address of the TGW server, the user name and password, and the directory where the files are stored.

• Network file system (NFS) - NFS allows machines to mount a disk partition on a remote machine as if it were on a local hard drive. This allows for fast, seamless sharing of files across a network. To use NFS, one machine is set up as the server and one or more machines as the client. The administrator for the server machine specifies rules that enable client access. The administrator of the client machine mounts the remote server directory the same way they would mount a local drive. In the NFS solution, the hard disk of TGW can be mounted to the billing computer or the billing computer hard disk can be mounted to the TGW server.

4.1.2 Automatically transferring CDRs in XML format

TGW can automatically distribute XML CDRs to a billing center. After the billing operator’s administrator configures a host and URL, TGW can generate XML-specific content that automatically gets posted to that host and URL for post-processing.


To send XML CDRs directly to the billing center, the TGW administrator must modify the following two properties of the TGW billing configuration:

sendXmlCdrsbillingCenterUrlSet

To modify the billing properties:

1. From the MMS Application Administrator, click the Configuration button.2. From the System tab of the Configuration screen, click the billing folder under

Configuration Parameters. The billing properties display to the right under the Properties toolbar.

3. Modify the following billing properties:sendXmlCdrs - Change the value of this property to true.billingCenterUrlSet - Type the billing center URL in the following format:

http://<billing host>/

Note: The billing center operator must provide the server, and URL, for receiving the XML CDRs.

4. Enter the IP address or domain name of the billing host machine for <billing host>.Use commas to separate multiple addresses. For example:

http://<billing host1>/,http://<billing host2>/

5. Click the Update button to save your changes.

4.2 Reading CDRs

The TGW system can produce CDRs in two file formats:• CDR format• XML formatThe following sections describe these two formats.

4.2.1 CDR file format

The CDR format is a flat file that contains a comma-separated list of fields that define a billable transaction. Each transaction starts on a new line. The structure of each transaction is as follows:

product,version,operation-type,event-time,logging-time,originating-address,destination-address,subscriber-address,transaction-id,message-id,mmsc-host,agw-host,tariff-class,message-octet-size,message-content-type,error-cause



The following is an example of a CDR transaction:tgw,1.0,10701,1020087936892,1020087936896,+1234567898,+12354567788,+1234567898,1020087936892,dfgt567,mmsc01,niaum00,44,-1,app,OK

4.2.2 CDR field descriptions

The following table describes the CDR’s fields. All fields are variable size. The table indicates whether fields are mandatory or optional. Mandatory fields must be present in a transaction for the transaction to be considered valid.

field description status

product tgw mandatory

version 1.0 mandatory

operation-type event number mandatory

event-time time of the event mandatory

logging-time current time mandatory

originating-address origin address mandatory

destination-address destination address(There could be multiple, whitespace-separated, destination-addresses.)

mandatory

subscriber-address subscriber address optional

transaction-id transaction ID of the request. Usually the initial timestamp

message-id message ID, if received from the MMSC

optional

mmsc-host originating / destination MMSC and port

optional

agw-host TGW machine mandatory

tariff-class tariff class used optional

message-octet-size octet size of the message content

optional

message-content-type content type optional

error-cause error description optional

Table 6 Field descriptions for CDR file


4.2.3 XML format

The XML format is produced from the CDR files during post processing following rules defined in the XML Document Type Definition (DTD). XML generation is optional, and must be specified by the administrator using the MMS Application Administrator.The XML CDR provides the billing data in a structured format. The XML CDR can also be automatically sent to the billing system

4.2.4 XML Document Type Definition (DTD)

The DTD is the statement of rules for an XML document that specifies which elements (the markup tags) and attributes (values associated with specific tags) are allowed in XML documents. The following schema is the DTD for CDRs in XML format.

Note: In the XML format, each destination-address is a separate element. Field names that are followed by a question mark (?) indicate optional fields.

<!ELEMENT CDRSet (CDR* )><!ELEMENT CDR (product, version, operation-type, event-time, logging-time, originating-address, destination-address+, subscriber-address?, transaction-id, message-id?, mmsc-host?, agw-host, tariff-class?, message-octet-size?, message-content-type?, error-cause? )><!ATTLIST CDR cdrID CDATA #REQUIRED ><!ELEMENT product (#PCDATA )><!ELEMENT version (#PCDATA )><!ELEMENT operation-type (#PCDATA )><!ELEMENT event-time (#PCDATA )><!ELEMENT logging-time (#PCDATA )><!ELEMENT originating-address (#PCDATA )><!ELEMENT destination-address (#PCDATA )><!ELEMENT subscriber-address (#PCDATA )><!ELEMENT transaction-id (#PCDATA )><!ELEMENT message-id (#PCDATA )><!ELEMENT mmsc-host (#PCDATA )><!ELEMENT agw-host (#PCDATA )><!ELEMENT tariff-class (#PCDATA )><!ELEMENT message-octet-size (#PCDATA )><!ELEMENT message-content-type (#PCDATA )><!ELEMENT error-cause (#PCDATA )>



XML exampleThe following example shows the XML format of a CDR record. <CDR> <product>tgw</product> <version>1.0</version> <operation-type>10701</operation-type> <event-time>24.06.2001 12:50:44 </event-time> <logging-time>24.06.2001 12:50:54 </logging-time> <originating-address>+358125556789</originating-address> <destination-address>+3581985554321 </destination-address> <transaction-id>4840555644066</transaction-id> <message-id>dfkfrf6666gX0001</message-id> <mmsc-host>webaddress.com</mmsc-host> <agw-host>webaddress.com</agw-host>) <tariff-class>44</tariff-class> <message-octet-size>10201</message-octet-size> <message-content-type>application/vnd.wap.mms-message</message-content-type> <error-cause>some description</error-cause> </CDR>


Appendix A: Description of available TGW events

The following table provides a list of all available TGW event numbers, the corresponding event names, and a short description of the event.

Event number Event name Description

10000 STORE_MM_REQUEST Request the Multimedia Manager request types: Store multimedia message request.

10001 STORE_MM_REPLY Reply to the store multimedia message request

10002 DELETE_MM_REQUEST Request to delete multimedia message from the personal album.

10003 DELETE_MM_REPLY Reply to the delete multimedia message request

10004 BROWSE_MM_REQUEST Request to browse personal album.

10005 BROWSE_MM_REPLY Reply to browse personal album action.

10006 FORWARD_MM_REQUEST Request to forward multimedia message.

10007 FORWARD_MM_REPLY Reply to forward multimedia message.

10008 SEND_MM_REQUEST Request to send the multimedia message.

10009 SEND_MM_REPLY Reply to send multimedia message.

10010 RETRIEVE_MM_REQUEST Request to retrieve the multimedia message.

10011 RETRIEVE_MM_REPLY Reply to retrieve multimedia message.

10012 STORE_MM_REQUEST_PAB Request to store multimedia message in a personal album.

Table 7 Description of available TGW events


10013 STORE_MM_REQUEST_NAB Request to store multimedia message in a new album.

10014 STORE_MM_REQUEST_TAB Request to store multimedia message in a Temp folder

10015 FORWARD_MM_REQUEST_FROM_WEBWAP_TO_MMSC

Request to forward multimedia message from (Web/WAP) to MMSC

10016 FORWARD_MM_REQUEST_FROM_WEBWAP_TO_EMAIL

Request to forward multimedia message from (Web/WAP) to e-mail address.

10017 RETRIEVE_MM_REQUEST_FROM_WAP_TO_MMS

Request to retrieve the multimedia message from WAP to MMSC

10018 RETRIEVE_MM_REQUEST_FROM_WAP_TO_EMAIL

Request to retrieve the multimedia message from WAP to a composed e-mail address.

10019 SEND_MM_REQUEST_FROM_WEB_TO_MMSC

Send a composed multimedia message request from Web to MMSC.

10020 SEND_MM_REQUEST_FROM_WEB_TO_EMAIL

Request to send a composed multimedia message from Web to e-mail address.

10200 SEND_EMAIL_REQUEST Request to send e-mail message request.

10201 SEND_EMAIL_REPLY Send a Reply to an email message.

10202 SMTP_SERVER_DOWN SMTP Server down

10203 SMTP_SERVER_UP SMTP server started

10300 TRAP_REQUEST Request to the trap manager




10400 BILLING_REQUEST Request to the billing manager.

10401 BILLING_REPLY Reply to billing request.

10402 BILLING_LOGGER_LISTENER_CREATE_FAILED_CRITICAL

Critical error; unable to create the billing/logger listener.

10403 BILLING_MANAGER_CREATE_FAILED_CRITICAL

Critical error; unable to create billing manager.

10404 BILLING_MD_BEAN_CREATE_FAILED_CRITICAL

Critical error; unable to create a billing java bean.

10405 BILLING_XML_PROCESSOR_BEAN_CREATE_FAILED_CRITICAL

Critical error; unable to process an XML billing java bean.

10500 LOG_REQUEST Request to the log.

10501 LOG_REPLY Reply to a log request.

10502 LOG_DEBUG Set logging to debug levels.

10503 LOG_WARNING Set logging to warning level.

10504 LOG_TRACE Log tracing information.

10505 LOG_EXCEPTION The log threw an exception.

10506 LOG_MAJOR Log a major problem.

10507 LOGGER_INIT_COMPLETE Logger Init complete event

10508 LOGGER_SHUTDOWN Logger Shutdown

10509 LOG_INFO Log Info

10600 PERF_DATA Performance Manager: Performance data

10700 Login The MMSC Interface: MMSC Terminating Async Receiver-Originated App.




10701 Forward Msg MMSC Message Received by Servlet.

10702 Retrieve Msg MMSC Message Received by TGW application.

10703 Compose Msg MMSC Message Queued by interface application.

10704 Change Email MMSC Message Received by interface application.

10705 View Folder MMSC Message Rejected by Servlet.

10706 View Menu MMSC Message Rejected by TGW application.

10707 Delete Msg MMSC Message Rejected by interface application.

10708 Move Msg MMSC Message successfully processed by Servlet.

10709 Rename Msg MMSC Message successfully processed by TGW application.

10710 Send Msg MMSC Terminating Async Receiver-Originated App Reply.

10711 View Msg

10712 Change Password MMSC Message Reply Received by TGW application.

10713 TMAR_REPLY_QUEUED_TGW MMSC message reply queued by TGW application.

10714 TMAR_REPLY_RECEIVED_INTERFACE MMSC Message Reply Received by interface application.




10716 TMAR_REPLY_REJECTED_TGW MMSC message reply rejected by TGW application.

10717 TMAR_REPLY_REJECTED_INTERFACE MMSC Message Reply Rejected by interface application.

10719 TMAR_REPLY_PROCESSED_INTERFACE

MMSC Message Reply successfully processed by interface application.

10720 TERMINATING_MM_SYNC_RECEIVER MMSC Terminating Sync Receiver-Originated App.

10721 TMSR_MESSAGE_RECEIVED_SERVLET

MMSC message received by servlet.

10722 TMSR_MESSAGE_RECEIVED_TGW MMSC message received by TGW application.

10723 TMSR_MESSAGE_QUEUED_INTERFACE

MMSC Message Queued by interface application.

10724 TMSR_MESSAGE_RECEIVED_INTERFACE

MMSC Message Received by interface application.

10725 TMSR_MESSAGE_REJECTED_SERVLET

MMSC message rejected by Servlet.

10726 TMSR_MESSAGE_REJECTED_TGW MMSC message rejected by TGW application.

10727 TMSR_MESSAGE_REJECTED_INTERFACE

MMSC Message Rejected by interface application.

10728 TMSR_MESSAGE_PROCESSED_SERVLET

MMSC message successfully processed by servlet.

10729 TMSR_MESSAGE_PROCESSED_TGW MMSC message successfully processed by TGW application.




10730 TERMINATING_MM_ASYNC_SENDER MMSC Terminating Async Sender-Originated App.

10740 TERMINATING_MM_ASYNC_SENDER_REPLY

MMSC Terminating Async Sender-Originated App Reply.

10750 TERMINATING_MM_SYNC_SENDER MMSC Terminating Sync Sender-Originated App.

10760 TERMINATING_MM_ASYNC_DELIVERY_FAILURE

MMSC Terminating Async Delivery Failure-Originated App.

10761 TMAD_MESSAGE_RECEIVED_SERVLET


10762 TMAD_MESSAGE_RECEIVED_TGW MMSC message received by TGW application.

10763 TMAD_MESSAGE_QUEUED_INTERFACE


10764 TMAD_MESSAGE_RECEIVED_INTERFACE


10765 TMAD_MESSAGE_REJECTED_SERVLET

MMSC message rejected by servlet.

10766 TMAD_MESSAGE_REJECTED_TGW MMSC message rejected by TGW application.

10767 TMAD_MESSAGE_REJECTED_INTERFACE

MMSC message rejected by interface application.

10768 TMAD_MESSAGE_PROCESSED_SERVLET

MMSC message successfully processed by Servlet.

10769 TMAD_MESSAGE_PROCESSED_TGW MMSC Message successfully processed by TGW application.




10770 TERMINATING_MM_ASYNC_DELIVERY_FAILURE_REPLY

MMSC Terminating Async Delivery Failure-Originated App Reply.

10772 TMAD_REPLY_RECEIVED_TGW MMSC Message Reply Received by TGW application.

10773 TMAD_REPLY_QUEUED_TGW MMSC message reply Queued by TGW application.

10774 TMAD_REPLY_RECEIVED_INTERFACE MMSC message reply received by interface application.

10776 TMAD_REPLY_REJECTED_TGW MMSC message reply Rejected by TGW application.

10777 TMAD_REPLY_REJECTED_INTERFACE MMSC Message Reply rejected by interface application.

10779 TMAD_REPLY_PROCESSED_INTERFACE


10780 TERMINATING_MM_SYNC_DELIVERY_FAILURE

MMSC Terminating Sync Delivery Failure-Originated App.

10781 TMSD_MESSAGE_RECEIVED_SERVLET


10782 TMSD_MESSAGE_RECEIVED_TGW MMSC Message received by TGW application.

10783 TMSD_MESSAGE_QUEUED_INTERFACE

MMSC message queued by interface application.

10784 TMSD_MESSAGE_RECEIVED_INTERFACE





10785 TMSD_MESSAGE_REJECTED_SERVLET

MMSC message rejected by servlet.

10786 TMSD_MESSAGE_REJECTED_TGW MMSC message rejected by TGW application.

10787 TMSD_MESSAGE_REJECTED_INTERFACE


10788 TMSD_MESSAGE_PROCESSED_SERVLET

MMSC message successfully processed by servlet.

10789 TMSD_MESSAGE_PROCESSED_TGW MMSC message successfully processed by TGW application.

10790 ORIGINATING_MM MMSC Originating App.

10791 O_MESSAGE_RECEIVED_TGW MMSC message received by TGW application.

10792 O_MESSAGE_QUEUED_TGW MMSC message queued by TGW application.

10793 O_MESSAGE_RECEIVED_INTERFACE MMSC Message Received by interface application.

10794 O_MESSAGE_REJECTED_TGW MMSC message rejected by TGW application.

10795 O_MESSAGE_REJECTED_INTERFACE MMSC Message Rejected by interface application.

10796 O_MESSAGE_PROCESSED_INTERFACE

MMSC Message successfully processed by interface application.




10797 O_ASYNC_REPLY_PROCESSED_INTERFACE

MMSC Async Reply successfully processed by interface application.

10799 MMSC_UNKNOWN Unknown MMSC-related App.

10801 SMS_SUBSYSTEM_INIT Initialization of SMS complete

10802 SMS_SUBSYSTEM_SHUTDOWN SMS system down.

10803 SEND_SMS Send SMS Message

10804 SMS_SEND_SUCCESS Successful SMS Sent.

10805 SMS_SEND_FAIL Failed SMS Send.

11700 TERMINATING_MESSAGE_RECEIVED_SERVLET

MMSC terminating message received by Servlet.

11701 MMSC_LICENSING_DELIVERY_FAILURES

License check failed.

11702 MMSC_LICENSING_MESSAGE_STORES

MMSC Licensing Manager - Message Stores.

11703 MMSC_LICENSING_OUTGOING_MESSAGES

MMSC Licensing Manager - Outgoing Messages.

11704 MMSC_LICENSING_TOTAL_MESSAGES

MMSC Licensing Manager - Total Messages.

11705 MMSC_LICENSING_DELIVERY_FAILURES_EXCEEDED

Message delivery failed because license exceeded.

11706 MMSC_LICENSING_MESSAGE_STORES_EXCEEDED

No more messages can be stored with the license.

11707 MMSC_LICENSING_OUTGOING_MESSAGES_EXCEEDED

No more outgoing messages can be sent; license exceeded.




11708 MMSC_LICENSING_TOTAL_MESSAGES_EXCEEDED

MMSC Licensing Manager - Total Messages.

11728 TMSR_MESSAGE_FILTERED_SERVLET MMSC Message successfully filtered by TMSR Servlet.

11729 TMSD_MESSAGE_FILTERED_SERVLET MMSC Message successfully filtered by TMSD Servlet.

11780 TMSD_SERVLET_INIT_FAILED_CRITICAL

MMSC TMSD Servlet initialization failed.

11781 TMAD_SERVLET_INIT_FAILED_CRITICAL

MMSC TMAD Servlet initialization failed.

11782 MMSC_RECEIVER_CREATE_FAILED_CRITICAL

MMSC Receiver initialization failed.

11783 MMSC_SENDER_CREATE_FAILED_CRITICAL

MMSC Sender initialization failed.

11784 MMSC_CONNECTION_FAILED_CRITICAL

MMSC Connection initialization failed.

11785 TMSR_SERVLET_INIT_FAILED_CRITICAL

MMSC TMSR Servlet initialization failed.

11786 TMAR_SERVLET_INIT_FAILED_CRITICAL

MMSC TMAR Servlet initialization failed.

11787 MMSC_CONFIG_CHANGE_EVENT Configuration change made.

11788 MMSC_RECEIVER_EVENT Generic operation type for MMSC Receiver events.

11789 MMSC_SENDER_EVENT Generic operation type for MMSC Sender events.

12000 ATTRIBUTE_CHANGE Attribute value change event

12001 ENTRY_CREATION New Entry created

12002 INVALID_AVC Invalid Attribute value change




12003 ENTRY_DELETION Entry deleted

12004 STATE_CHANGE State change of a subsystem

12005 INIT_COMPLETE Initialisation complete of the subsystem

12006 SHUTDOWN_COMPLETE Shutdown of the subsystem done

13001 Successful message store to personal album This event is generated after the message is successfully stored in the PA.

13002 Successful message store to new album This event is generated after the message is successfully stored in the NA.

13003 Successful store of temporary message This event is generated after the message is successfully stored in the temporary album.

13004 Failed message store to personal album This event is generated after the message is unsuccessfully stored in the PA.

13005 Failed message store to new album This event is generated after the message is unsuccessfully stored in the NA.

13006 Failed store of temporary message This event is generated after the message is unsuccessfully stored in the temporary folder album.

13011 Successful user mailbox creation This event is generated when the user albums are successfully provisioned

13012 Failed to create user mailbox This event is generated when the user albums failed to be provisioned.




13013 Successful user mailbox removal This event is generated when a user album is successfully removed.

13014 Failed to remove user mailbox This event is generated when a user albums failed to be removed

14001 WEB_SUBSCRIBER_LOGIN This event is generated after the subscriber has been successfully validated from the Web.

14002 WEB_SUBCSRIBER_LOGOUT This event is generated after the subscriber on the Web has been successfully logged out.

14003 WEB_SUBCSRIBER_VIEW_MSG This event is generated when the Web subscriber wants to retrieve a message from the PA or NA.

14004 WEB_SUBSCRIBER_MOVE_MSG The Message Store generates this event after the message has been successfully moved from the NA to the PA on the Web.

14005 WEB_SUBSCRIBER_RENAME_MSG The Message Store generates this event after the message has been successfully renamed on the Web.

14006 WEB_SUBSCRIBER_FOWARD_MSG The MMSC Sender generates this event after the message has been successfully sent to the MMSC. The SMTP component generates this event after the message has been successfully sent to the SMTP server.




14007 WEB_SUBSCRIBER_COMPOSE_MSG The MMSC Sender generates this event after the message has been successfully sent to the MMSC on the Web.

14008 WEB_SUBSCRIBER_DELETE_PA_MSG The Message Store generates this event after a message is successfully deleted from the PA on the Web.

14009 WEB_SUBSCRIBER_DELETE_NA_MSG The Message Store generates this event after a message is successfully deleted from the NA on the Web.

14010 WEB_VIEW_TMP_MSG The UI Servlet generates this event after a message is successfully returned to the non-subscriber on the Web.

14011 WEB_BROWSE_PA_MSG The UI Servlet generates this event after a user browses their PA via the Web interface

14012 WEB_BROWSE_NA_MSG The UI Servlet generates this event after a user browses their NA via the Web interface

14101 WAP_SUBSCRIBER_LOGIN This event is generated after the subscriber has been successfully validated from the WAP interface.

14102 WAP_SUBSCRIBER_LOGOUT This event is generated after the subscriber has been successfully logged out.




14103 WAP_SUBSCRIBER_VIEW_MSG This event is generated when the user retrieves a message via the Wap menu.

14104 WAP_SUBSCRIBER_MOVE_MSG The Message Store generates this event after the message has been successfully moved from the NA to the PA via WAP.

14105 WAP_SUBSCRIBER_RENAME_MSG The Message Store generates this event after the message has been successfully renamed via the WAP.

14106 WAP_SUBSCRIBER_FORWARD_MSG The MMSC Sender generates this event after the message has been successfully sent to the MMSC from the WAP. The SMTP component generates this event after the message has been successfully sent to the SMTP server via WAP.

14107 WAP_SUBSCRIBER_DELETE_PA_MSG The Message Store generates this event after a message is successfully deleted from the PA via WAP.

14108 WAP_SUBSCRIBER_DELETE_NA_MSG The Message Store generates this event after a message is successfully deleted from the NA via WAP.

14109 WAP_BROWSE_PA_MSG This event is generated after a user browses their PA via the WAP interface




14110 WAP_BROWSE_NA_MSG The Wap Servlet generates this event after a user browses their NA via the WAP interface

15001 LIC_EXCEED_SUB_COUNT This event is generated by the Message Store when an attempt is made to create a subscriber after the license has been used up.

15002 LIC_EXCEED_EAIF_TPS This event is generated when the number of transactions per second has exceeded the license threshold.

15003 LIC_CURRENT_EAIF_TPS This event is generated each time the MMSC logs transactions per second over the limit.

15101 SUBSCRIBER_CREATED This event is generated after a subscriber has been successfully created .

15102 SUBSCRIBER_UPDATED This event is generated after the subscriber has been successfully modified.

15103 SUBSCRIBER_DEACTIVATED This event is generated after the subscriber has been successfully deactivated.

15104 SUBSCRIBER_ACTIVATED This event is generated after the subscriber has been successfully activated.




Appendix B: Description of events common to both TGW and the MMSC

When the administrator specifies events as billable, TGW relays the generated CDRs to an external billing system. In cases where the same event occurs in both the TGW and the Multimedia Messaging Service Center (MMSC) systems, the administrator can ensure that the customer is not billed twice by generating a CDR file for that event only in the MMSC.The following table identifies events that occur in both TGW and the MMSC.


10000 STORE_MM_REQUEST Request the Store Multimedia message.

10001 STORE_MM_REPLY Reply to the store multimedia message request

10006 FORWARD_MM_REQUEST Request to forward multimedia message.

10007 FORWARD_MM_REPLY Reply to forward multimedia message.

10008 SEND_MM_REQUEST Request to send the multimedia message.

10009 SEND_MM_REPLY Reply to send the multimedia message.

10010 RETRIEVE_MM_REQUEST Request to retrieve the multimedia message.

10011 RETRIEVE_MM_REPLY Reply to retrieve multimedia message.

10012 STORE_MM_REQUEST_PAB Request to store multimedia personnal album.

10013 STORE_MM_REQUEST_NAB Request to store multimedia message in a new album.

10014 STORE_MM_REQUEST_TAB Store MultiMedia Request to Temp folder

Table 8 Description of events common to both TGW and the MMSC


10015 FORWARD_MM_REQUEST_FROM_WEBWAP_TO_MMSC

Forward multimedia message request from (Web/WAP) to MMSC

10017 RETRIEVE_MM_REQUEST_FROM_WAP_TO_MMS

Retrieve the multimedia message request from (WAP) to MMSC

10019 SEND_MM_REQUEST_FROM_WEB_TO_MMSC

Send a composed multimedia message request from Web to MMSC

10701 Forward Msg MMSC Message Received by Servlet.

10702 Retrieve Msg MMSC Message Received by TGW application.

10703 Compose Msg MMSC Message Queued by interface application.

10704 Change Email MMSC Message Received by interface application.

10705 View Folder MMSC Message Rejected by Servlet.

10706 View Menu MMSC Message Rejected by TGW application.

10707 Delete Msg MMSC Message Rejected by interface application.

10708 Move Msg MMSC Message successfully processed by Servlet.

10709 Rename Msg MMSC Message successfully processed by TGW application.

10710 Send Msg MMSC Terminating Async Receiver-Originated App Reply.




10713 TMAR_REPLY_QUEUED_TGW MMSC Message Reply Queued by TGW application.

10714 TMAR_REPLY_RECEIVED_INTERFACE

MMSC Message Reply Received by interface application.

10716 TMAR_REPLY_REJECTED_TGW MMSC Message Reply Rejected by TGW application.

10717 TMAR_REPLY_REJECTED_INTERFACE

MMSC Message Reply Rejected by interface application.

10719 TMAR_REPLY_PROCESSED_INTERFACE


10720 TERMINATING_MM_SYNC_RECEIVER

MMSC Terminating Sync Receiver-Originated App.

10721 TMSR_MESSAGE_RECEIVED_SERVLET

MMSC Message Received by Servlet.

10722 TMSR_MESSAGE_RECEIVED_TGW MMSC Message Received by TGW application.

10723 TMSR_MESSAGE_QUEUED_INTERFACE


10724 TMSR_MESSAGE_RECEIVED_INTERFACE


10725 TMSR_MESSAGE_REJECTED_SERVLET

MMSC Message Rejected by Servlet.

10726 TMSR_MESSAGE_REJECTED_TGW MMSC Message Rejected by TGW application.

10727 TMSR_MESSAGE_REJECTED_INTERFACE





10728 TMSR_MESSAGE_PROCESSED_SERVLET

MMSC Message successfully processed by Servlet.

10729 TMSR_MESSAGE_PROCESSED_TGW

MMSC Message successfully processed by TGW application.

10730 TERMINATING_MM_ASYNC_SENDER

MMSC Terminating Async Sender-Originated App.

10740 TERMINATING_MM_ASYNC_SENDER_REPLY

MMSC Terminating Async Sender-Originated App Reply.

10750 TERMINATING_MM_SYNC_SENDER

MMSC Terminating Sync Sender-Originated App.

10760 TERMINATING_MM_ASYNC_DELIVERY_FAILURE

MMSC Terminating Async Delivery Failure-Originated App.

10761 TMAD_MESSAGE_RECEIVED_SERVLET


10762 TMAD_MESSAGE_RECEIVED_TGW MMSC Message Received by TGW application.

10763 TMAD_MESSAGE_QUEUED_INTERFACE


10764 TMAD_MESSAGE_RECEIVED_INTERFACE


10765 TMAD_MESSAGE_REJECTED_SERVLET


10766 TMAD_MESSAGE_REJECTED_TGW MMSC Message Rejected by TGW application.

10767 TMAD_MESSAGE_REJECTED_INTERFACE





10768 TMAD_MESSAGE_PROCESSED_SERVLET


10769 TMAD_MESSAGE_PROCESSED_TGW


10770 TERMINATING_MM_ASYNC_DELIVERY_FAILURE_REPLY

MMSC Terminating Async Delivery Failure-Originated App Reply.

10772 TMAD_REPLY_RECEIVED_TGW MMSC Message Reply Received by TGW application.

10773 TMAD_REPLY_QUEUED_TGW MMSC Message Reply Queued by TGW application.

10774 TMAD_REPLY_RECEIVED_INTERFACE

MMSC Message Reply Received by interface application.

10776 TMAD_REPLY_REJECTED_TGW MMSC Message Reply Rejected by TGW application.

10777 TMAD_REPLY_REJECTED_INTERFACE

MMSC Message Reply Rejected by interface application.

10779 TMAD_REPLY_PROCESSED_INTERFACE


10780 TERMINATING_MM_SYNC_DELIVERY_FAILURE

MMSC Terminating Sync Delivery Failure-Originated App.

10781 TMSD_MESSAGE_RECEIVED_SERVLET


10782 TMSD_MESSAGE_RECEIVED_TGW MMSC Message Received by TGW application.

10783 TMSD_MESSAGE_QUEUED_INTERFACE





10784 TMSD_MESSAGE_RECEIVED_INTERFACE


10785 TMSD_MESSAGE_REJECTED_SERVLET


10786 TMSD_MESSAGE_REJECTED_TGW MMSC Message Rejected by TGW application.

10787 TMSD_MESSAGE_REJECTED_INTERFACE


10788 TMSD_MESSAGE_PROCESSED_SERVLET


10789 TMSD_MESSAGE_PROCESSED_TGW


10790 ORIGINATING_MM MMSC Originating App.

10791 O_MESSAGE_RECEIVED_TGW MMSC Message Received by TGW application.

10792 O_MESSAGE_QUEUED_TGW MMSC Message Queued by TGW application.

10793 O_MESSAGE_RECEIVED_INTERFACE


10794 O_MESSAGE_REJECTED_TGW MMSC Message Rejected by TGW application.

10795 O_MESSAGE_REJECTED_INTERFACE


10796 O_MESSAGE_PROCESSED_INTERFACE

MMSC Message successfully processed by interface application.




10797 O_ASYNC_REPLY_PROCESSED_INTERFACE

MMSC Async Reply successfully processed by interface application.

10799 MMSC_UNKNOWN Unknown MMSC-related App.

10803 SEND_SMS Send SMS Message

10804 SMS_SEND_SUCCESS SMS Send Success

10805 SMS_SEND_FAIL SMS Send Fail

11700 TERMINATING_MESSAGE_RECEIVED_SERVLET

The MMSC Interface: MMSC Terminating Message received by Servlet.




TGW 1.0.3 Billing Spec

Documents

Transcript of TGW 1.0.3 Billing Spec