77 BRM Rating EDR Container Description

This chapter describes the rating EDR container fields that are used by Oracle Communications Billing and Revenue Management (BRM) Pipeline Manager.

Naming Conventions

The following definitions listed in Table 77-1 are used in this document to describe the record format:

Table 77-1 Record Format Definitions

Symbol Meaning

X

Alphanumeric, left-justified, filled with trailing spaces to the right.

Z

Numeric, left-justified, filled with trailing spaces to the right.

H

Hexadecimal value (0-9, A-F), right-justified, filled with leading zeros to the left.

9

Numeric, right-justified, filled with leading zeros to the left.

(m)

Specifies the length in characters: mandatory.

[n]

Specifies the decimal precision. Optional.

Oracle CDR Format

The Oracle CDR format is the standard file structure used by Pipeline Manager to process CDRs during the input and output processes.

The Oracle CDR format has the following characteristics:

  • Each record is separated by a newline character (\n).

  • Each record contains data for one service only.

  • Each record contains a fixed number of fields.

  • Each field is tab delimited (\t).

  • Each field is in a specified position within a record. For example, the first field in the Header Record is the Record Type, the second is the Sender, and so forth.

    Note:

    If a field does not have a value, the field is left blank. The result is a tab followed by another tab.

  • Each field has a specified data type and format. For example, the A number must be a string that is 10 characters long.

To process CDRs, Pipeline Manager converts the CDRs to the internal EDR format by using the stream format, grammar, and mapping description files.

The stream format file describes the structure of the Oracle CDR format.

The following example shows the section of the stream format description file that describes the format of the Header Record. The Header Record is identified by the record type 010. The fields are separated by a tab (\t), and the record is terminated by a newline character (\n). It specifies the list the fields in the record. The first field is the record type (RECORD_TYPE), the second is the record number (RECORD_NUMBER), and so forth. RECORD_TYPE uses the AscString() data type, RECORD_NUMBER uses the AscInteger( ) data type.

HEADER(SEPARATED)
{
Info
{
Pattern = "010.*\n";
FieldSeparator = '\t';
RecordSeparator = '\n';
}
RECORD_TYPE                      AscString();
RECORD_NUMBER                    AscInteger();
SENDER                           AscString();
RECIPIENT                        AscString();
SEQUENCE_NUMBER                  AscInteger();
ORIGIN_SEQUENCE_NUMBER           AscInteger();
CREATION_TIMESTAMP               AscDate();
TRANSMISSION_DATE                AscDate("%Y%m%d");
TRANSFER_CUTOFF_TIMESTAMP        AscDate();
UTC_TIME_OFFSET                  AscString();
SPECIFICATION_VERSION_NUMBER     AscInteger();
RELEASE_VERSION                   AscInteger();
ORIGIN_COUNTRY_CODE               AscString();
SENDER_COUNTRY_CODE               AscString();
DATA_TYPE_INDICATOR               AscString();
IAC_LIST                          AscString();
CC_LIST                           AscString();
UTC_END_TIME_OFFSET               AscString();
}

The grammar files are used to verify the data formats and to normalize the data. For example, if a field is supposed to be 10 characters, Pipeline Manager uses the grammar file to perform this check. If the data is of an incorrect format, the CDR is rejected.

The mapping files are used to map CDR fields to the EDR container fields.

The following example shows a section of the InMap description file, which is used during the input process. This example shows how the fields in the Header Record of a CDR are mapped to the EDR container fields.

HEADER 
{
STD_MAPPING
{
RECORD_TYPE                  -> HEADER.RECORD_TYPE;
RECORD_NUMBER                -> HEADER.RECORD_NUMBER;
SENDER                       -> HEADER.SENDER;
RECIPIENT                    -> HEADER.RECIPIENT;
SEQUENCE_NUMBER              -> HEADER.SEQUENCE_NUMBER;
ORIGIN_SEQUENCE_NUMBER       -> HEADER.ORIGIN_SEQUENCE_NUMBER;
CREATION_TIMESTAMP           -> HEADER.CREATION_TIMESTAMP;
TRANSMISSION_DATE            -> HEADER.TRANSMISSION_DATE;
TRANSFER_CUTOFF_TIMESTAMP    -> HEADER.TRANSFER_CUTOFF_TIMESTAMP;
UTC_TIME_OFFSET              -> HEADER.UTC_TIME_OFFSET;
SPECIFICATION_VERSION_NUMBER -> HEADER.SPECIFICATION_VERSION_NUMBER;
RELEASE_VERSION              -> HEADER.RELEASE_VERSION;
ORIGIN_COUNTRY_CODE          -> HEADER.ORIGIN_COUNTRY_CODE;   
SENDER_COUNTRY_CODE          -> HEADER.SENDER_COUNTRY_CODE;
DATA_TYPE_INDICATOR          -> HEADER.DATA_TYPE_INDICATOR;
IAC_LIST                     -> HEADER.IAC_LIST;
CC_LIST                      -> HEADER.CC_LIST;
UTC_END_TIME_OFFSET          -> HEADER.UTC_END_TIME_OFFSET;
}
}

EDR Format Structure

The BRM EDR format consists of the following components:

  1. Exactly one Header Record. Record type 010.

  2. Zero or more Basic Records in no specific order:

    1. Basic Detail Record; for example, record type 020.

    2. More basic records might be defined in the future.

  3. Zero or more Associated Records, related to one Basic Record, in the following order:

    1. Associated Service Extension Records; for example, record type 520.

    2. Associated CAMEL Extension Records. Record type 700.

    3. Associated BRM Balance Record. Record type 900.

    4. Associated Zone Breakdown Record; for example, record type 960.

    5. Associated Charge Breakdown Record; for example, record type 981.

    6. Associated Message Description Record. Record type 999.

  4. Exactly one Trailer Record. Record type 090.

Example Structure

Table 77-2 contains an example BRM EDR structure.

Table 77-2 BRM EDR Example Structure

Record Description

Header Record: 010

Once. Mandatory.

Basic Detail Record: 040

Once. Optional.

Associated GPRS Extension Record: 540

Once. Optional.

Associated CAMEL Extension Record: 700

Once. Optional.

Associated BRM Balance Record: 900

Once. Optional.

Supplementary Balance Impact Packet Record: 600

n times. Mandatory 1-n.

Supplementary Sub-Balance Impact Packet Record: 605

n times. Mandatory 1-n.

Supplementary Sub-Balance Info Packet Record: 607

n times. Mandatory 1-n.

Associated Zone Breakdown Record: 961

n times. Optional.

Supplementary Zone Packet Record: 660

n times. Mandatory 1-n.

Associated Charge Breakdown Record: 981

n times. Optional.

Supplementary Charge Packet Record: 660

n times. Mandatory 1-n.

Associated Message Description Record: 999

n times. Optional.

Basic Detail Record: 070

Once. Optional.

Associated WAP Extension Record: 550

Once. Optional.

Associated BRM Balance Record: 900

Once. Optional.

Supplementary Balance Impact Packet Record: 600

n times. Mandatory 1-n.

Supplementary Sub-Balance Impact Packet Record: 605

n times. Mandatory 1-n.

Supplementary Sub-Balance Info Packet Record: 607

n times. Mandatory 1-n.

Associated Charge Breakdown Record: 981

n times. Optional.

Supplementary Charge Packet Record: 660

n times. Mandatory 1-n.

Basic Detail Record: 021

Once. Optional.

Associated GSM Extension Record: 520

Once. Optional.

Supplementary Service Event Record: 520

n times. Optional.

Basic Service Event Record: 520

n times. Optional.

Associated CAMEL Extension Record: 700

Once. Optional.

Associated Charge Breakdown Record: 981

n times. Optional.

Supplementary Charge Packet Record: 660

n times. Mandatory 1-n.

Basic Detail Record: 127

Once. Optional.

Associated Charge Breakdown Record: 981

n times. Optional.

Basic ...

None

Associated …

None

Supplementary …

None

Trailer Record: 090

Once. Mandatory.

Expected File Name

The BRM EDR file name uses a format of SOL42_SenderRecipientSequence_number.DAT. Table 77-3 describes the attributes used in the file name.

Table 77-3 EDR File Name Attributes

Item Format Description

Sender

X(5)

code for the sender of the file (for example, D00D1)

Recipient

X(5)

code for the recipient of the file (for example, SOL42)

Sequence_number

9(6)

sequence number of the file (000000 to 999999)

Example: "SOL42_D00D1SOL42004711.DAT"

Record Type Ranges

The Record Type Ranges listed in Table 77-4 are defined:

Table 77-4 Record Type Ranges

Range Record type

000 - 009

Reserved for internal usage

010

Header Record

011 - 019

Reserved for Basic Address Records

020 - 089

Basic Detail Records

090

Trailer Record

091 - 099

Reserved for internal usage

100 - 299

Basic Detail Records

300 - 319

Basic Recharge Records

320 - 399

Free

400 - 499

Reserved for further Basic Record Types

500 - 599

Associated Service Extension Records

600 - 699

Supplementary Records (for former Sub-Blocks of Associated Records)

700 - 749

Associated CAMEL / IN Records

750 - 799

Reserved for further Associated Record Types

800 - 899

Free

900 - 949

Associated Balance Records

950 - 959

Reserved for further Record Types

960 - 969

Associated Zone Breakdown Records

970 - 998

Associated Charge Breakdown Records

999

Associated Message Description Record

Note:

Not all of the given Record Types have been defined. Undefined values are reserved for future use.

Header Record (RECType 010)

This record is always the first record within a file. Table 77-5 describes the fields in the Header Record.

Table 77-5 Header Record Fields

Name Format Description

RECORD_ LENGTH

Integer

Optional for backward compatibility.

RECORD_TYPE

String

Extended to be 3 bytes long, first byte denotes the market; for example, GSM, ISDN.010.

Derivation:

Mandatory. Set by the first processor and left unchanged.

RECORD_NUMBER

9(9)

Sequence number of the record in the file. Ensures a linear sequence order for all records; for example, as a sorting criteria.

Derivation:

Mandatory. Set by the first processor. Always 000000001.

SENDER

X(10)

Unique identifier of the PLMN or physical (network) operator, which is sending the file; used to determine the network, which is the sender of the data. The full list of mobile codes in use is given in MoU TADIG PRD TD. 13: PLMN Naming Conventions.

Specifies a unique NOSP_ID together with the RECIPIENT. Can also be used to determine the network operator responsible for the CDRs.

Derivation:

Optional, but should be defaulted if not present on the input side, for example, by own NO-Id, for example, 'DTAG'. Set by the first processor and left unchanged.

RECIPIENT

X(10)

Unique identifier of the PLMN or physical (network) operator to whom the file is being sent. See the MoU TADIG PRD TD. 13: PLMN Naming Conventions for a list of mobile codes.

Specifies a unique NOSP_ID together with the SENDER. Can also be used to determine the reseller or service provider who is responsible for billing these events.

Derivation:

Optional, but should be defaulted; for example, by your own NO-Id, such as 'DTAG'. Set by the first processor and left unchanged.

SEQUENCE_NUMBER

9(6)

Unique reference that identifies each file sent by the VPLMN or logical sender to a particular HPLMN or logical recipient. It indicates the file number of the specific file type, starting at 1 and increments by one for each new file of that type sent. Separate sequence numbering must be used for test and chargeable data. Having reached the maximum value (999999), the number restarts at 1.

Validates duplicate sequence numbers and sequence number gaps.

Note: In the case of retransmission, this number does not increment.

Range:

000001 - 999999 for test data and chargeable data.

Derivation:

Optional, if no sequence check is performed. Mandatory, if a sequence check is performed. Should be set by the first processor and can be changed by any following processor; for example, in case of recycling to assure a unique and linear sequence order to all following processors.

ORIGIN_SEQUENCE_NUMBER

9(6)

Original file sequence number as generated the first time. Identical content as SEQUENCE_NUMBER, but will never be changed.

Used as a reference to the original file, if any processor has changed the file sequence number.

Derivation:

Mandatory, defaulted by SEQUENCE_NUMBER. Set by the first processor and left unchanged.

SEQ_CHECK_KEY

String

Derivation:

Optional if no sequence check is performed.

Mandatory if a sequence check is performed.

SEQ_GEN_KEY

String

Derivation:

Optional if no sequence check is performed.

Mandatory if a sequence check is performed.

CREATION_TIMESTAMP

YYYYMMDDHHMISS

Date and time on which the file was created. Not required by GSM MoU BA. 12, but might be useful for operational purposes.

Can be used to validate that at least one file/stream has been generated every day.

Optional Field Usage:

It is possible to read/write dates in number of seconds since 01.01.1970 00:00:00; for example, 12345. The internal representation is the format YYYYMMDDHHMISS anyway. This is just an optional input/output format conversion.

Derivation:

Mandatory, defaulted with the FILESYSTEM-SYSDATE or a Transaction-Start-Timestamp. Set by the first processor and left unchanged.

TRANSMISSION_DATE

YYYYMMDD

Date on which the file was sent from the sender network to the recipient network or data clearing house.

Can be used to calculate the run time of a file/stream between creation and transmission. Also used as a default TRANSFER_CUTOFF_TIMESTAMP.

Derivation:

Mandatory, defaulted with SYSDATE. Set by the first processor and left unchanged.

TRANSFER_CUTOFF_TIMESTAMP

YYYYMMDDHHMISS

Date and time used to select calls for transfer. All records available prior to the timestamp are transferred. This gives an indication to the recipient as to how current the information is.

Can be used to validate that all CDRs are prior to this date and time. Their CHARGING_START_TIMESTAMP must be equal or less.

Optional Field Usage:

It is possible to read/write dates in number of seconds since 01.01.1970 00:00:00; for example, 12345. The internal representation is the format YYYYMMDDHHMISS anyway. This is just an optional input/output format conversion.

Derivation:

Mandatory, defaulted with TRANSMISSION_DATE. Set by the first processor and left unchanged.

UTC_TIME_OFFSET

X(5)+/-HHMI

All timestamps are sender (VPLMN) local time. So that the time can be equated to time in the recipient (HPLMN) local time, the sender gives the difference between local time and UTC time. UTC Time Offset = Local Time minus UTC Time.

Can be used to translate the TRANSFER_CUTOFF_TIMESTAMP into a unified UTC time. This might be useful if a centralized rating and billing will take place.

Example:

Washington DC, USA 1000hrs10/10/97

UTC Time1500hrs10/10/97

UTC Time Offset= 10 - 15 = -0500

Madrid, Spain1600hrs10/10/97

UTC Time1500hrs10/10/97

UTC Time Offset= 16 - 15 = +0100

Note: Where dates are different, 24 is added to the time of the greater date.

Derivation:

Mandatory. Set by the first processor and left unchanged.

SPECIFICATION_VERSION_NUMBER

9(2)

Uniquely identifies the format. Different specification versions indicate that the record structure has changed; for example, field length, new fields, and new record types.

Used for encoding different formats.

Range:

01

Derivation:

Mandatory. Set by the first processor and left unchanged.

RELEASE_VERSION

9(2)

Indicates the release version within the Specification Version Number. Different Release Versions indicates that only the content of fields has changed.

Used for encoding different formats.

Derivation:

Mandatory. Set by the first processor and left unchanged.

ORIGIN_COUNTRY_CODE

X(8)

International access and country code, which applies within the country of the network where the CDR originated.

Might be useful for an international billing center to distinguish between national and international calls; for example, within the basic detail record.

Range:

0049; for example, for Germany.

Derivation:

Mandatory. Set by the first processor and left unchanged.

SENDER_COUNTRY_CODE

X(8)

International access and country code that applies within the country of the sender (VPLMN). This might be different from the originating code if the sender is a clearing house or third-party operator.

Might be useful for an international billing center.

Range:

0049; for example, for Germany

Derivation:

Mandatory. Set by the first processor and left unchanged.

DATA_TYPE_INDICATOR

X(1)

The type of data contained within the file; for example, test or chargeable data.

Any customer billing processor should ignore test data or at least separate these streams.

Values:

T: Test Data

Space: Chargeable Data

Derivation:

Mandatory. Set by the first processor and left unchanged.

IAC_LIST

X(30)

Comma-separated list of all international access codes used within this file.

Used during number normalization to detect numbers already starting with these IACs. Those numbers will not be normalized anymore.

Example:

"001,002" for two IACs

Derivation:

Optional. Set by the first processor and left unchanged.

CC_LIST

X(30)

Comma-separated list of all country codes used within this file.

Used during number normalization to detect all numbers already starting with these CCs. Those numbers are normalized by adding a default IAC.

Example:

"49,33,1" for two CCs

Derivation:

Optional. Set by the first processor and left unchanged.

TAP_DECIMAL_PLACES

Integer

Derivation:

Optional, but mandatory for RAP output.

Set by the input grammar.

OPERATOR_SPECIFIC INFO

String

Derivation:

Optional, default = ''

Stores a key that identifies the CDR used to generate a specific EDR. Useful for RAP or CIBER return.

Must be set by an iScript.

CIBER_FILLER

String

Optional.

CIBER_RECORD_TYPE

String

Optional.

See CIBER specs for usage.

RETURN_INDICATOR

String

Optional.

See CIBER specs for usage.

CURRENCY

String

Optional.

See CIBER specs for usage.

SETTLEMENT_PERIOD

String

Optional.

See CIBER specs for usage.

CLEARINGHOUSE_ID

String

Optional.

See CIBER specs for usage.

BATCH_REJECT_REASON

String

Optional.

See CIBER specs for usage.

BATCH_CONTENTS

String

Optional.

See CIBER specs for usage.

SENDING_CLEARINGHOUSE_BID

String

Optional.

See CIBER specs for usage.

CREATION_PROCESS

String

Process that created output stream.

SCHEMA_VERSION

String

Version number for schema.

EVENT_TYPE

String

BRM event type.

RAP_FILE_SEQ_NO

String

Optional.

Indicates the returned account procedure (RAP) file in which the recipient public data network (PMN) returned the TAP file batch to the sender PMN. This field is a unique reference.

Used in TAP files.

QUERYABLE_FIELDS_MAPPING

String

Optional

Calculated for suspense handling. Contains the database column names and data types that map to queryable fields.

Use this format:

column_name:data_type[;column_name:data_type[;...]]

BATCH_ID

String

Optional.

Set to the actual file batch ID.

UTC_END_TIME_OFFSET

X(5)

Timezone where the call terminated.

Derivation:

Optional.

BATCH_CTRL_INFO_START_INDEX

Integer

BatchControlInfo block start index.

BATCH_CTRL_INFO_END_INDEX

Integer

BatchControlInfo block end index.

ACCOUNTING_INFO_START_INDEX

Integer

AccountingInfo block start index.

ACCOUNTING_INFO_END_INDEX

Integer

AccountingInfo block end index.

NETWORK_INFO_START_INDEX

Integer

NetworkInfo block start index.

NETWORK_INFO_END_INDEX

Integer

NetworkInfo block end index.

MESSAGE_DESCRIPTION_START_INDEX

Integer

MessageDescriptionInfoList block start index.

MESSAGE_DESCRIPTION_END_INDEX

Integer

MessageDescriptionInfoList block end index.

NOTIFICATION_START_INDEX

Integer

Notification block start index.

DELAYED_ERROR_BLOCK

String

Stores the block name that has the fatal error.

OBJECT_CACHE_TYPE

Integer

Cache residency type:

  • 0: Convergent

  • 1:- Prepaid

  • 2: Postpaid

TAP_FILE_TYPE

String

Type of TAP file, TAP3 or TAP311.

Basic Detail Record (RECType 020-089, 100-299)

This record references a billable event. This basic record is the primary record within the BRM format structure. Table 77-6 lists the fields in the Basic Detail Record.

Table 77-6 Basic Detail Record Fields

Name Format Description

RECORD_TYPE

String

Extended to be 3 bytes long. First byte denotes the market.

020  MOC  Switch Mobile Originating Call

021  TA_MOC  TAP Mobile Originating Call (Roaming**)

022  CFW  Mobile Switch Call Forwarding

023  RCF/RFD  Mobile Roaming Call Forwarding

024  SMO  Mobile Short Message Originating

025  SMT  Mobile Short Message Terminating

026  VMO  Mobile Voice Mail Originating

027  OAB  Mobile Operator Assisted Call (Basic)

028  OAS  Mobile Operator Service (Call Completion)

029  MSS  Mobile Supplementary Service Event

030  MTC  Switch Mobile Terminating Call

031  TA_MTC  TAP Mobile Termination Call (Roaming**)

RECORD_TYPE (cont.)

String

040  SGSN_MOC  Serving GPRS Support Node Originating

041  SGSN_MOT  Serving GPRS Support Node Terminating

042  GGSN_MOC  Gateway GPRS Support Node Originating

043  GGSN_MOT  Gateway GPRS Support Node Terminating

044  GPRS_SMO  GPRS - Short Message Originating

045  GPRS_SMT  GPRS - Short Message Terminating

046  HSCSD_MOC  Mobile HSCSD Originating Call

047  HSCSD_MOT  Mobile HSCSD Terminating Call

048  TA_GPRSOC  TAP GPRS Originating (Roaming**)

049  TA_GPRSTC  TAP GPRS Termination (Roaming**)

050  SCU  Basic Service Center Usage Record

060  VAS  Basic Value Added/Event Record

070  WAP  Basic WAP Record

120  POC  ISDN/Public Switch Originating

121  DX_POC  ISDN/Public Switch Orig.(data exchange)

122  PCF  ISDN/Public Switch Call Forwarding

126  PVM  ISDN/Public Switch Voice Mail Originating

127  POB  ISDN/Public Operator Assisted Call (Basic)

128  POS  ISDN/Public Operator Service (Call Com-pl)

130  PTC  ISDN/Public Switch Termination Call

131  DX_PTC  ISDN/Public Switch Term. (data exchange)

220  IOCBasic Internet Record

Other record types might be defined when necessary.

Derivation:

Mandatory. Set by the first processor and left unchanged.

Note: Only record types 021 and 031 are treated as roaming calls.

RECORD_NUMBER

9(9)

Sequence number of record in file.

Ensures a linear sequence order for all records; for example, as a sorting criteria.

Values:

Minimum: 000000002

Maximum: 999999998

Derivation:

Mandatory. Set by the first processor.

Important: Following modules might change this record number; for example, if new record types are inserted.

DISCARDING

9(1)

Indicates if an EDR should be discarded or rejected.

Values:

0: Proceed (default)

1: Reject

2-9: Discard

The values from 2 to 9 represent different discarding reasons.

Derivation:

Mandatory. Might be set by any processor.

CHAIN_REFERENCE

X(10)

Identifies an EDR as part of a long event that has been split into multiple EDRs.

Condition:

Only present if more than one record is raised for a call (default=Spaces).

Value:

Any six-digit number.

Derivation:

Optional. Might only be set by the first processor.

SOURCE_NETWORK_TYPE

X(1)

The source network type; for example, GSM 900. This is needed for specific implementation models such as some satellite operators where the network originating the chargeable record might be lost.

Note: This is a temporary solution pending further developments.

Values:

Mobile-Networks:

A: S-41 AMPS A

B: S-41 AMPS B

C: S-41 Satellite

D: S-95 CDMA

E: S-136 TDMA

F: PDC

G: GSM 900

H: GSM 1800

I: GSM 1900

J: GSM 90011800

K: GSM 90011900

L: GSM Satellite

M: UMTS

N: Telematic

O: GPRS - GGSN

P: GPRS - SGSN

Intercarrier-Networks:

W: Inroute

X: Outroute

T: Transit

Z: undefined

Fixed-Networks:

0: General Fixed Network

1: Analog

2: ISDN

3: ADSL

4: Multiplex

Other-Networks:

9: Internet

Other values might apply according to the related original input format.

Derivation:

Optional. Might be set by the first processor and might be changed by an interconnect rating processor.

SOURCE_NETWORK

X(14)

Network code from which the call or message was routed. This could either be PLMN_ID or any logical operator code.

Used for interconnect rating.

Condition:

In case of interconnect rating it is overwritten by the network operator code related to the inroute. See TRUNK_INPUT.

Derivation:

Optional (only mandatory for the interconnect processor).

DESTINATION_NETWORK_TYPE

X(1)

Indicates the destination network type; for example, GSM 900. This is needed for specific implementation models such as some satellite operators where the network terminating the chargeable record might be lost.

Note: This is a temporary solution pending further developments.Values:

See SOURCE_NETWORK_TYPE.

Derivation:

Optional. Might be set by the first processor and might be changed by an interconnect rating processor.

DESTINATION_NETWORK

X(14)

Network towards which the call or message is routed.

Condition:

Where a short message has not been delivered or where optimal routing is not used, the field is set to spaces. In case of interconnect rating, it is overwritten by the network operator code related to the outroute. See TRUNK_OUTPUT.

Derivation:

Optional (only mandatory for interconnect rating).

TYPE_OF_A_IDENTIFICATION

X(1)

Specifies if the number used to identify the subscriber within the network is an IMSI or an MSISDN. This type does not relate to the A Number representation.

Values:

A: Internet or Account Number (default for internet)

C: Calling Card Number

I: IMSI

M: MSISDN (default for fixed networks)

P: IP Number

S: SIM-ICC (default for GSM)

X: undefined

Derivation:

Optional. Set by the first processor and left unchanged.

A_MODIFICATION_INDICATOR

H(2)

Specifies if the called or calling number has been modified by the VPLMN; for example, for privacy reasons.

Can be used to evaluate how to handle the number internally; for example, print the last three digits in clear text (anonymize) or suppress the complete CDR during printing a detailed invoice.

Condition:

PLMNs are not forced to implement this parameter. If not implemented, the number must not be modified.

Values:

00: Default setting (undefined) and normal

01: Social number

02: Anonymized number

04: Special number (for example, premium rate)

08: Modified number (for example, vanity routing or short number translation)

Derivation:

Optional. Set by the first processor and left unchanged.

A_TYPE_OF_NUMBER

Z(1)

Type of address associated with a particular destination or calling number.

Condition:

Not all networks support this parameter.

Values:

0: Nature of address unknown (default)

1: International number

2: National significant number

3: Network-specific number

4: Subscriber number

5: Abbreviated number

Derivation:

Optional, default=0. From bits 7 - 5 of octet 1 of the GSM Address String type as defined in TS GSM 09.02. Set by the first processor and left unchanged.

A_NUMBERING_PLAN

X(1)

The numbering plan associated with a particular destination or calling number.

Might be useful when analyzing the A Number for normalization reasons; for example, to interpret the structure of the number (for example, distinguish IP numbers.

Condition:

Not all networks support this parameter.

Values:

0: Type of plan unknown (default)

1: ISDN telephony (CCITT E.164)

3: Data numbering plan (CCITT X.121)

4: Telex numbering plan (CCITT F. 69)

5: Reserved for national use

6: Land mobile numbering plan (CCITT E212)

8: National numbering plan

9: Private numbering plan

A: Internet, IP-number v4

B: Internet, IP-number v6

Derivation:

Optional. From bits 4 - 1 of octet 1 of the GSM Address String type as defined in TS GSM 09.02. The list of values is a comprehensive list of known values and some might not occur in practice. Set by the first processor and left unchanged.

A_NUMBER

X(40)

Identifies the billable party; for example, the ISDN number, call-line-identity, or source IP address. For MTC and MOC calls, this number contains the subscriber number to be billed, which has not automatically to be the originating number.

Condition:

Can be used as an alternative to the IMSI, but could also be an Internet account number.

Values:

Defined in TS GSM 03.03 or in international notation.

Should always be:

International_access_codeCountry_codeNational_destination_codeSubscriber_number

Examples:

Fixed: +49410676810

Mobile: 01729183333 (Roaming-MOC: 0000MNC/MCC, 000026202)

IPv4: 192.168.10.2 (always 4 token, each 3 decimals)

IPv6: ABCD:10:2:1AF:0:1F0A:F:1F0 (always 8 token, each 4 hex)

Derivation:

Mandatory. From the GSM item MSISDN as defined in TS GSM 12.05. Set by the first processor and left unchanged, but is normalized:

Fixed: 0049410676810

Mobile: 00491729183333 (Roaming-MOC: 0000MNC/MCC, 000026202)

IPv4: 192168010002 (dots removed, filled with leading zeros)

IPv6: ABCD0010000201AF00001F0A000F01F0 (colons removed, filled with leading zeros)

B_MODIFICATION_INDICATOR

H(2)

See A_MODIFICATION_INDICATOR.

Optional.

B_TYPE_OF_NUMBER

Z(1)

See A_TYPE_OF_NUMBER.

Mandatory.

B_NUMBERING_PLAN

X(1)

See A_NUMBERING_PLAN.

Optional, only if available.

B_NUMBER

X(40)

Identifies the called number.

Condition:

If there is no called number available (for example, Internet or Telematic), a dummy number has to be inserted instead; for example, 0049. If the rating does not involve zoning, profile-related features, or special numbers, the BRM rating works with even an incomplete called number.

Values:

Defined in TS GSM 03.03 or in international notation.

Should always be:

International_access_codeCountry_codeNational_destination_codeSubscriber_number

Examples:

Fixed: 0049410676810 (normal)

Fixed: 0049112 (emergency)

Fixed: 004970012345678 (vanity)

Fixed: 004911833 (special)

Mobile: 00491729183333 (normal)

Mobile: 0049172559183333 (mailbox)

Mobile: 00490172112 (emergency)

Mobile: 0049017222255 (special mobile-number)

Mobile: 004911833 (special fixed-number)

Mobile: 000026202 (Roaming-MTC: 0000MNC/MCC)

IPv4: 192.168.10.2 (always 4 token, each 3 decimals)

IPv6: ABCD:10:2:1AF:0:1F0A:F:1F0 (always 8 token, each 4 hex)

Derivation:

Mandatory. From the GSM item Called Number as defined in TS GSM 12.05. This item is of type Address String and is further expanded into the items type of number, numbering plan, and the number sent across the air-interface as defined in TS GSM 04.08 and 09.02. Set by the first processor and left unchanged, but is normalized.

Fixed: 0049410676810

Mobile: 00491729183333 (Roaming-MOC: 0000MNC/MCC, 000026202)

IPv4: 192168010002 (dots removed, filled with leading zeros)

IPv6: BCD0010000201AF00001F0A000F01F0 (colons removed, filled with leading zeros)

DESCRIPTION

X(50)

Description text for this usage scenario; for example, call destination description for the B Number or service description used.

Values:

For example, "HAMBURG" or "004940"

For example, "Travel Info" or "Wakeup Call"

Value is related to the original input format.

Derivation:

Optional. Calculated by a rating processor or directly taken out of the original CDR stream. Might be changed by any processor.

C_MODIFICATION_INDICATOR

H(2)

See A_MODIFICATION_INDICATOR.

Optional. Only mandatory if C Number is present.

C_TYPE_OF_NUMBER

Z(1)

See A_TYPE_OF_NUMBER.

Optional. Only mandatory, if C Number is present.

C_NUMBERING_PLAN

X(1)

See A_NUMBERING_PLAN.

Optional. Only mandatory if C Number is present.

C_NUMBER

X(40)

Third-party number; for example, where the call was first terminated in the case of terminated transit or routed, forwarded calls. This field contains the number initiating the call forwarding.

Note: To avoid any doubt, the 'A to C' and 'C to B' legs of a call-forwarding scenario must be treated as separate calls and the originating and terminating records should never be chained together.

Condition:

Only present where it is available.

Values:

See B_NUMBER.

Derivation:

Optional. From the GSM item Called Number as defined in TS GSM 12.05. This item is of type Address String and is further expanded into the items type of number, numbering plan, and the number sent across the air-interface as defined in TS GSM 04.08 and 09.02. Set by the first processor and left unchanged.

USAGE_DIRECTION

X(1)

Describes the direction of the connection that was established.

Can be used by any rating and post-processor to identify the direction of the event; for example, to determine a specific call scenario.

Values:

0: Originated usage

1: Terminated usage

2: Roaming originated usage

3: Roaming terminated usage

Examples:

0: MOC, mobile originated WAP, …

1: MTC, mobile terminated WAP, …

2: roaming MOC

3: roaming MOC

Derivation:

Mandatory. Set by the first processor and left unchanged.

CONNECT_TYPE

X(2)

Type of connection.

Can be used to identify the type of the call; for example, to determine a specific call scenario.

Values:

01: Mobile to Mobile

02: Mobile to Land

03: Land to Mobile

04: Land to Land

10: Effective POTS Call

11: Effective ISDN Call

12: Effective Call Diversion

13: Subscriber Procedure

14: Subscriber Service Command

15: Effective ISDN-E Call

16: Ineffective POTS Call

17: Ineffective ISDN Call

18: Ineffective Call Diversion

19: Ineffective ISDN-E Call

20: Non Call Related Output

30: Anonymous login

Other values might apply according to the related original input format.

Derivation:

Mandatory. Set by the first processor and left unchanged.

CONNECT_SUB_TYPE

X(2)

Detailed description of the connection or call type.

Can be used to identify the type of the call; for example, to determine a specific call scenario.

Values:

01: Mobile-Call

02: Local-Call (for example, BestCity, BestFriend, etc.)

03: National-Call

04: International-Call

Derivation:

Mandatory. Set by the first processor and left unchanged.

CALLED_COUNTRY_CODE

String

Derivation:

Optional, but should be set when the CONNECT_TYPE indicates an international call

BASIC_SERVICE

X(3)

Uniquely identifies the basic usage-related service. A service is defined by:

  • Service type

  • Service code

BASIC_SERVICE

X(1)

Specifies the type of basic service.

Values:

0: Tele Service (for example, GSM Tele, ISDN, analog, standard, etc.)

1: Bearer Service

2: Supplementary Service

3: Telematic Service (only if present)

4: Internet Service

5: ISDN mobile (only if present)

6: Mailbox (only if present)

7: VPN mobile (only if present)

8: GPRS

9: Switch related (for example, for direct fixed network support)

E: Event/VAS Services

W: WAP

Other service types might be defined when necessary.

Derivation:

Mandatory. Set by the first processor and left unchanged.

SERVICE_CODE

X(2)

The Service Code is either a Teleservice Code or Bearer Service Code as determined by Service Type.

Values:

Note: Other values might apply according to the related original input format.All Tele Services:

10: All Voice

11: Telephony (default)

12: Emergency calls

13: GPRS (default)

14: HSCSD (default)

15: WAP (default)

20: All Short Message Service

21: Short Message MT/PP

22: Short Message MO/PP

30: MHS

31: Advanced MHS access

40: All Videotext

41: Videotext access profile

42: Videotext access profile 2

43: Videotext access profile 3

50: All Teletext Transmission Services

51: Teletext (Circuit Switch)

52: Teletext (Packet Switch)

61: Facsimile Group 3 & alternative voice

62: Automatic Facsimile Group 3

63: Automatic Facsimile Group 4

SERVICE_CODE

(continued)

X(2)

All Bearer Services:

10: 3.1 KHz Bearer Group

20: Circuit data asynchronous

21: Duplex Asynchronous 300bps data circuit

22: Duplex Asynchronous 1200bps data circuit

23: Duplex Asynchronous 1200/75bps data circuit

24: Duplex Asynchronous 2400bps data circuit

25: Duplex Asynchronous 4800bps data circuit

26: Duplex Asynchronous 9600bps data circuit

30: Circuit data synchronous

32: Duplex Synchronous 1200bps data circuit

34: Duplex Synchronous 2400bps data circuit

35: Duplex Synchronous 4800bps data circuit

36: Duplex Synchronous 9600bps data circuit

40: PAD access asynchronous

41: Duplex Asynchronous 300bps PAD access

42: Duplex Asynchronous 1200bps PAD access

43: Duplex Asynchronous 1200/75bps PAD access

44: Duplex Asynchronous 2400bps PAD access

45: Duplex Asynchronous 4800bps PAD access

46: Duplex Asynchronous 9600bps PAD access

50: PAD access synchronous

54: Duplex Synch. 2400bps PAD access

55: Duplex Synch. 4800bps PAD access

56: Duplex Synch. 9600bps PAD access

60: All alternate voice/data c.d.a

61: Alt. Voice/Asynch. 300bps unrest'd digital

62: Alt. Voice/Asynch. 1200bps unrest'd digital

63: Alt. Voice/Asynch. 1200/75bps unrest'd digital

64: Alt. Voice/Asynch. 2400bps unrest'd digital

65: Alt. Voice/Asynch. 4800bps unrest'd digital

66: Alt. Voice/Asynch. 9600bps unrest'd digital

70: Alternate voice data c.d.s

72: Alt. Voice/Synch. 1200bps unrest'd digital

74: Alt. Voice/Synch. 2400bps unrest'd digital

75: Alt. Voice/Synch. 4800bps unrest'd digital

76: Alt. Voice/Synch. 9600bps unrest'd digital

80: Voice followed by data c.d.a

SERVICE_CODE

(continued)

X(2)

All Bearer Services:

(continued)

81: Voice then Asynch. 300bps unrest'd digital

82: Voice then Asynch. 1200bps unrest'd digital

83: Voice then Asynch. 1200/75bps unrest'd digital

84: Voice then Asynch. 2400bps unrest'd digital

85: Voice then Asynch. 4800bps unrest'd digital

86: Voice then Asynch. 9600bps unrest'd digital

90: All Voice followed by data c.d.s

92: Voice then Synch. 1200bps unrest'd digital

94: Voice then Synch. 2400bps unrest'd digital

95: Voice then Synch. 4800bps unrest'd digital

96: Voice then Synch. 9600bps unrest'd digital

SERVICE_CODE

(continued)

X(2)

All Telematic Service:

01: SMS

02: E-Mail

03: Pull-Service

04: Short-Fax

05: Push-Service

All Internet Service:

10: all Internet

11: direct Access

12: WebMaster Emergency

13: Voice over IP

14: Fax over IP

20: E-Mail

30: Active Channel

40: Video on demand

41: Music on demand

50: Newsgroup access

62: Internet Fax

other values Can be used according to the network.

All Switch-related Services or WAP/GPRS Services:

01...99: see related switch documentation (values used 1:1)

AA...ZZ: see related switch documentation (values used 1:1)

All Event/VAS Services:

00: all default Event/VAS usage

other Service Codes might be defined when necessary.

Derivation:

Mandatory. Set by the first processor and left unchanged.

QOS_REQUESTED

X(5)

The type of QoS requested by the Terminal Equipment (TE) at usage setup or the QoS requested to the Network Equipment (NE).

The QoS Requested is typically a normalized billable QoS value. For detailed network-related QoS attributes, see the related Associated Service Extension Record.

Condition:

The use of a QoS might not be appropriate; for example, call forwarding cases, short message services. Applies only where appropriate information is available.

Values for Radio Channel: H(2)

00: Half Rate Channel

01: Full Rate Channel

02: Dual Rate Channel, Half Rate Preferred

03: Dual Rate Channel, Full Rate Preferred

Values for Quality of Service:

X(5)

xxxxx: Any alphanumeric representation of the NE Value is according to the related original input format.

Derivation:

Optional. From the GSM item RadioChanRequested, a component of RadioChanlnfo as defined in TS GSM 12.05. or directly out of the NE-interface. Encoded as per TS GSM 04.08. Set by the first processor and left unchanged.

QOS_USED

X(5)

The type of QoS negotiated by the network. The QoS used is typically a normalized billable QoS value. For detailed network-related QoS attributes, see the related Associated Service Extension Record.

Condition:

The use of a QoS might not be appropriate; for example, call forwarding cases, short message services. Applies only where appropriate information is available.

Values for Radio Channel: H(2)

00: Half Rate Channel

01: Full Rate Channel

Values for Quality of Service:

X(5)

xxxxx: any alphanumeric representation of the NE Values is according to the related original input format.

Derivation:

Optional. From the GSM item channel type, a component of RadioChannel-Used as defined in TS GSM 12.05. Encoded as per TS GSM 04.08 or directly out of the NE-interface. Set by the first processor and left unchanged.

CALL_COMPLETION_INDICATOR

X(3)

Indicates whether a call was correctly completed or not. Optionally defines a close cause reason code.

Single-Byte Values X(1): if no reason code is available:

C: Call completed, charged as usual

D: Call dropped, treatment open, but will first be charged as usual

T: Call completed, test call, will not be charged

Optional Values after rating processor:

0: After rating processor: not rated yet: should be rated later by the billing post-processor: call completed

1: After rating processor: rated: should not be rated again by a billing post-processor - call completed

2: After rating processor: not rated yet: should be rated later by the billing post-processor: call dropped

3: After rating processor: rated: should not be rated again by a billing post-processor: call dropped

Double-Byte Values X(2) - if a reason code is available:

00: normal

01: partial record

02: partial call re-establishment

03: unsuccessful call attempt

04: abnormal release

05: camel init call release

16: volume limit

17: time limit

18: network element switch

19: max. change condition

20: management intervention

other values can be used according to the network.

Derivation:

Mandatory, default C. Set by the first processor and left unchanged.

LONG_DURATION_INDICATOR

X(1)

Specifies which part of the call, in the case of split calls.

Values:

S: Single (only one record present)

F: First (the first record in the row of split records)

I: Intermediate (one of the middle records in the row of records)

L: Last (the last record in the row of split records)

Derivation:

Mandatory, default S. Set by the first processor and left unchanged.

CHARGING_START_TIMESTAMP

YYYYMMDDHHMISS

Timestamp used for start of charging. In the mobile originated case, this is as determined by the VPLMN's charging rules. In the mobile terminated case, it is also at the discretion of the VPLMN, even though the information is for use in charging by the VPLMN.

Format:

YYYYMMDDHHMISS; for example, 19990518190357

Optional Field Usage:

It is possible to read/write dates in number of seconds since 01.01.1970 00:00:00; for example, 12345. The internal representation is the format YYYYMMDDHHMISS anyway. This is just an optional input/output format conversion.

Derivation:

Mandatory. From the GSM item answer-time or seizure-time as defined in TS GSM 12.05. Set by the first processor and left unchanged.

CHARGING_END_TIMESTAMP

YYYYMMDDHHMISS

Timestamp used for end of charging. In the mobile originated case, this is as determined by the VPLMN's charging rules. In the mobile terminated case, it is also at the discretion of the VPLMN, even though the information is for use in charging by the VPLMN.

Format:

YYYYMMDDHHMISS; for example, 19990518190357

Optional Field Usage:

It is possible to read/write dates in number of seconds since 01.01.1970 00:00:00; for example, 12345. The internal representation is the format YYYYMMDDHHMISS anyway. This is just an optional input/output format conversion.

Derivation:

Optional. Might be set by the first processor and left unchanged.

Note: If not present, this value can be calculated by using the start timestamp and the duration.

CREATED_TIMESTAMP

Date

Optional.

The time that the event was created in BRM.

UTC_TIME_OFFSET

X(5)+/-HHMI

All timestamps are VPLMN or originating network local time. So that the time can be equated to time in the HPLMN or recipient network, the sender gives the difference between local time and UTC time.

Can be used to translate the CHARGING_START/END_TIMESTAMP into a unified UTC time. This might be useful if a centralized rating and billing will take place.

Values:

UTC Time Offset = Local Time minus UTC Time

Example:

Washington DC, USA   1000hrs   10/10/97

   UTC Time   1500hrs   10/10/97

   UTC Time Offset   = 10 - 15 = -0500

Madrid, Spain   1600hrs   10/10/97

   UTC Time   1500hrs   10/10/97

   UTC Time Offset   = 16 - 15 = +0100

Sydney, Australia   0100hrs   11/10/97

   UTC Time   1500hrs   10/10/97

   UTC Time Offset   = (01 + 24) - 15 = +1000

(Note that where dates are different, 24 is added to the time of the greater date.)

Derivation:

Mandatory. Set by the first processor and left unchanged.

DURATION

9(15)

Duration-based charge indicates that the field represents a Chargeable Duration.

Can be used to evaluate all duration-based functions; for example, determination of the pricing rating steps.

Condition:

For event-based charges or an inter-network account charge, the field is not relevant. URC.01 implementation of the TD.17 item Chargeable Units.

Maximum Value: 999999999999999

Derivation:

Mandatory, default 0. Set by the first processor and left unchanged but might be patched by some kind of rating processors.

TOTAL_CALL_EVENT_DURATION

Integer

The total duration of the event. This should be set for all time-based services; for example, telephony.

Mandatory.

The default value is 0.

DURATION_UoM

X(3)

Unit of Measurement associated with Chargeable Quantity Value.

Can be used to interpret the quantity value, but usually not needed, because the quantity itself is sufficient for all rating steps.

Values:

SEC: Seconds (default)

MIN: Minutes

HRS: Hours

or any other applicable value describing a timed quantity unit of measurement.

Derivation:

Mandatory, default 'SEC'. Set by the first processor and left unchanged.

VOLUME_SENT_

9(15)

In addition to the basic duration quantity value, a special volume might be defined to keep an additional rating relevant measurement. This is typically BYTES sent by the initiator (A number).

Maximum Value: 999999999999999

Can be used to evaluate additional volume-based functions; for example, determination of the pricing rating steps.

Derivation:

Mandatory, default 0. Set by the first processor and left unchanged but might be patched by some kind of rating processors.

VOLUME_SENT_UoM

X(3)

The Unit of Measurement associated with VOLUME_SENT.

Can be used to interpret the quantity value, but usually not needed because the quantity itself is sufficient for all rating steps.

Values:

BYT: Bytes/Characters (default)

KBY: Kilobytes

MBY: Megabytes

GBY: Gigabyte

or any other applicable value describing a metered quantity unit of measurement.

Derivation:

Mandatory, default 'BYT'. Set by the first processor and left unchanged.

VOLUME_RECEIVED

9(15)ˆ

In addition to the basic duration value, a special volume might be defined to keep an additional rating relevant measurement. This is typically BYTES received by the initiator (A Number).

Maximum Value: 999999999999999

Can be used to evaluate an additional volume-based functions; for example, determination of the pricing rating steps.

Derivation:

Mandatory, default 0. Set by the first processor and left unchanged but might be patched by some kind of rating processors.

VOLUME_RECEIVED_UoM

X(3)

The Unit of Measurement associated with VOLUME_RECEIVED value.

Can be used to interpret the quantity value, but usually not needed because the quantity itself is sufficient for all rating steps.

Values:

  • BYT: Bytes/Characters (default)

  • KBY: Kilobytes

  • MBY: Megabytes

  • GBY: Gigabyte

  • Any other applicable value describing a metered quantity unit of measurement

Derivation:

Mandatory, default 'BYT'. Set by the first processor and left unchanged.

NUMBER_OF_UNITS

9(15)

One of the following:

  • Original charged units (for example, beats, clicks) as applied by the sender

  • Rounded total volume charged by the sender

  • Number of events associated with this record (for example, number of SMS messages or number of internet hits/clicks)

Might be useful for analyzing how many units the event was originally treated by or for storing a fourth quantity.

Condition:

Applies only if available. Alternative URC.01 implementation of the TD.17 item Chargeable Units.

Maximum Value: 4294967296

Derivation:

Mandatory, default 0. Set by the first processor and left unchanged, but might be changed by some type of rating processors.

NUMBER_OF_UNITS_UoM

X(3)

The Unit of Measurement associated with NUMBER_OF_UNITS value.

Can be used to interpret the quantity value, but usually not needed because the quantity itself is sufficient for all rating steps.

Values:

CLK: Clicks (anonymous quantity) (default)

MSG: Messages

PAG: Pages

PAC: Packets

PIC: Pieces

RTS: Points

MTR: Meters

KMR: Kilometer

SPD: Speed

TRN: Transactions

or any other applicable value describing a metered quantity unit of measurement.

Derivation:

Mandatory, default CLK. Set by the first processor and left unchanged.

RETAIL_IMPACT_CATEGORY

X(10)

Impact category defining the usage scenario specific rate; for example, the zone value used for customer rating.

Values:

00000: undefined impact category (default)

00001 - 99999: user defined

Alternatively a user-defined string can be used as a value.

Derivation:

Optional, but mandatory after any rating processor, default 00000. Might be changed by any processor.

RETAIL_CHARGED_AMOUNT_VALUE

9(11)

The charge for the event (for example, the retail price). This includes any toll charge but does not include any CAMEL invocation fee.

Values:

Space: No price given, like NULL in a database

Variable floating point format: Given value, might be 0.000. The floating decimal point must be set.

Minimum: -9999999999

Maximum: 99999999999

Examples:

'00000000125' for 125,00

'00000012.50' for 12,50

'-0012.56780' for -12,5678

Derivation:

Optional, but mandatory after any customer rating processor.

RETAIL_CHARGED_AMOUNT_CURRENCY

X(3)

Currency code as defined within the associated charge; for example, DEM or EUR.

Derivation:

Optional, but mandatory whenever the RETAIL_CHARGED_AMOUNT_VALUE is set. Use the three-digit ISO currency code.

RETAIL_CHARGED_TAX_TREATMENT

X(1)

Charges might be inclusive or exclusive of tax.

Can be used to interpret the amount value and to distinguish between net and gross charges.

Values:

Y: Tax included in the charge

N: Tax not included in the charge (default)

Derivation:

Optional, but mandatory whenever the RETAIL_CHARGED_AMOUNT_VALUE is set.

RETAIL_CHARGED_TAX_RATE

9(4)

Defines the tax rate applicable to the charge. Because some national legal definitions dictate that the tax rate applicable is determined by the invoice date, there is a possibility that the rate on the invoice might differ from the rate on the transfer. However, the likelihood of this happening is extremely low.

Can be used to interpret the amount value and to convert between net and gross charges.

Values:

0000 through 9999 (2 fixed decimals)

Example:

16.00% 1600

Derivation:

Optional, but mandatory whenever the RETAIL_CHARGED_AMOUNT_VALUE is set.

RETAIL_CHARGED_TAX_VALUE

Decimal

Derivation:

Calculated, default = 0.0

WHOLESALE_IMPACT_CATEGORY

X(10)

Wholesale/Advice of Charge - Impact category used for purchase rating.

Values:

00000: undefined impact category (default)

00001 - 99999: user-defined

Derivation:

Optional. Might be changed by any processor.

WHOLESALE_CHARGED_AMOUNT_VALUE

9(11)

Wholesale/Advice of Charge: charge for the event (for example, the wholesale price). This includes any toll charges.

Can be used to keep the original purchase charge, to evaluate a record-based margin together with the charged amount value.

Values:

Space: No price given, like NULL in a database

Floating point format: Given value, might be 0.000. If no floating point exists, the last three digits are always taken as decimals)

Minimum: -9999999999

Maximum: 99999999999

Examples:

'00000012500' for 12,50

'-0001200100' for -1.200,10'

'00000012.50' for 12,50

'00012.50000' for 12,50

Derivation:

Optional. Usually transmitted by the sender (origin network operator) of the file, but might also be recalculated by any processor to represent the purchase charge.

WHOLESALE_CHARGED_AMOUNT_CURRENCY

X(3)

See RETAIL_CHARGED_AMOUNT_CURRENCY.

ZONE_DESCRIPTION

String

Calculated. Used by zoning and rating modules.

IC_DESCRIPTION

String

Used by the zoning and rating modules.

ZONE_ENTRY_NAME

String

Calculated. Used by zoning and rating modules.

WHOLESALE_CHARGED_TAX_TREATMENT

X(1)

See RETAIL_CHARGED_TAX_TREATMENT.

WHOLESALE_CHARGED_TAX_RATE

9(4)

See RETAIL_CHARGED_TAX_RATE.

WHOLESALE_CHARGED_TAX_VALUE

Decimal

Derivation:

Calculated, default = 0.0

TARIFF_CLASS

X(10)

Tariff Class contains tariff information as represented within the original CDR format; for example, wholesale tariff model identification.

Can be used to evaluate the original charge configuration in conjunction with the BASIC_AoC_AMOUNT_VALUE.

Condition:

Only present if original purchase charge information is available.

Values:

Dependent on the original format. No format conversion will take place. See the appropriate documentation of the original format.

Derivation:

Optional (but should by mandatory for all mobile (GSM) related records). Might be set by any processor.

TARIFF_SUB_CLASS

X(10)

Contains detailed tariff information as represented within the original CDR format; for example, wholesale zone identification.

Can be used to evaluate the origin charge configuration in conjunction with the WHOLESALE_CHARGED_AMOUNT_VALUE.

Condition:

Only present if origin purchase charge information is available.

Values:

Dependent on the original format. No format conversion will take place. See the appropriate documentation of the original format.

Derivation:

Optional (but should by mandatory for all mobile (GSM) related records). Might be set by any processor.

USAGE_CLASS

X(5)

Specifies a format-related usage scenario; for example, call forwarding, roaming, mailbox request, or local calls.

Can be used to evaluate the origin call scenario. The call class can be used to convert a scenario into a combined zone value or to identify specific rating specialties. Therefore the call class consists of original record fields.

Values:

Dependent on the original format. No format conversion or normalization will take place. The content is derived from any rule-based translations of any available raw event attributes, to represent all possible usage scenarios of the origin format.

00000: undefined usage class

Derivation:

Mandatory. Should be set by the first processor and left unchanged.

USAGE_TYPE

X(5)

Specifies a customer-related usage scenario; for example, customer-to-customer call, birthday call, or closed-user-group calls.

Can be used to evaluate an A Number-customer and B Number-customer related scenario (using direct access to specific customer-info-fields). The call type can be used to convert a scenario into a combined zone value or to calculate a record-based discount when estimating the charging amounts.

Values:

User definable values might be used. The content of the field depends on the rule-based configuration.

00000: undefined usage type

Derivation:

Optional. Might be changed by any rating or billing processor.

EVENT_TYPE

String

BRM event type.

SERVICE_TYPE

String

BRM service type.

When the service has a subscription service, the string is separated by semicolons; for example,

/service/gsm/data;/service/gsm)

BILLCYCLE_PERIOD

YYYYMMBC

Defines the next open billcycle period this event belongs to.

Can be used to group or split the EDR stream into billcycle-related smaller portions.

Condition:

Only present if a rating or pre-billing processor evaluates the next billcycle period for the A number customer.

Values:

YYYY: The actual year of the next open billcycle period.

MM: The actual month of the next open billcycle period.

BC: The billcycle identifier.

Derivation:

Optional, but should be mandatory for any pre-billing processor.

PREPAID_INDICATOR

9(2)

Specifies if the event is a prepaid event.

Can be used to identify prepaid scenarios within a mixed post-/prepaid environment.

Values:

Default: no prepaid scenario

prepaid scenario

Derivation:

Mandatory. Set by the first processor and left unchanged.

NUMBER_ASSOCIATED_RECORDS

9(2)

Number of associated records attached to this basic detail record.

Can be used to evaluate how many associated records have to be read ahead.

Values:

00: No associated records attached, next record is a basic one.

01-99: Number of associated records followed by this record.

Derivation:

Mandatory. Must be changed by any processor if new associated records are added.

NUMBER_OF_CDRS

Integer

Number of CDRs that were compiled into this EDR during call assembly.

Derivation:

Optional. Calculated.

ERROR_REJECT_TYPE

String

Used by the FCT_Reject to reject the DETAIL to another stream than the standard reject stream.

Derivation:

Optional, default = ' '

OPERATOR_SPECIFIC_INFO

String

Stores a key to identify the CDR used to generate a specific EDR.

Useful for RAP or CIBER return.

Derivation:

Optional, default = ' '

Must be set by an iScript.

DISCOUNT_KEY

String

N/A

GEOGRAPHICAL_LOCATION

String

Conditional in TAP 3.10.

Indicates the geographical location of the terminal equipment.

Format: This field contains comma-separated tag-value pairs that indicate the geographical location of the serving network, serving BID, serving location description, longitude, and latitude.

The tag values of the corresponding fields are as follows:

  • ServingNetwork: 1

  • ServingBID: 2

  • ServingLocationDescription: 3

  • Longitude: 4

  • Latitude: 5

Example 1: If the TAP field values are as follows:

  • ServingNetwork: AIRTEL

  • ServingBID: AIRBID

  • ServingLocationDescription: Bangalore

  • Longitude: 111

  • Latitude: 103

The value of DETAIL.GEOGRAPHICAL_LOCATION would be:

1,AIRTEL, 2,AIRBID, 3,Bangalore, 4,111,5,103

Example 2: If the TAP field values are as follows:

  • ServingNetwork: AIRTEL

  • ServingBID: AIRBID

  • Latitude: 103

The value of DETAIL.GEOGRAPHICAL_LOCATION would be:

1,AIRTEL, 2,AIRBID, 5,103

FRAUD_MONITOR_INDICATOR

String

Conditional in TAP 3.10.

Indicates that the chargeable subscriber is flagged for fraud information collection purposes.

Possible values:

1 - Fraud Monitored Subscriber

If the field is present, it should have a value of 1.

ORIGINAL_BATCH_ID

String

Optional, but might be set equal to the original file batch ID.

BATCH_ID

String

Optional, but might be set equal to the recycle or rerate file batch ID.

NE_CHARGING_START_TIMESTAMP

Date

Network Element date/time stamp. Time at which the call started.

Derivation:

Optional.

NE_CHARGING_END_TIMESTAMP

Date

Network Element date/time stamp. Time at which the call ended.

Derivation:

Optional.

UTC_NE_START_TIME_OFFSET

X(5)

Optional.

UTC_NE_END_TIME_OFFSET

X(5)

Optional.

UTC_END_TIME_OFFSET

X(5)

Timezone where the call terminated.

Derivation:

Optional.

INCOMING_ROUTE

X(30)

Incoming route name.

Optional.

ROUTING_CATEGORY

X(20)

Category denoting the routing of the call to the destination party.

Optional.

DISCARD_REASON

String

The reason for discarding the EDR. This field is set by FCT_Discard.

CREDIT_LIMIT_CHECK

Integer

Specifies whether to perform credit limit checking on the EDR:

  • 1 = Perform a credit limit check

  • 0 = Skip the credit limit check

Mandatory.

CREDIT_LIMIT_CHECK_RESULT

Integer

Specifies whether the EDR passed or failed the credit limit check:

  • 1 = The EDR passed the simple credit limit check

  • 0 = The EDR failed the simple credit limit check

Mandatory.

UNRATED_QUANTITY

Decimal

Unrated quantity filled in after credit limit check.

REFRESH_BALANCE

Integer

Specifies whether the latest balance information should be retrieved from the database.

When this field is set, the discounting module calls the balance module to get the latest balance information from the database, whether or not a balance packet is present in the EDR.

OBJECT_CACHE_TYPE

Integer

Cache residency type.

  • 0: Convergent

  • 1: Prepaid

  • 2: Postpaid

DELAYED_ERROR_BLOCK

String

Stores the block name that has the fatal error.

EVENT_ID

String

Used by Revenue Assurance.

ITEM_TAG

String

Used by FCT_ItemAssign.

Calculated.

RERATE_TAG

Integer

Used for re-rating

DROPPED_CALL_QUANTITY

Decimal

Duration of a dropped call.

DROPPED_CALL_STATUS

Integer

Status of a dropped call.

  • 0 = No dropped call service-level ERA associated with the service.

  • 1 = The call is a dropped call.

  • 2 = Continuation call.

  • 3 = Both a dropped call and a continuation call.

  • 4 = Does not meet the criteria for either a dropped call or a continuation call.

NET_QUANTITY

Decimal

Contains the summation of the BALANCE_PACKET.PIN_QUANTITY for the associated RUM.

INTERN_attributes (shown below)

As shown below

The following INTERN_ attributes are used by specific modules to temporarily store calculated values.

They are all mandatory, but only from a definition point of view.

The content value of these fields will be filled automatically by the appropriate modules.

All other modules should use these values as read only.

INTERN_ZONE_MODEL

Integer

The internal zone model used by zoning, rating, and discounting

Mandatory. Calculated.

INTERN_NETWORK_MODEL

String

The internal network model code.

Mandatory. Calculated.

INTERN_NETWORK_OPERATOR

String

The internal network operator code. Used by Interconnect aggregation.

Mandatory. Calculated.

INTERN_APN_GROUP

String

The internal APN group code used by zoning.

Mandatory. Calculated.

INTERN_TERMINATING_SWITCH_IDENTIFICATION

String

The internal terminating switch ID. Used by output mapping

Mandatory. Calculated.

INTERN_BILLING_CURRENCY

String

The internal billing currency used by exchange rate conversion.

Mandatory. Calculated.

INTERN_HOME_CURRENCY

String

The internal home currency used by exchange rate conversion.

Mandatory. Calculated.

INTERN_SLA_USC_GROUP

String

The internal customer-related SLA-based usage scenario map group code.

Mandatory. Calculated.

INTERN_SLA_RSC_GROUP

String

The internal customer-related SLA-based rate service class map group code

Mandatory. Calculated.

INTERN_SLA_IRULE_SET

String

The internal customer-related SLA-based irule_set-code.

Mandatory. Calculated.

INTERN_PROCESS_STATUS

Integer

Possible values are

  • 0 = normal (default)

  • 1 = recycling

  • 2 = recycling-test

Mandatory. Calculated.

INTERN_BALANCE_GROUP_ID

String

The balance group of the service to which the event belongs.

Optional.

INTERN_SERVICE_BILL_INFO_ID

String

The billinfo of the service's balance group.

Optional.

INTERN_DISCOUNT_OWNER_ACCT_ID

String

Optional.

INTERN_SERVICE_BILL_INFO_ID

String

The billinfo of the service's balance group.

Optional.

ACCOUNT_ID

String

The POID of the Customer A account.

Optional.

TB_RECORD_NUMBER

Integer

The Trigger Billing Record number used by the Trigger Bill Output Mapping to assign the array index set by the grammar.

Optional.

RAP_FILE_SEQ_NO

String

Indicates the Returned Account Procedure (RAP) file in which the Recipient PMN returned the TAP file record to the Sender PMN. This field is a unique reference.

Used in TAP files.

Optional.

PROFILE_LABEL_LIST

String

A list of unique labels of all shared profiles having attributes matching a specific EDR field or event attribute.

Optional. Calculated.

DROPPED_CALL_QUANTITY

Decimal

When the EDR is flagged as a continuation call, this field stores the duration of the associated dropped call.

DROPPED_CALL_STATUS

Integer

Specifies whether the EDR is for a normal call (0), a dropped call (1), a continuation call (2), both a dropped call and a continuation call (3), or an already processed EDR (4).

Associated Revenue Assurance Extension Record

Table 77-7 lists the fields in the Associated Revenue Assurance Extension Record. This record is optional with an occurrence of 0 or 1 time only.

Table 77-7 Associated Revenue Assurance Extension Record Fields

Name Format

BATCH_ID

String

CDR_FILE_NAME

String

START_TIME

String

EDR_STATUS

String

REVENUE_STREAM

String

OUTPUT_STREAM

String

DISCOUNT_AMOUNT

Decimal

OLD_DISCOUNT_AMOUNT

Decimal

CHARGED_AMOUNT

Decimal

OLD_CHARGED_AMOUNT

Decimal

Associated GSM/Wireline Extension Record (RECType 520)

This record is optional and will be generated only if the related Basic Detail Record indicates a GSM or Wireline service. Table 77-8 describes the fields in the Associated GSM/Wireline Extension Record.

Table 77-8 Associated GSM/Wireline Extension Record Fields

Name Format Description

RECORD_TYPE

String

Extended to be 3 bytes long.

Value:

520 - GSM/Wireline Extension Record

Derivation:

Mandatory. Set by the first processor and left unchanged.

RECORD_NUMBER

9(9)

Sequence number of record in file.

Used to ensure a linear sequence order for all records; for example, as a sorting criteria.

Values:

Minimum: 000000002

Maximum: 999999998

Derivation:

Mandatory. Set by the first processor.

Important: Following modules might change this record number; for example, if new record types are inserted.

PORT_NUMBER

X(24)

Identifies the customer to charge; for example, the IMSI or SIM number.

Condition:

For Value Added Services and APLMN Service Center Usage, either the IMSI or MSISDN might be supplied, although one of them must be supplied and, where available, the IMSI is preferred. For normal mobile calls, the SIM number is preferred.

Derivation:

Optional. From the GSM item served IMSI as defined in TS GSM 12.05. Defined in TS GSM 03.03.

DEVICE_NUMBER

X(24)

Identifies the equipment used by the subscriber during the call; for example, the International Mobile Equipment Identity number (IMEI).

Condition:

Not present where the terminal equipment is not involved in the call; for example, in forwarded call cases.

It is not mandatory for the VPLMN to transfer this information.

Derivation:

Optional. From the GSM item IMEI as defined in TS GSM 12.05. Defined in TS GSM 03.03.

Note: Even though the IMEI is 16 digits in length, the check digit is not transmitted.

A_NUMBER_USER

X(40)

The customer who owns the number from which the call was originated, for terminated calls.

Not used for rating, but could be used on invoices.

Condition:

There is no calling number present where it is unavailable. Could be different from the A Number; for example, in case of VPN calls. For VPN calls, the A Number contains the party to be billed, and this field contains the user initiating the call.

Values:

See A_NUMBER.

Derivation:

Optional. From the GSM item Calling Number as defined in TS GSM 12.05. This item is of type Address String and is further expanded into the items type of number, numbering plan, and the number sent across the air-interface as defined in TS GSM 04.08 and 09.02 or in international notation. Set by the first processor and left unchanged.

DIALED_DIGITS

X(40)

The number dialed by the customer when establishing a call, or the number to which the call is forwarded or transferred.

Can be used for managing disputes.

Condition:

There might be no called number for the basic service emergency call but operators might optionally insert the digits 112 or their national emergency number into this field. The notation should always be local; for example, 04106768124.

Values:

See B_NUMBER.

Derivation:

Optional. From the GSM item Calling Number as defined in TS GSM 12.05. This item is of type Address String and is further expanded into the items type of number, numbering plan, and the number sent across the air-interface as defined in TS GSM 04.08 and 09.02 or in international notation. Set by the first processor and left unchanged.

BASIC_DUAL_SERVICE

X(3)

A dual service can be used in context with twin or duo cards.

VAS/PRODUCT_CODE

X(10)

A classification of Value Added Services as generated by the sender.

Can be used to map to a specific internal service code to implement specific usage scenarios for any rating purposes.

Values:

VMAIL: Voice Mail Services

SEC: Secretarial Services

OPER: Telephonic Operator Services

FI: Financial Information

TRAVEL: Travel Information

This is not a definitive list and might be added to through MoU-TADIG from time to time or might be user defined.

Derivation:

Optional. From the GSM item vasCode as defined in GSM TD17. Set by the first processor and left unchanged.

ORIGINATING_SWITCH_IDENTIFICATION

X(15)

Identifies the MSC or SwitchID handling the origin of the call. In case of mobile roaming calls (GSM), this field contains the MOC-related MCC/MNC. In case of wireline networks, this field contains the primary switch that generated this CDR.

Can be used by any interconnect rating processor to uniquely identify the trunk names but will only be used if the trunk names are only unique within the related switch. See TRUNK_INPUT and TRUNK_OUTPUT.

Can also be used to normalize the A Number for MOC roaming. In case of roaming, this field contains the MCC/MNC.

Encoding:

Encoded as one of the following according to the requirements of the sender:

  • The MSISDN of the MSC as per GSM 03.03; for example, 44836100456.

  • The signaling point code as per GSM 03.03; for example, 253464.

  • The MCC/MNC (TADIG, PLMN) for mobile roaming calls; for example, 26201.

  • MCC = Mobile Country Code, MNC = Mobile Network Code

  • A name; for example, "HELSINKI": Must be uppercase.

  • A switchID as set up within a local fixed network structure.

Derivation:

Optional, only mandatory in case of interconnect records (for intercarrier rating/billing reasons,) or for mobile (roaming) records.

Note: The switch might not be needed if the trunk names are unique within the total network). Set by the first processor and left unchanged.

TERMINATING_SWITCH_IDENTIFICATION

X(15)

Identifies the MSC or Switch ID handling the termination of the call. In case of mobile roaming calls (GSM), this field contains the MTC-related MCC/MNC. In case of wireline networks, this field contains the secondary switch or is empty.

Can be used to normalize the B Number in case of MTC-roaming cause. In case of roaming, this field contains the MCC/MNC.

Encoding:

Encoded as one of the following according to the requirements of the sender:

  • The MSISDN of the MSC as per GSM 03.03; for example, 44836100456.

  • The signaling point code as per GSM 03.03; for example, 253464.

  • The MCC/MNC (TADIG, PLMN) for mobile roaming calls; for example, 26201

  • MCC = Mobile Country Code; MNC = Mobile Network Code

  • A name; for example, "HELSINKI": Must be uppercase.

  • A switch ID as set up within a local fixed network structure.

Derivation:

Optional, only mandatory in case mobile (roaming) records.

Set by the first processor and left unchanged.

TRUNK_INPUT

X(15)

Trunk identification, inroute address in network switches.

Used for interconnect rating to identify the inroute leg of a call. The inroute leg references a related network operator from which the call was received and how to treat this inroute leg in case of intercarrier rating.

Encoding:

Must uniquely identify a bundled line trunk:

  • Within the given ORIGINATING_SWITCH_IDENTIFICATION.

  • With the global network structure.

Derivation:

Optional, only mandatory in case of interconnect records (for intercarrier rating/billing reasons). Set by the first processor and left unchanged.

TRUNK_OUTPUT

X(15)

Trunk identification, outroute address in network switches.

Can be used by any interconnect rating processor to identify the outroute leg of a call. The outroute leg references a related network operator to which the call was routed or terminated and how to treat this outroute leg in case of intercarrier rating.

Encoding:

Must uniquely identify a bundled line trunk:

  • Within the given TERMINATING_SWITCH_IDENTIFICATION.

  • With the global network structure.

Derivation:

Optional, only mandatory in case of interconnect records. Set by the first processor and left unchanged.

LOCATION_AREA_INDICATOR

X(10)

Identifies the MSC responsible for handling the call and the location of the equipment making or receiving the call. The definition of these items can be found in the Data Dictionary under MSC Identification, Location Area, and Cell Id.

Can be used to map to a specific internal service code to implement a event-dependent rating.

Condition:

Is not available if not supported by the network or the call does not terminate at the equipment; for example, in call forwarding cases.

Values:

The Location Area Code is a two-octet string as defined in TS GSM 04.08.

For the TAP, the octets are converted to a decimal number in the range 0x00000000 to 0xFFFFFFFF.

Derivation:

Optional. From the GSM item locationAreaCode as defined in TS GSM 12.05 or directly taken from the sender (VAS). Set by the first processor and left unchanged.

CELL_ID

X(10)

The cell from which the call originated.

Can be used to identify the location of the caller.

Condition:

Operators might not transfer the cell identity. Only available if the call originates or terminates from a mobile phone; for example, not available in call divert cases.

Values:

The cell identity is a two-octet string as defined in TS GSM 04.08.

However, an original hex value is copied.

Derivation:

Optional. From the GSM item Cell Id as defined in TS GSM 12.05. Set by the first processor and left unchanged.

MS_CLASS_MARK

9(1)

The power capability of the equipment making or receiving the call. Mobiles and transmobiles usually have class 2 capability, handhelds class 4, and PCN applications class 5. Some transmobiles have reduced capability and are classified as class 3.

Usually not used.

Condition:

Only available if supported by the network and the call originates or terminates from the equipment. Is not available in call forwarding cases.

Values:

  1. Class Mark 2

  2. Class Mark 3

  3. Class Mark 4

  4. Class Mark 5

Other values might apply according to the related original input format.

Derivation:

Optional. From the GSM item msclassmark as defined in TS GSM 12.05. Set by the first processor and left unchanged.

TIME_BEFORE_ANSWER

9(5)

The number of seconds until a call was successfully established, defined by the time between the call setup attempt and call answer.

Can be used as a QoS parameter.

Values:

Minimum: 00000

Maximum: 99999

Derivation:

Optional. Set by the first processor and left unchanged.

BASIC_AoC_AMOUNT_VALUE

9(11)

A monetary amount assigned to the event by any rating processor and charged to the recipient of the file. This does not include any surcharges.

Used for roaming or interconnect rating. Can be used to keep the original purchase charge, to evaluate a record based margin together with the charged amount value.

Values:

Space: No price given, like NULL in a database

Floating point format: Given value, might be 0.000. If no floating point exists, the last three digits are always taken as decimals)

Minimum: -9999999999

Maximum: 99999999999

Example:

'00000012500' for 12,50

'-0001200100' for -1.200,10

'00000012.50' for 12,50

'00012.50000' for 12,50

Derivation:

Optional. Usually handed over by the sender of the file, but might also be recalculated by any processor to represent the purchase charge.

BASIC_AoC_AMOUNT_CURRENCY

X(3)

See RETAIL_CHARGED_AMOUNT_CURRENCY.

ROAMER_AoC_AMOUNT_VALUE

9(11)

A monetary amount assigned to the event by any rating processor and charged to the recipient of the file. This is typically a special add-on or surcharge.

Note: The total wholesale charge of a roaming event should be calculated as: Basic AoC Amount + Roamer AoC Amount

Used for roaming and interconnect rating. Can be used to keep the original purchase charge, to evaluate a record based margin together with the charged amount value.

Values:

Space: No price given, like NULL in a database

Floating point format: Given value, might be 0.000. If no floating point exists the last 3 digits are always taken as decimals)

Minimum: -999999999

Maximum: 99999999999

Example:

'00000012500' for 12,50

'-0001200100' for -1.200,10

'00000012.50' for 12,50

'00012.50000' for 12,50

Derivation:

Optional. Usually handed over by the sender (origin network operator) of the file, but might also be recalculated by any processor to represent the purchase charge.

ROAMER_AoC_AMOUNT_CURRENCY

X(3)

See RETAIL_CHARGED_AMOUNT_CURRENCY.

NUMBER_OF_SUPPLEMENTARY_SERVICE_PACKETS

9(2)

Defines the number of Supplementary Service Records following these base fields. For example, 05 means that 5 records are following.

Can be used to evaluate how the record structure continues.

Values:

00 - 99: Either zero or N records are following

Derivation:

Mandatory. Dependent on the input how many supplementary service records are present.

NUMBER_OF_BS_PACKETS

Integer

Defines the number of Basic Service Records following the Supplementary Service Record.

Values:

Default = 0

Derivation:

Mandatory. Dependent on the number of basic service records present.

SERVING_NETWORK

String

Conditional in TAP 3.10 files.

Indicates the network in which the call event was originally created. This field is a unique identifier.

B_CELL_ID

X(10)

Cell ID of the B party receiving the call.

Derivation:

Optional.

A_TERM_CELL_ID

X(10)

Cell ID of the A party when the call terminated.

Derivation:

Optional.

CALL_REFERENCE

String

CallReference item.

Optional

Supplementary Service Event Record (RECType 520)

This optional record is used for all non-call related supplementary service actions. The information attributable to a supplementary service event includes basic event information, location information, equipment information, and details of the supplementary service used.

The record applies only to mobile calls (GSM). Derived from the GSM item parameters as defined in TS GSM 12.05.

Table 77-9 describes the fields in the Supplementary Service Event Record.

Table 77-9 Supplementary Service Event Record Fields

Name Format Description

RECORD_TYPE

String

Extended to be 3 bytes long.

Value:

620 GSM/Wireline Extension Record

Derivation:

Mandatory. Set by the first processor and left unchanged.

RECORD_NUMBER

9(9)

Sequence number of record in file.

Can be used to ensure a linear sequence order for all records; for example, as a sorting criteria.

Values:

Minimum: 000000002

Maximum: 999999998

Derivation:

Mandatory. Set by the first processor.

Important: Following modules might change this record number; for example, if new record types are inserted.

ACTION_CODE

H(1)

Qualifies the way in which the supplementary service is used.

Values:

0: Registration

1: Erasure

2: Activation

3: Deactivation

4: Interrogation

5: Invocation

6: Registration of Password

9: Switch related

Other values might apply according to the related original input format.

SS_EVENT

H(2)

Uniquely defines the supplementary service or a group of supplementary services.

Values:

00: All supplementary services

10: All line identification services

11: Calling number identification presentation

12: Calling number identification restriction

13: Connected number identification presentation

14: Connected number identification restriction

15: Malicious Call Identification

20: all call forwarding

21: Call forwarding unconditional

28: All conditional Call Forwarding

29: Call forwarding on mobile subscriber busy

2A: Call forwarding on no reply

2B: Call forwarding on subscriber not reachable

30: All call offering services

31: Call transfer

32: Mobile Access Hunting

40: all call completion services

41: Call waiting

42: Call hold

43: Completion of calls to busy subscribers

50: All multiparty services

51: multiparty service

60: All community of interest services

61: closed user groups

70: all charging supplement services

71: Advice of charge (charging)

72: Advice of charge (information)

80: All additional info transfer services

81: User to user signaling

90: All call barring

91: All Barring of outgoing Call Services

92: Barring of all outgoing calls

93: Barring of all outgoing international calls

94: Barring of all OG international except HPLMN

99: All Barring of incoming Call Services

SS_EVENT

(contd)

N/A

Uniquely defines the supplementary service or a group of supplementary services (contd).

9A: Barring of all incoming calls

9B: Barring of all IC calls when outside HPLMN

all Switch related Services:

01...59: see related switch documentation (values used 1:1)

Other values might apply according to the related original input format.

SS_PARAMETERS

String

Optional.

THIRD_PARTY_NUMBER

String

Optional.

CLIR_INDICATOR

Integer

Optional.

CHARGING_START_TIMESTAMP

Date

Optional.

CHARGING_END_TIMESTAMP

Date

Optional.

UTC_END_TIME_OFFSET

X(5)

Timezone where the call terminated.

Derivation:

Optional.

BASIC_SERVICE_CODE_LIST

String

Optional.

Associated Roaming Extension Record

Table 77-10 lists the fields in the Associated Roaming Extension Record.

Table 77-10 Associated Roaming Extension Record Fields

Name Format Description

RECORD_TYPE

String

None

RECORD_NUMBER

Integer

None

TAP_FILE_SEQ_NO

Integer

None

RAP_FILE_SEQ_NO

Integer

None

RAP_RECORD_TYPE

String

None

SENDER

String

None

RECIPIENT

String

None

TAP_FILE_PATH

String

None

START_MISSING_SEQ_NUM

Integer

None

END_MISSING_SEQ_NUM

Integer

None

SUSPENSION_TIME

Date

None

PORT_NUMBER

String

None

TOTAL_TAX_REFUND

Decimal

None

TOTAL_DISCOUNT_REFUND

Decimal

None

GUARANTEED_BIT_RATE

String

None

MAXIMUM_BIT_RATE

String

None

HSCSD_INDICATO

String

None

SMS_ORIGINATOR

String

None

SMS_DESTINATION_NUMBER

String

None

DISCOUNTABLE_AMOUNT

Decimal

None

DISCOUNT_CODE

Integer

None

NETWORKACCESS_IDENTIFIE

String

None

ISM_SIGNALLING_CONTEXT

Integer

None

IMSI

String

None

HOME_BID

String

None

HOMELOCATION_DESCRIPTION

String

None

MOBILE_ID_NUMBER

String

None

MOBILE_DIR_NUMBER

String

None

TOTAL_ADVISEDCHARGE

Decimal

None

TOTAL_ADVISEDCHARGE_REFUND

Decimal

None

TOTAL_COMMISSION

Decimal

None

TOTAL_COMMISSION_REFUND

Decimal

None

ITEM_OFFSET

Integer

None

ERROR_CODE

Integer

None

TOTAL_SEVERE_RETURN_VALUE

Decimal

None

RETURN_DETAILS_COUNT

Integer

None

CLIR_INDICATOR

String

None

Associated RAP Extension Record

Table 77-11 lists the fields in the Associated RAP Extension Record.

Table 77-11 Associated RAP Extension Record Fields

Name Format Description

PATH_ITEMID

Integer

None

ITEM_OCCURRENCE

Integer

None

ITEM_LEVEL

Integer

None

Basic Service Event Record (RECType 520)

This optional record is used to store related TAP data.

The record applies only to mobile calls (GSM). Derived from the GSM item parameters as defined in TS GSM 12.05.

Table 77-12 lists the fields in the Basic Service Event Record.

Table 77-12 Basic Service Event Record Fields

Name Format Description

RECORD_TYPE

String

Extended to be 3 bytes long.

Value:

520 GSM/Wireline Extension Record

Derivation:

Mandatory. Set by the first processor and left unchanged.

RECORD_NUMBER

9(9)

Sequence number of record in file.

Can be used to ensure a linear sequence order for all records; for example, as a sorting criteria.

Values:

Minimum: 000000002

Maximum: 999999998

Derivation:

Mandatory. Set by the first processor.

Important: Following modules might change this record number; for example, if new record types are inserted.

CHAIN_REFERENCE

String

Mandatory.

LONG_DURATION_INDICATOR

String

Mandatory.

BASIC_SERVICE

String

None

QOS_REQUESTED

String

None

QOS_USED

String

None

CHARGING_START_TIMESTAMP

Date

None

CHARGING_END_TIMESTAMP

Date

None

UTC_TIME_OFFSET

String

None

NUMBER_OF_UNITS

Decimal

None

WHOLESALE_CHARGED_AMOUNT_VALUE

Decimal

None

WHOLESALE_CHARGED_TAX_RATE

Integer

None

WHOLESALE_CHARGED_TAX_VALUE

Decimal

None

SPEECH_VERSION_REQUESTED

String

None

SPEECH_VERSION_USED

String

None

TRANSPARENCY_INDICATOR

String

None

FNUR

String

None

AIUR_REQUESTED

String

None

USER_PROTOCOL_INDICATOR

Integer

None

DATA_VOLUME_REFERENCE

String

None

Most-Called Information

This block contains the aggregated amount, duration, and occurrences of the most-called numbers. The number will be listed in the LIST attribute. The values listed in Table 77-13 can be used in EVAL expressions to give discounts based on most-called numbers.

Table 77-13 Most-Called Information Fields

Name Format Description

AMOUNT

Decimal

Aggregated amount.

COUNT

Decimal

Aggregated occurrences.

LIST

Integer

Number.

QUANTITY

String

Aggregated duration.

HSCSD Information Packet Record

This optional record is used to store related TAP data.

The record applies only to mobile calls (GSM). Derived from the GSM item parameters as defined in TS GSM 12.05.

High Speed Circuit Switched Data allows users subscribing to the General Bearer Service to use higher transmission rates by using multiple traffic channels simultaneously. This group element must contain Basic HSCSD parameters as at call setup and may also contain details of changes to those parameters.

Table 77-14 lists the fields in the HSCSD Information Packet Record.

Table 77-14 HSCSD Information Packet Record

Name Format Description

NUMBER_OF_CHANNELS

String

NumberOfChannels item.

Mandatory.

CHANNEL_CODING_OK_LIST

Integer

ChannelCodingAcceptable list (comma-separated integers).

Mandatory.

CHANNEL_CODING_USED

Integer

ChannelCoding item.

Mandatory.

NUMBER_OF_CHANNELS_USED

Integer

NumberOfChannelsUsed item.

Mandatory.

PM_LIST

Block

Optional.

HSCSDParameterModification list.

AIUR

Integer

AiurRequested item.

MAX_NUMBER_OF_CHANNELS

Integer

NumberOfChannels item.

Optional.

CHANNEL_CODING_USED

Integer

ChannelCoding item.

Mandatory.

NUMBER_OF_CHANNELS_USED

Integer

NumberOfChannelsUsed item.

Mandatory.

INITIATING_PARTY

Integer

InitiatingParty item.

Mandatory.

MODIFICATION_TIMESTAMP_

Date

ModificationTimestamp item.

Mandatory.

UTC_TIME_OFFSET

String

NumberOfChannels item.

Associated GPRS Extension Record (RECType 540)

This record stores GPRS service information. This record is optional and will be generated only if the related Basic Detail Record indicates a GPRS service.

Table 77-15 describes the fields in the Associated GPRS Extension Record.

Table 77-15 Associated GPRS Extension Record Fields

Name Format Description

RECORD_TYPE

String

Extended to be 3 bytes long.

Value:

540 Associated GPRS Extension Record

RECORD_NUMBER

9(9)

Sequence number of record in file.

Can be used to ensure a linear sequence order for all records; for example, as a sorting criteria.

Derivation:

Mandatory. Set by the first processor.

Important: Following modules might change this record number; for example, if new record types are inserted.

PORT_NUMBER

X(24)

Identifies the customer IMSI or SIM number.

Option:

For Value Added Services and APLMN Service Center Usage, either the IMSI or MSISDN might be supplied, although one of them must be supplied and, where available, the IMSI is preferred. For normal mobile calls, the SIM number is preferred.

Derivation:

Optional. From the GSM item served IMSI as defined in TS GSM 12.05. Defined in TS GSM 03.03.

DEVICE_NUMBER

X(24)

Identifies the equipment used by the subscriber during the call; for example, the International Mobile Equipment Identity number (IMEI).

Condition:

Not present where the terminal equipment is not involved in the call; for example, in forwarded call cases.

It is not mandatory for the VPLMN to transfer this information.

Derivation:

Optional. From the GSM item IMEI as defined in TS GSM 12.05. Defined in TS GSM 03.03.

Note: Even though the IMEI is 16 digits in length, the check digit is not transmitted.

A_NUMBER_USER

X(40)

The customer who owns the number from which the call was originated, for terminated calls.

Not used for rating, but could be used on invoices.

Condition:

There is no calling number present where it is unavailable. Could be different from the A Number; for example, in case of VPN calls. For VPN calls, the A Number contains the party to be billed, and this field contains the user initiating the call.

Values:

See A_NUMBER.

Derivation:

Optional. From the GSM item Calling Number as defined in TS GSM 12.05. This item is of type Address String and is further expanded into the items type of number, numbering plan and the number sent across the air-interface as defined in TS GSM 04.08 and 09.02 or in international notation. Set by the first processor and left unchanged.

DIALED_DIGITS

X(40)

The number dialed by the customer when establishing a call or the number to which the call is forwarded or transferred.

Can be used for managing disputes.

Condition:

There might be no called number for the basic service emergency call but operators might optionally insert the digits 112 or their national emergency number into this field. The notation should always be local; for example, 04106768124.

Values:

See B_NUMBER.

Derivation:

Optional. From the GSM item Calling Number as defined in TS GSM 12.05. This item is of type Address String and is further expanded into the items type of number, numbering plan and the number sent across the air-interface as defined in TS GSM 04.08 and 09.02 or in international notation. Set by the first processor and left unchanged.

VAS/PRODUCT_CODE

X(10)

A classification of Value Added Services as generated by the sender.

Can be used to map to a specific internal service code to implement specific usage scenarios for any rating purposes.

Values:

VMAIL: Voice Mail Services

SEC: Secretarial Services

OPER: Telephonic Operator Services

FI: Financial Information

TRAVEL: Travel Information

This is not a definitive list and might be added to through MoU-TADIG from time to time or might be user defined.

Derivation:

Optional. From the GSM item vasCode as defined in GSM TD17. Set by the first processor and left unchanged.

ORIGINATING_SWITCH_IDENTIFICATION

X(15)

Identifies the MSC or SwitchID handling the origin of the call. In case of mobile roaming calls (GSM), this field contains the MOC-related MCC/MNC. In case of wireline networks, this field contains the primary switch that generated this CDR.

Can be used by any interconnect rating processor to uniquely identify the trunk names but will only be used if the trunk names are only unique within the related switch. See TRUNK_INPUT and TRUNK_OUTPUT.

Can also be used to normalize the A Number for MOC roaming. In case of roaming, this field contains the MCC/MNC.

Encoding:

Encoded as one of the following according to the requirements of the sender:

  • The MSISDN of the MSC as per GSM 03.03; for example, 44836100456.

  • The signaling point code as per GSM 03.03; for example, 253464.

  • The MCC/MNC (TADIG, PLMN) for mobile roaming calls; for example, 26201.

  • MCC = Mobile Country Code; MNC = Mobile Network Code

  • A name; for example, "HELSINKI": Must be uppercase.

  • A switchID as set up within a local fixed network structure.

Derivation:

Optional, only mandatory in case of interconnect records (for intercarrier rating/billing reasons,) or for mobile (roaming) records. Set by the first processor and left unchanged.

The switch might not be needed if the trunk names are unique within the total network).

TERMINATING_SWITCH_IDENTIFICATION

X(15)

Identifies the MSC or Switch ID handling the termination of the call. In case of mobile roaming calls (GSM), this field contains the MTC-related MCC/MNC. In case of wireline networks, this field contains the secondary switch or is empty.

Can be used to normalize the B Number in case of MTC-roaming cause. In case of roaming, this field contains the MCC/MNC.

Encoding:

Encoded as one of the following according to the requirements of the sender:

  • The MSISDN of the MSC as per GSM 03.03; for example, 44836100456.

  • The signaling point code as per GSM 03.03; for example, 253464.

  • The MCC/MNC (TADIG, PLMN) for mobile roaming calls; for example, 26201.

  • MCC = Mobile Country Code; MNC = Mobile Network Code

  • A name; for example, "HELSINKI": Must be uppercase.

  • A switch ID as set up within a local fixed network structure.

Derivation:

Optional, only mandatory in case of mobile (roaming) records. Set by the first processor and left unchanged.

MS_CLASS_MARK

9(1)

The power capability of the equipment making or receiving the call. Mobiles and transmobiles usually have class 2 capability, handhelds class 4, and PCN applications class 5. Some transmobiles have reduced capability and are classified as class 3.

Usually not used.

Condition:

Only available if supported by the network and the call originates or terminates from the equipment. Is not available in call forwarding cases.

Values:

  1. Class Mark 2

  2. Class Mark 3

  3. Class Mark 4

  4. Class Mark 5

Other values might apply according to the related original input format.

Derivation:

Optional. From the GSM item msclassmark as defined in TS GSM 12.05. Set by the first processor and left unchanged.

ROUTING_AREA

X(10)

Routing Area at the time of record creation (S-CDR only).

LOCATION_AREA_INDICATOR

X(10)

Identifies the MSC responsible for handling the call and the location of the equipment making or receiving the call. The definition of these items can be found in the Data Dictionary under MSC Identification, Location Area, and Cell Id.

Can be used to map to a specific internal service code to implement a event-dependent rating.

Condition:

Is not available if not supported by the network or the call does not terminate at the equipment; for example, in call forwarding cases.

Values:

The Location Area Code is a two-octet string as defined in TS GSM 04.08.

For the TAP, the octets are converted to a decimal number in the range 0x00000000 to 0xFFFFFFFF.

Derivation:

Optional. From the GSM item locationAreaCode as defined in TS GSM 12.05 or directly taken from the sender (VAS). Set by the first processor and left unchanged.

CHARGING_ID

Decimal

PDP context identifier used to identify this PDP context in different records created by GSNs.

This field is a charging identifier which can be used together with GGSN address to identify all records produced in SGSN(s) and GGSN involved in a single PDP context. Charging ID is generated by GGSN at PDP context activation and transferred to context requesting SGSN. At inter-SGSN routing area update, charging ID is transferred to the new SGSN as part of each active PDP context.

Different GGSNs allocate the charging ID independently of each other and might allocate the same numbers. The CGF and/or BS might check the uniqueness of each charging ID together with the GGSN address and optionally (if still unambiguous) with the record opening timestamp.

SGSN_ADDRESS

X(64)

Current SGSN Address used.

Optional.

GGSN_ADDRESS

X(64)

IP Address of the GGSN currently used.

Optional.

WLAN_ADDRESS

String

Optional.

APN_ADDRESS

X(64)

The logical name of the connected access point to the external packet data network. APN comprises network identifier and operator identifier. This field contains the logical Access Point Name used to determine the actual connected access point. APN comprises network identifier and operator identifier. APN can also be a wildcard, in which case SGSN selects the access point address. See GSM 03.03 [4] and GSM 03.60 [8] for more information about APN format and access point decision rules.

NODE_ID

X(64)

Name of the recording entity; for example, could be the charging gateway name.

TRANS_ID

9(10)

Sequence number which the recording entity generates (NODE_ID). The number is allocated sequentially including all CDR types. It links together the CDR of a same recording entity.

SUB_TRANS_ID

9(10)

Partial record sequence number. This field contains a running sequence number which links the partial records generated for a PDP context/GPRS session. It can be used in post-processing to detect missing CDRs for a GPRS session. It links together the CDRs/events of a same session.

NETWORK_INITIATED_PDP

9(1)

Network Initiated PDP context. The network initiates a context when it calls an ME.

Values:

0: False

1: True

PDP_TYPE

X(4)

Defines the PDP type; for example, X.25, IP, PPP, or IHOSS:OSP (see GSM 09.60 for exact format).

PDP_ADDRESS

X(64)

PDP address of the served IMSI (Ipv4, IPv6, X.121).

PDP_REMOTE_ADDRESS

X(255)

List of PDP address of remote host (comma-separated value, G-CDR only, X25 only).

PDP_DYNAMIC_ADDRESS

9(1)

Indicates that the PDP address has been dynamically allocated for that particular PDP context. This field is missing if address is static; for example, part of PDP context subscription. Dynamic address allocation might be relevant for charging; for example, the duration of PDP context as one balance element offered and possibly owned by network operator.

Values:

0: False

1: True

DIAGNOSTICS

X(255)

Includes a more detailed technical reason for the release of the connection and might contain one of the following:

  • A MAP error from GSM 09.02 [17]

  • A Cause from GSM 04.08 [16]

The diagnostics might also be extended to include manufacturer and network-specific information.

CELL_ID

X(10)

The cell from which the call originated.

Can be used to identify the location of the caller.

Condition:

Operators might not transfer the cell identity. Only available if the call originates or terminates from a mobile phone; for example, not available in call divert cases.

Values:

The cell identity is a two-octet string as defined in TS GSM 04.08.

However, an original hex value is copied.

Derivation:

Optional. From the GSM item Cell Id as defined in TS GSM 12.05. Set by the first processor and left unchanged.

CHANGE_CONDITION

9(1)

The condition that triggers the creation of this volume container as defined by ETSI.

Values:

0: Quality of Service Change

1: Tariff Change

2: Record Closed

QoS_REQUESTED_PRECEDENCE

X(1)

The priority applicable to a GPRS connection.

Condition:

Mandatory within groups GSM Quality Of Service Requested.

Values:

0: Unspecified

1: High Priority

2: Normal Priority

3: Low Priority

Derivation:

GSM item QoS Precedence (GSM 12.15).

QoS_REQUESTED_DELAY

X(1)

The transfer delay applicable to a GPRS connection.

Condition:

Mandatory within groups GSM Quality Of Service Requested.

Values:

0: Delay class 1

1: Delay class 2

2: Delay class 3

3: Delay class 4

Derivation:

GSM item QoSDelay (GSM 12.15).

QoS_REQUESTED_RELIABILTY

X(1)

The reliability applicable to a GPRS connection.

Condition:

Mandatory within groups GSM Quality Of Service Requested.

Values:

0: Unspecified Reliability

1: Acknowledged GTP

2: Unacknowledged GTP/acknowledged LLC

3: Unacknowledged GTP/ acknowledged RLC

4: Unacknowledged GTP/LLC/RLC

5: Unacknowledged unprotected data

Derivation:

GSM item QoS Reliability (GSM 12.15).

QoS_REQUESTED_PEAK_THROUGHPUT

X(2)

The peak throughput applicable to a GPRS connection.

Condition:

Mandatory within groups GSM Quality Of Service Requested.

Values:

0: Unspecified

1: Up to 100 octets per seconds

2: Up to 200 octets per seconds

3: Up to 400 octets per seconds

4: Up to 800 octets per seconds

5: Up to 1600 octets per seconds

6: Up to 3200 octets per seconds

7: Up to 6400 octets per seconds

8: Up to 12800 octets per seconds

9: Up to 25600 octets per seconds

Derivation:

GSM item QoS Peak Throughput (GSM 12.15).

QoS_REQUESTED_MEAN_THROUGHPUT

X(2)

The mean throughput applicable to a GPRS connection.

Condition:

Mandatory within groups GSM Quality Of Service Requested.

Values:

0: Best Effort

1: Mean 100 octets per hour

2: Mean 200 octets per hour

3: Mean 500 octets per hour

4: Mean 1000 octets per hour

5: Mean 2000 octets per hour

6: Mean 5000 octets per hour

7: Mean 10000 octets per hour

8: Mean 20000 octets per hour

9: Mean 50000 octets per hour

10: Mean 100000 octets per hour

11: Mean 200000 octets per hour

12: Mean 500000 octets per hour

13: Mean 1000000 octets per hour

14: Mean 2000000 octets per hour

15: Mean 5000000 octets per hour

16: Mean 10000000 octets per hour

17: Mean 20000000 octets per hour

18: Mean 50000000 octets per hour

Derivation:

GSM item QoS Mean Throughput (GSM 12.15).

QoS_USED_PRECEDENCE

X(1)

Quality of Service Precedence class.

See QoS_REQUESTED_PRECEDENCE.

QoS_USED_DELAY

X(1)

QOS delay class, defined by ETSI.

See QoS_REQUESTED_DELAY.

QoS_USED_RELIABILTY

X(1)

QOS reliability class, defined by ETSI.

See QoS_REQUESTED_RELIABILTY.

QoS_USED_PEAK_THROUGHPUT

X(2)

QOS peak throughput class, defined by ETSI.

See QoS_REQUESTED_PEAK_THROUGHPUT.

QoS_USED_MEAN_THROUGHPUT

X(2)

QOS mean throughput class, defined by ETSI.

See QoS_REQUESTED_MEAN_THROUGHPUT.

NETWORK_CAPABILITY

X(10)

MS network capability information element of the served MS on PDP context activation or on GPRS attachment as defined in GSM 04.08 [16].

Condition:

Optional.

Derivation:

GSM item network capability (GSM 04.08 [16]).

SGSN_CHANGE

9(1)

Indicates that this is the first record after an inter-SGSN routing area update.

Condition:

Mandatory.

Values:

0: default, if this is not the 1st record

1: indicates the first record after an inter SGSN-change

START_SEQUENCE_NO

String

Optional.

END_SEQUENCE_NO

String

Optional.

B_CELL_ID

X(10)

Cell ID of the B party receiving the call.

Derivation:

Optional.

A_TERM_CELL_ID

X(10)

Cell ID of the A party when the call terminated.

Derivation:

Optional.

PDP_CONTEXT_START_TIMESTAMP

Date

Conditional in TAP 3.10.

Indicates the start time of the PDP context when the Call Event Details (GPRS Call) represents an intermediate or last partial of a PDP context.

Used in TAP files.

Format:

CCYYMMDDHHMMSS

PDP_UTC_TIME_OFFSET

String

Conditional in TAP 3.10.

Indicates the UTC time offset for PDP_CONTEXT_START_TIMESTAMP.

SERVICE_USED_CHARGING_START_TIMESTAMP

Date

Conditional in TAP 3.10.

Indicates the start time for charging GPRS calls. This field is present when the value is not the same as the associated Call Event Start Timestamp field (DETAIL.ASS_GPRS_EXT.GS_PACKET.CHARGING_START_TIMESTAMP).

Used in TAP files.

Format:

CCYYMMDDHHMMSS

SERVICE_USED_UTC_TIME_OFFSET

String

Conditional in TAP 3.10.

Indicates the UTC time offset for SERVICE_USED_CHARGING_START_TIMESTAMP.

TYPE_OF_CONTROLLING_NODE

Integer

Conditional in TAP 3.10.

GPRS_SERVICE_USAGE_PACKET

Block

n times. Optional.

Mandatory.

CHARGING_START_TIMESTAMP

Date

Optional.

CHARGING_END_TIMESTAMP

Date

Optional.

UTC_TIME_OFFSET

String

Optional.

QOS_REQUESTED_PRECEDENCE

String

Optional.

QOS_REQUESTED_DELAY

String

Optional.

QOS_REQUESTED_RELIABILITY

String

Optional.

QOS_REQUESTED_PEAK_THROUGHPUT

String

Optional.

QOS_REQUESTED_MEAN_TRHOUGHPUT

String

Optional.

QOS_USED_PRECEDENCE

String

Optional.

QOS_USED_DELAY

String

Optional.

QOS_USED_RELIABILITY

String

Optional.

QOS_USED_PEAK_TRHOUGHPUT

String

Optional.

QOS_USED_MEAN_TRHOUGHPUT

String

Optional.

VOLUME_RECEIVED

Decimal

Mandatory.

VOLUME_SENT

Decimal

Mandatory.

UMTS_QOS_REQUESTED

String

Optional.

Identifies the UMTS Quality of Service requested for GPRS calls.

Used in TAP files.

Format: This field contains comma-separated tag-value pairs of the following TAP fields with their respective tags as shown below:

  • QoS Traffic Class: 1

  • QoS Max Bit Rate Uplink: 2

  • Qos Max Bit Rate Downlink: 3

  • Qos Guaranteed Bit Rate Downlink: 4

  • Qos Guaranteed Bit Rate Uplink: 5

  • Qos Allocation Retention Priority: 6

The fields QoS Traffic Class, QoS Max Bit Rate Uplink, Qos Max Bit Rate Downlink are Mandatory. The others are optional.

Example 1: If the TAP field values are as follows:

  • QoS Traffic Class: 3

  • QoS Max Bit Rate Uplink: 63

  • Qos Max Bit Rate Downlink: 128

  • Qos Guaranteed Bit Rate Downlink: 61

  • Qos Guaranteed Bit Rate Uplink: 250

  • Qos Allocation Retention Priority: 3

The value of the EDR field is

1,3,2,63,3,128,4,61,5,250,6,3

Example 2: If the TAP field values are as follows:

QoS Traffic Class: 2

QoS Max Bit Rate Uplink: 56

Qos Max Bit Rate Downlink: 128

Qos Guaranteed Bit Rate Uplink: 250

The value of the EDR field is:

1,2,2,56,3,128,5,250

UMTS_QOS_USED

String

Optional.

Identifies the UMTS Quality of Service used for GPRS calls.

Used in TAP files.

The description for this field is identical to the description for UMTS_QOS_REQUESTED.

Associated WAP Extension Record (RECType 570)

Stores information for WAP events. This record is optional and will only be generated if the related Basic Detail Record indicates a WAP service.

Table 77-16 describes the fields in the Associated WAP Extension Record.

Table 77-16 Associated WAP Extension Record Fields

Name Format Description

RECORD_TYPE

String

Extended to be 3 bytes long.

Value:

570 Associated WAP Extension Record

RECORD_NUMBER

9(9)

Sequence number of record in file.

Can be used to ensure a linear sequence order for all records; for example, as a sorting criteria.

Derivation:

Mandatory. Set by the first processor.

Important: Following modules might change this record number; for example, if new record types are inserted.

PORT_NUMBER

X(24)

Identifies the customer IMSI or SIM number.

Option:

For Value Added Services and APLMN Service Center Usage either the IMSI or MSISDN might be supplied, although one of them must be supplied and, where available, the IMSI is preferred. For normal mobile calls, the SIM number is preferred.

Derivation:

Optional. From the GSM item served IMSI as defined in TS GSM 12.05. Defined in TS GSM 03.03.

DEVICE_NUMBER

X(24)

Identifies the equipment used by the subscriber during the call; for example, the International Mobile Equipment Identity number (IMEI).

Condition:

Not present where the terminal equipment is not involved in the call; for example, in forwarded call cases.

It is not mandatory for the VPLMN to transfer this information.

Derivation:

Optional. From the GSM item IMEI as defined in TS GSM 12.05. Defined in TS GSM 03.03.

Note: Even though the IMEI is 16 digits in length, the check digit is not transmitted.

SESSION_ID

X(64)

Session ID as provided by the WAP gateway.

RECORDING_ENTITY

X(64)

Name of the recording Entity; for example, the WAP gateway or mediation device.

TERMINAL_CLIENT_ID

X(64)

The served WAP terminal client ID (WAP gateway user identity).

TERMINAL_IP_ADDRESS

X(64)

IP address of the WAP terminal.

DOMAIN_URL

X(255)

URL implementing the service.

BEARER_SERVICE

X(3)

See BASIC_SERVICE.

BEARER_SERVICE_CODE

X(2)

See SERVICE_CODE.

HTTP_STATUS

9(3)

HTTP status code from the origin server or servlet.

Values:

100: CONTINUE

101: SWITCHING_PROTOCOLS

200: SUCCESS

201: CREATE

202: ACCEPTED

203: NON-AUTHORITATIVE_INFORMATION

204: NO_CONTENT

205: RESET_CONTENT

206: PARTIAL_CONTENT

300: MULTIPLE_CHOICE

301: MOVED_PERMANENTLY

302: FOUND

303: SEE_OTHER

304: NOT_MODIFIED

305: USE_PROXY

307: TEMPORARY_REDIRECT

400: BAD_REQUEST

401: UNAUTHORIZED

402: PAYMENT_REQUIRED

403: FORBIDDEN

404: NOT_FOUND

405: METHOD_NOT_ALLOWED

406: NOT_ACCEPTABLE

407: PROXY_AUTHENTICATION_REQUIRED

408: REQUEST_TIMEOUT

409: CONFLICT

410: GONE

411: LENGTH_REQUIRED

412: PRECONDITION_FAILED

413: REQUEST_ENTITY_TOO_LARGE

414: REQUEST-URI_TOO_LONG

415: UNSUPPORTED_MEDIA_TYPE

416: REQUESTED_RANGE_NOT_SATISFIABLE

417: EXPECTATION_FAILED

500: INTERNAL_SERVER_ERROR

501: NOT_IMPLEMENTED

502: BAD_GATEWAY

503: SERVICE_UNAVAILABLE

504: GATEWAY_TIMEOUT

505: HTTP_VERSION_NOT_SUPPORTED

WAP_STATUS

9(3)

The WSP/WAP status code.

Values:

16: CONTINUE

17: SWITCHING_PROTOCOLS

20: OK, SUCCESS

33: CREATED

34: ACCEPTED

35: NON-AUTHORITATIVE_INFORMATION

36: NO_CONTENT

37: RESET_CONTENT

38: PARTIAL_CONTENT

48: MULTIPLE_CHOICE

49: MOVED_PERMANENTLY

50: MOVED_TEMPORARILY

51: SEE_OTHER

52: NOT_MODIFIED

53: USE_PROXY

55: TEMPORARY_REDIRECT

64: BAD_REQUEST

65: UNAUTHORIZED

66: PAYMENT_REQUIRED

67: FORBIDDEN

68: NOT_FOUND

69: METHOD_NOT_ALLOWED

70: NOT_ACCEPTABLE

71: PROXY_AUTHENTICATION_REQUIRED

72: REQUEST_TIMEOUT

73: CONFLICT

74: GONE

75: LENGTH_REQUIRED

76: PRECONDITION_FAILED

77: REQUEST_ENTITY_TOO_LARGE

78: REQUEST-URI_TOO_LONG

79: UNSUPPORTED_MEDIA_TYPE

80: REQUESTTED_RANGE_NOT_SATISFIABLE

81: EXPECTATION_FAILED

96: INTERNAL_SERVER_ERROR

97: NOT_IMPLEMENTED

98: BAD_GATEWAY

99: SERVICE_UNAVAILABLE

100: GATEWAY_TIMEOUT

101: HTTP_VERSION_NOT_SUPPORTED

ACKNOWLEDGE_STATUS

9(1)

Acknowledge status of the response.

Values:

1: OK acknowledgment has been received.

2: Response terminated by the server.

3: Response terminated by the terminal.

4: Acknowledgment has not been received.

5: Acknowledgment is not used with this connection type.

ACKNOWLEDGE_TIME

YYYYMMDDHHMISS

Time of the acknowledgment.

EVENT_NUMBER

X(60)

Assigned user event number as generated by the WAP gateway.

GGSN_ADDRESS

X(64)

IP Address of the GGSN currently used.

SERVER_TYPE

X(64)

A description of the type of server providing the service.

CHARGING_ID

Decimal

PDP context identifier used to identify this PDP context in different records created by GSNs.

This field is a charging identifier which can be used together with GGSN address to identify all records produced in SGSN(s) and GGSN involved in a single PDP context. Charging ID is generated by GGSN at PDP context activation and transferred to context requesting SGSN. At inter-SGSN routing area update, charging ID is transferred to the new SGSN as part of each active PDP context.

Different GGSNs allocate the charging ID independently of each other and might allocate the same numbers. The CGF and/or BS might check the uniqueness of each charging ID together with the GGSN address and optionally (if still unambiguous) with the record opening timestamp.

WAP_LOGIN

X(24)

Login used during the WAP session. This might occur in addition to the MSISDN; for example, this field might contain a user name of a session which has been opened within a WAP session.

Condition:

Optional. Might be mandatory for specific WAP scenarios.

Derivation:

Set by the first processor and left unchanged.

IDENTIFIER

String

Mandatory.

TYPE

Integer

Mandatory.

Associated CAMEL Extension Record (RECType 700)

In the following associated record of the sol42 format extended CAMEL service information could be stored. This record is optional and is attached to any other associated service extension record.

Table 77-17 lists the Associated CAMEL Extension Record fields.

Table 77-17 Associated CAMEL Extension Record Fields

Name Format Description

RECORD_TYPE

String

Extended to be 3 bytes long

Value:

700: Associated CAMEL Extension Record

RECORD_NUMBER

9(9)

Sequence number of record in file.

Can be used to ensure a linear sequence order for all records; for example, as a sorting criteria.

Derivation:

Mandatory. Set by the first processor.

Important: Following modules might change this record number; for example, if new record types are inserted.

SERVER_TYPE_OF_NUMBER

Z(1)

Optional, but should be defaulted to '0'.

Could be used by some modules to perform number-normalization.

SERVER_NUMBERING_PLAN

X(1)

Optional.

SERVER_ADDRESS

X(40)

Identifies the server interrogated.

Mandatory.

SERVICE_LEVEL

Z(1)

Identifies the level of CAMEL service provided [0-3].

Mandatory.

SERVICE_KEY

Z(10)

Identifies the CAMEL service Logic to be applied.

Mandatory.

DEFAULT_CALL_HANDLING_INDICATOR

Z(1)

Indicates whether or not a CAMEL call encountered default handling.

Values:

0: Continue the call

1: Release the call

MSC_TYPE_OF_NUMBER

Z(1)

Optional, but should be defaulted to '0'.

Could be used by some modules to perform number-normalization.

MSC_NUMBERING_PLAN

X(1)

Optional.

MSC_ADDRESS

X(40)

Identifies the MSC that generated the CAMEL reference number (might be different from SERVER_ADDRESS).

Mandatory.

CAMEL_REFERENCE_NUMBER

X(20)

In association with the MSC_ADDRESS, provides a unique identifier for each CAMEL invocation.

Mandatory.

CAMEL_INITIATED_CF_INDICATOR

Z(1)

Optional, but should be defaulted to 0 (1=CAMEL call forwarding).

CAMEL_MODIFICATION_LIST

X(20)

Optional, comma-separated string of integers.

DEST_GSMW_TYPE_OF_NUMBER

Z(1)

Optional, but should be defaulted to '0'.

Could be used by some modules to perform number-normalization.

DEST_GSMW_NUMBERING_PLAN

X(1)

Optional.

DEST_GSMW_NUMBER

X(40)

Optional, used to identify CAMEL redirection destination (could contain an MSISDN, IP, LOGIN, etc.) when the primary extension is of type GSM (for example, ASS_GSMW_EXT).

DEST_GSMW_NUMBER_ORIGINAL

X(40)

Optional, DEST_GSM_NUMBER as received (before normalization).

DEST_GPRS_APN_ADDRESS

X(64)

Optional (but might be mandatory for specific zoning scenarios; for example, if an apn_group is used) when the primary extension is of type GPRS (ie., ASS_GPRS_EXT).

DEST_GPRS_PDP_REMOTE_ADDRESS

X(255)

Optional.

CSE_INFORMATION

X(40)

Optional, the information downloaded by the CAMEL server.

GSM_CALL_REFERENCE_NUMBER

X(20)

Optional.

EXCHANGE_RATE

Decimal

Contains the exchange rate which has been used to convert the Incoming currency to the internal currency as indicated in the field CHARGED_CURRENCY_TYPE.

Can be used to convert the virtual currency SDR (which is used in conjunction of TAP) to internal currencies and convert the Charge back to SDR after Rating. This would be a typical usage for Interconnection Rating.

Values:

Variable floating point format: Given value, might be 0.000. The floating decimal point must be set.

Minimum: -9999999999

Maximum: 99999999999

Examples:

'00000000125' for 125,00

'00000012.50' for 12,50

'-0012.56780' for -12,5678

Derivation:

Optional, defaulted 00000000001 (=1,00).

Associated Suspense Extension Record (RECType 720)

Table 77-18 describes the fields in the Associated Suspense Extension Record. This record is optional and can appear once.

Table 77-18 Associated Suspense Extension Record Fields

Name Format Description

RECORD_TYPE

String

Mandatory.

Default = 720

RECORD_NUMBER

Integer

Mandatory. Auto-generated.

SUSPENSE_STATUS

Integer

Mandatory. Calculated.

SUSPENSE_REASON

Integer

The suspense reason. Mapped from the error code.

Mandatory. Calculated.

SUSPENSE_SUBREASON

Integer

Mandatory. Calculated.

RECYCLE_KEY

String

Search key for choosing EDRs to recycle.

Optional.

ERROR_CODE

Integer

Mandatory. Calculated.

SUSPENSE_ID

Integer

Original suspense POID ID.

Mandatory when recycling.

PIPELINE_NAME

String

The name of the pipeline, derived from the pipeline registry.

Mandatory when recycling. Calculated.

SOURCE_FILENAME

String

The source file name. The same as INTERNAL.STREAM_NAME.

Mandatory. Calculated.

SERVICE_CODE

String

Equal to DETAIL.INTERN_SERVICE_CODE.

Mandatory. Calculated.

EDR_RECORD_TYPE

String

Equal to DETAIL.RECORD_TYPE.

Mandatory. Calculated.

EDR_BUF

String

A stored representation of the EDR container including fields overwritten and enriched by the pipeline.

Mandatory when recycling. Calculated.

UTC_OFFSET_SECONDS

Integer

This value enables Suspense Management Center to represent call record times using the same time zone used in the records themselves. The value represents the offset between the time zone of the EDR and UTC in seconds.

Mandatory. Calculated.

EDR_SIZE

Integer

The size of DETAIL.ASS_SUSPENSE_EXT.EDR_BUF.

Mandatory. Calculated.

QUERYABLE_FIELDS

String

The queryable field values defined in the registry. Separated by tab characters.

Mandatory. Calculated.

OVERRIDE_REASONS

String

Optional. May be set equal to the override reason code during recycling.

ACCOUNT_POID

String

Optional. Calculated.

SUSPENDED_FROM_BATCH_ID

String

Optional. Calculated.

PIPELINE_CATEGORY

String

Mandatory. Calculated.

RECYCLING_MODE

Integer

Mandatory. Calculated.

Equal to DETAIL.INTERN_PROCESS_STATUS

Associated Content Extension Record (RECType 550)

This optional record is used to store related TAP data. Table 77-19 describes the fields in the Associated Content Extension Record.

Table 77-19 Associated Content Extension Record Fields

Name Format Description

RECORD_TYPE

String

Mandatory.

Default = 550.

RECORD_NUMBER

Integer

Sequence number of record in file.

Can be used to ensure a linear sequence order for all records; for example, as a sorting criteria.

Derivation:

Mandatory. Set by the first processor.

Important: Following modules might change this record number; for example, if new record types are inserted.

FRAUD_MONITOR_INDICATOR

String

Optional, but should be defaulted to '0'.

Could be used by some modules to perform number-normalization.

RAP_FILE_SEQ_NO

String

Optional.

ORDER_PLACED_TIMESTAMP

Date

Optional.

ORDER_PLACED_UTC_TIME_OFFSET

String

Mandatory if ORDER_PLACED_TIMESTAMP is present.

REQUESTED_DELIVERY_TIMESTAMP

Date

Optional.

REQ_DELIVERY_UTC_TIME_OFFSET

String

Mandatory if REQUESTED_DELIVERY_TIMESTAMP is present.

ACTUAL_DELIVERY_TIMESTAMP

Date

Optional.

ACT_DELIVERY_UTC_TIME_OFFSET

String

Mandatory if ACTUAL_DELIVERY_TIMESTAMP is present.

TOTAL_TRANSACTION_DURATION

Integer

Optional.

TRANSACTION_STATUS

Integer

Optional.

CHARGED_PARTY_INFO

Block

Charged party information block.

Mandatory.

ID_LIST

 N.A.

ChargedPartyId list.

Mandatory.

HOMEID_LIST

 N.A.

ChargedPartyHomeId list.

Optional.

LOCATION_LIST

 N.A.

ChargedPartyLocation list.

Optional.

EQUIPMENT

 N.A.

ChargedPartyEquipment block.

Optional.

SERVING_PARTIES_INFO

Block

ServingPartiesInformation block.

Mandatory.

PROVIDER_LIST

 N.A.

ContentProviderId list.

Optional.

ISP_LIST

 N.A.

InternetServiceProviderId list.

Optional.

NETWORK_LIST

 N.A.

Network list.

Optional.

SERVICE_USED_LIST

 N.A.

ContentServiceUsed list.

Mandatory.

CONTENT_TRANSACTION_CODE

Integer

ContentTransactionCode item.

Mandatory.

OBJECT_TYPE

Integer

ObjectType item.

Optional.

TRANSACTION_DESCRIPTION_SUPP

Integer

TransactionDescriptionSupp item.

Optional.

TRANSACTION_DETAIL_DESCRIPTION

String

TransactionDetailDescription item.

Optional.

TRANSACTION_IDENTIFIER

String

TransactionIdentifier item.

Mandatory.

TRANSACTION_AUTH_CODE

String

TransactionAuthCode item.

Optional.

DATA_VOLUME_INCOMING

Integer

DataVolumeIncoming item.

Optional.

DATA_VOLUME_OUTGOING

Integer

DataVolumeOutgoing item.

Optional.

TOTAL_DATA_VOLUME

Integer

TotalDataVolume item.

Optional.

CHARGE_REFUND_INDICATOR

Integer

ChargeRefundIndicator item.

Optional.

CONTENT_CHARGING_POINT

Integer

ContentChargingPoint item.

Optional.

PAID_INDICATOR

Integer

PaidIndicator item.

Optional.

PAYMENT_METHOD

Integer

PaymentMethod item.

Optional.

ADVISED_CHARGE_CURRENCY

String

AdvisedChargeCurrency item.

Optional.

ADVISED_CHARGE

Decimal

AdvisedCharge item.

Optional.

Mandatory in the AdvisedChargeInformation block.

COMMISSION

Decimal

Commission item.

Optional.

Associated Location Extension Record

The OutGrammar stores information of Content and Location from the EDR container into the output TAP blocks. This is performed using ASN calls of iScript in TAP version 3.10 OutGrammar.

Table 77-20 describes the fields in the Associated Location Extension Record.

Table 77-20 Associated Location Extension Record Fields

Name Format Description

RECORD_TYPE

String

Mandatory. Must be set to 560.

RECORD_NUMBER

Integer

Mandatory. Auto-generated.

FRAUD_MONITOR_INDICATOR

String

FraudMonitorIndicator item.

Optional.

RAP_FILE_SEQ_NO

String

RapFileSequenceNumber item.

Optional.

REC_ENTITY_CODE

Integer

RecEntityCode item.

Mandatory.

CALL_REFERENCE

String

CallReference item.

Optional.

GMLC_ADDRESS

String

N/A

TRACKING_CUSTOMER_INFORMATION

Block

TrackingCustomerInformation block.

Optional.

ID_LIST

N.A.

TrackingCustomerId list.

Mandatory.

HOME_ID_LIST

 N.A.

TrackingCustomerHomeId list.

Mandatory.

LOCATION_LIST

N.A.

TrackingCustomerLocation list.

Mandatory.

EQUIPMENT

 N.A.

TrackingCustomerEquipment block.

Optional.

LCS_SP_INFORMATION

LCSSP_INFO

Block

LCSSPInformation block.

Optional.

ID_LIST

 N.A.

LCSSPId list.

Mandatory.

ISP_LIST

 N.A.

InternetServiceProviderId list.

Optional.

NETWORK_LIST

 N.A.

Network list.

Optional.

TRACKED_CUSTOMER_INFORMATION

Block

TrackedCustomerInformation block.

Optional.

ID_LIST

 N.A.

TrackedCustomerId list.

Mandatory.

HOME_ID_LIST

 N.A.

TrackedCustomerHomeId list.

Mandatory.

LOCATION_LIST

 N.A.

TrackedCustomerLocation list

Mandatory.

EQUIPMENT

 N.A.

TrackedCustomerEquipment block.

Optional.

LOCATION_SERVICE_USAGE

Block

LocationServiceUsage block.

Mandatory.

LCSQosRequested

Block

Mandatory.

LCS_REQUEST_TIMESTAMP

Date

Mandatory.

LCS_REQ_UTC_OFFSET

String

LCSRequestTimestamp item.

Mandatory.

H_ACCURACY_REQUESTED

Integer

HorizontalAccuracyRequested item.

Optional.

V_ACCURACY_REQUESTED

Integer

VerticalAccuracyRequested item.

Optional.

RESPONSE_TIME_CATEGORY

Integer

ResponseTimeCategory item.

Optional.

TRACKING_PERIOD

Integer

TrackingPeriod item.

Optional.

REQ_TRACKING_FREQUENCY

Integer

TrackingFrequency (requested) item.

Optional.

LCSQosDelivered

Block

Optional.

LCS_TRANS_STATUS

Integer

LCSTransactionStatus item.

Optional.

H_ACCURACY_DELIVERED

Integer

HorizontalAccuracyDelivered item.

Optional.

V_ACCURACY_DELIVERED

Integer

VerticalAccuracyDelivered item.

Optional.

RESPONSE_TIME

Integer

ResponseTime item.

Optional.

POSITIONING_METHOD

Integer

PositioningMethod item.

Optional.

DEL_TRACKING_PERIOD

Integer

TrackingPeriod item.

Optional.

DEL_TRACKING_FREQUENCY

Integer

TrackingFrequency (delivered) item.

Optional.

AGE_OF_LOCATION

Integer

AgeOfLocation item.

Optional.

CHARGING_TIMESTAMP

Date

ChargingTimeStamp item.

Optional.

CHARGING_UTC_OFFSET

String

ChargeInformationList data is stored in DETAIL.ASSOCIATED_CHARGE_BREAKDOWN.CHARGE_PACKET.

Mandatory if LCSRequestTimestamp is given.

Associated Value Added Service (VAS) Extension Record (RECType 710)

A Value Added Service (VAS) item represents usage of value added services outside of a standard call; i.e., unrelated to either a Mobile Originated Call or a Mobile Terminated Call. VAS consists of Chargeable Subscriber and Value Added Service Used, which are mandatory; conditionally, Network Type and RAP File Sequence Number; optionally, Operator Specific Information.

Table 77-21 describes the fields in the Associated Value Added Service Extension Record.

Table 77-21 Associated Value Added Service (VAS) Extension Record Fields

Name Format Description

RECORD_TYPE

String

Mandatory.

Default = 710.

RECORD_NUMBER

Integer

Mandatory. Auto-generated.

VAS_CODE

Integer

Mandatory.

VAS_SHORT_DESC

String

Optional.

VAS_DESC

String

Optional.

CHARGING_START_TIMESTAMP

Date

Optional.

CHARGING_END_TIMESTAMP

Date

Optional.

UTC_TIME_OFFSET

String

Optional.

Associated BRM Balance Record (RECType 900)

Stores data to be loaded into the BRM database.

Associated BRM Billing Records might occur more than once for each Basic Detail Record. This is the case if more than one balance is affected by one event.

Table 77-22 describes the fields in the Associated BRM Balance Record.

Table 77-22 Associated BRM Balance Record Fields

Name Format Description

RECORD_TYPE

String

Extended to be 3 bytes long.

Values:

900: Associated BRM Balance Record

Usage:

Determination of the different record types.

Derivation:

Mandatory. Set by the first processor and left unchanged.

RECORD_NUMBER

9(9)

Sequence number of record in file.

Can be used to ensure a linear sequence order for all records; for example, as a sorting criteria.

Derivation:

Mandatory. Set by the first processor.

Important: Following modules might change this record number; for example, if new record types are inserted.

ACCOUNT_POID

X(255)

POID of the account.

Example:

1 /account 123456789 0

Derivation:

Mandatory.

SERVICE_POID

X(255)

POID for the service.

Example:

1 /service/ip/gprs 123456789 0

Derivation:

Mandatory.

ITEM_POID

X(255)

POID of the item object affected due to this event. Applies only to the balance array element that impacts currency balance elements. This might be different from the PIN_FLD_ITEM_OBJ field in the base /event class.

Example:

1 /item/misc 123456789 0

Derivation:

Mandatory.

ORIGINAL_EVENT_POID

X(255)

POID of the original recorded event.

Set only if the event has been extracted for pipeline rerating.

Example:

"1 /event/delayed 123456 0"

Derivation:

Optional.

PIN_TAX_LOCALES

X(255)

Used for tax calculation.

Values:

"order_origin|order_accept|ship_from|ship_to"

(Note that these fields are separated by pipes (|).)

Each of these values (order_origin, order_accept, ship_from, ship_to) is an address in the following format:

city;zipcode;state;country;[geocode,location_mode,international_indicator]

Note: Be aware of the semicolon separators and enclosing brackets. For example, "cupertino;95014;CA;US;[5723121,2,0]"Derivation:

Optional.

order_origin, order_accept, and ship_from addresses are all the same and are derived from account profile object tax supplier information.

ship_to is the address in the first element of the account's NAMEINFO array.

geocode is either a geocode or NPA-NXX (the first 6 digits of the phone number).

location_mode is 1 if it is a geocode and 2 if its NPA-NXX.

international_indicator is 0 (US) or 1 (International).

Important: This field might not be implemented in this release.

PIN_TAX_SUPPLIER_ID

X(255)

POID of the /profile/tax_supplier object used to tax this event. NULL if there is no tax supplier specified.

Derivation:

Optional.

Important: This field might not be implemented in this release.

PIN_PROVIDER_ID

X(255)

POID of the remittance service provider account.

Example:

1 /account 123456789 0

Derivation:

Optional.

Important: This field might not be implemented in this release.

PIN_INVOICE_DATA

X(255)

Stores the data in the event that is include in the invoice. T

The data is mapped to BRM fields and is stored as a string in the format:

"@INTEGRATE#PIN_FLD_CALLING_NUMBER#PIN_FLD_CALLED_NUMBER#PIN_FLD_SVC_TYPE# PIN_FLD_SVC_CODE#PIN_FLD_NUMBER_OF_UNITS#PIN_FLD_USAGE_CLASS#PIN_FLD_DNIS#PIN_FLD_BAL_IMPACTS"

Arrays follow this format:

PIN_FLD_BAL_IMPACTS = ID,PIN_FLD_RATE_TAG,PIN_FLD_QUANTITY>

For example:

@INTEGRATE#004917165210#0049171235292#T1#11#0#USAGE#GSMThing#<1 /item 3456 1#1234,10.0#rateTag#1.000000#|1 /item 5678 1#6789#20.0#rateTag#1.000000>

NUMBER_OF_BALANCE_IMPACT_PACKETS

9(2)

Specifies the number of packets following these base fields (dynamic structure); for example, 03 means that 3 packets are following.

Must be used to evaluate how the record structure continues.

Values:

00 - 99: optionally, 0..n packets might follow

Derivation:

Mandatory.

Supplementary Balance Impact Packet Record (RECType 600)

The packets can optionally be used to store an event-related balance impact array. Within this structure, N-times PIN_BALANCE_IMPACTs are created, each containing one balance impact per RESOURCE_ID and optionally per GL_ID.

This record is used for evaluation event-related balance impacts together with the REL to map rating-internal Charge-Packets to BRM related balance impacts.

  • Condition: Only relevant if present. If present, a mapping to all PIN-related values has to take place.

  • Derivation: Optional. From the BRM object /event/PIN_FLD_BAL_IMPACTS. Will be optionally generated by a post-processor. If not present, the mapping will take place within the Rated Event (RE) Loader.

    Table 77-23 describes the Supplementary Balance Impact Packet Record fields.

    Table 77-23 Supplementary Balance Impact Packet Record Fields

    Name Format Description

    RECORD_TYPE

    String

    Extended to be 3 bytes long.

    Value:

    600

    RECORD_NUMBER

    9(9)

    Sequence number of record in file.

    Can be used to ensure a linear sequence order for all records; for example, as a sorting criteria.

    Derivation:

    Mandatory. Set by the first processor.

    Important: Following modules might change this record number; for example, if new record types are inserted.

    ACCOUNT_POID

    String

    POID of the account that the balance impact applies to.

    Derivation:

    Mandatory. Calculated.

    BAL_GRP_POID

    String

    Balance group that the balance impact applies to.

    Derivation:

    Mandatory. Calculated.

    OBJECT_CACHE_TYPE

    Integer

    Mandatory. Calculated.

    ITEM_POID

    String

    POID of the item that the balance impact applies to.

    Derivation:

    Mandatory. Calculated.

    PIN_RESOURCE_ID

    9(9)

    Numeric value of the balance element that is impacted; for example, 840 for US dollars.

    Values:

    Any configured BRM balance element ID.

    Derivation:

    Mandatory.

    PIN_RESOURCE_ID_ORIG

    Integer

    Optional.

    PIN_IMPACT_CATEGORY

    X(255)

    Name of the BRM impact category that was used to generate this balance impact for the rated event.

    Values:

    Any configured BRM impact category.

    Derivation:

    Mandatory.

    PIN_IMPACT_TYPE

    Integer

    Mandatory.

    Calculated.

    PIN_GL_ID

    9(9)

    GLID associated with this balance impact.

    Values:

    Any configured BRM general ledger ID.

    Derivation:

    Optional, default 0. Derived from IFW_RATEPLAN_CNF.GLACCOUNT. Might be mapped from the BRM object /event/PIN_FLD_BAL_IMPACTS.PIN_FLD_GL_ID.

    RUM_ID

    Integer

    Mandatory. Calculated.

    Default = 0.

    PIN_OFFERING_POID

    String

    Optional. Calculated.

    PIN_TAX_CODE

    X(255)

    Tax code for the rate that was used. When taxes do not apply, this field is set to 0.

    Derivation:

    Optional. From IFW_RATEPLAN_CNF.GLACCOUNT->TAXCODE. Might be mapped from the BRM object /event/PIN_FLD_BAL_IMPACTS.PIN_FLD_GL_ID.

    PIN_RATE_TAG

    X(255)

    Description of the rate used. Same as the PIN_FLD_DESCR in /rate.

    Can be used to more precisely describe the balance impact detail; for example, the following concatenated, comma-separated rating-related Charge-Packet values used: TIMEZONE, DAY_CODE, TIME_INTERVAL.

    Values:

    Free defined text value.

    Derivation:

    Optional, default empty. From the BRM object /event/PIN_FLD_BAL_IMPACTS.PIN_FLD_RATE_TAG. The post-mapping processor might decide what mapping-rule applies to this attribute.

    PIN_LINEAGE

    X(255)

    Lineages of event fields if zone map is used in charge selection.

    Can be used to more precisely describe the balance impact detail; for example, the following concatenated, comma-separated rating-related Charge-Packet values used: ZONEMODEL, SERVICE_CODE, SERVICE_CLASS, IMPACT_CATEGORY,.RESOURCE, RUMGROUP, PRICEMODEL.

    Values:

    Free defined text value.

    Derivation:

    Optional, default empty. From the BRM object /event/PIN_FLD_BAL_IMPACTS.PIN_FLD_LINEAGE. The post-mapping processor might decide what mapping-rule applies to this attribute.

    PIN_NODE_LOCATION

    X(255)

    Lineage information for the charge offer. See description in charge offers array of /account.

    Can be used to more precisely describe the balance impact detail; for example, the following concatenated, comma-separated rating-related Charge-Packet values used: REVENUEGROUP, DISCOUNTMODEL.

    Values:

    Free defined text value.

    Derivation:

    Optional, default empty. From the BRM object /event/PIN_FLD_BAL_IMPACTS.PIN_FLD_NODE_LOCATION. The post-mapping processor might decide what mapping-rule applies to this attribute.

    PIN_QUANTITY

    9(15)

    Charged quantity value (beats, duration, volume), as calculated via the related RATEPLAN. Contains the rounded quantity value as it has been calculated during rating.

    Values:

    Maximum: 999999999999999

    Note: In case of Multiple-RUM rating, this value might not be totalizable because different UoMs can logically not be aggregated. In this case, the value is set to 0.Derivation:

    Optional, default 0. From the BRM object /event/PIN_FLD_BAL_IMPACTS.PIN_FLD_QUANTITY. The post-mapping processor might decide what mapping-rule applies to this attribute; for example, multiple charge packet values might be totalized.

    PIN_AMOUNT

    9(11)

    Amount of impact for one balance element to the account balance. The value might be either positive or negative. The value is added to the PIN_FLD_CURRENT_BAL field of the PIN_FLD_BALANCES array in the account object specified by PIN_FLD_ACCOUNT_OBJ.

    Note: In case of Multiple-RUM rating, this value might be a totalized value.

    Values:

    Space: No price given, like NULL in a database

    Variable floating point format: Given value, might be 0.000. The floating decimal point must be set.

    Minimum: -9999999999

    Maximum: 99999999999

    Examples:

    '00000000125' for 125,00

    '00000012.50' for 12,50

    '-0012.56780' for -12,5678

    Derivation:

    Mandatory. From the BRM object /event/PIN_FLD_BAL_IMPACTS.PIN_FLD_AMOUNT. The post-mapping processor might decide what mapping-rule applies to this attribute; for example, multiple charge packet values might be totalized.

    Note: This value does not include any granted discounts.

    PIN_AMOUNT_ORIG

    Decimal

    Optional.

    PIN_PERCENT

    Decimal

    Optional

    PIN_AMOUNT_DEFERRED

    Decimal

    Optional. Calculated.

    PIN_DISCOUNT

    9(11)

    The discount applied to this balance impact.

    Can be used to determine the total charge amount value.

    Note: The AMOUNT value never contains this DISCOUNT value.

    Values:

    Space: No price given, like NULL in a database

    Variable floating point format: Given value, might be 0.000. The floating decimal point must be set.

    Minimum: -9999999999

    Maximum: 99999999999

    Examples:

    '00000000125' for 125,00

    '00000012.50' for 12,50

    '-0012.56780' for -12,5678

    Derivation:

    Mandatory, default 0.

    PIN_INFO_STRING

    X(2000)

    Stores the pricing type.

Supplementary Sub-Balance Impact Packet Record (RECType 605)

Stores balance impacts for sub-balances.

Table 77-24 describes the fields in the Supplementary Sub-Balance Impact Packet Record.

Table 77-24 Supplementary Sub-Balance Impact Packet Record Fields

Name Format Description

RECORD_TYPE

String

Extended to be 3 bytes long.

Value:

605

Mandatory.

RECORD_NUMBER

9(9)

Sequence number of record in file.

Can be used to ensure a linear sequence order for all records; for example, as a sorting criteria.

Derivation:

Mandatory. Set by the first processor.

Important: Following modules might change this record number; for example, if new record types are inserted.

BAL_GRP_POID

String

Balance group that the balance impact applies to.

Derivation:

Mandatory. Calculated.

PIN_RESOURCE_ID

9(9)

Numeric value of the balance element that is impacted; for example, 840 for US dollars.

Values:

Any configured BRM balance element ID.

Derivation:

Mandatory.

NEXT_BAL

Decimal

None.

DELAYED_BAL

Decimal

None.

GRANTOR

String

The charge offer or discount offer that granted this balance element.

VALID_FROM_DETAILS

Integer

Sub-balance start time mode (such as first-usage or relative) and relative offset and unit.

VALID_TO_DETAILS

Integer

Sub-balance end time mode (such as relative) and relative offset and unit.

Supplementary Sub-Balance Info Packet Record (RECType 607)

Stores validity dates for sub-balances.

Table 77-25 lists the fields in the Supplementary Sub-Balance Info Packet Record.

Table 77-25 Supplementary Sub-Balance Info Packet Record Fields

Name Format Description

RECORD_TYPE

String

Extended to be 3 bytes long.

Value:

607

Mandatory.

RECORD_NUMBER

9(9)

Sequence number of record in file.

Can be used to ensure a linear sequence order for all records; for example, as a sorting criteria.

Derivation:

Mandatory. Set by the first processor.

Important: Following modules might change this record number; for example, if new record types are inserted.

PIN_AMOUNT

Decimal

Sub-balance amount.

VALID_FROM

Date

Valid from date for this sub-balance.

VALID_TO

Date

Valid to date for this sub-balance.

Tax Jurisdiction Packet

Table 77-26 lists the fields in the Tax Jurisdiction Packet.

Table 77-26 Tax Jurisdiction Packet Fields

Name Format

RECORD_TYPE

String

RECORD_NUMBER

Integer

PIN_TAX_TYPE

String

PIN_TAX_VALUE

Decimal

PIN_AMOUNT

Decimal

PIN_TAX_RATE

String

PIN_AMOUNT_GROSS

Decimal

EDR Container Fields for Balance Monitoring

The following fields are used for handling balance monitor information.

MONITOR_LIST (DETAIL.CUST_A.ML)

The MONITOR_LIST packet contains information about the balance monitor.

Table 77-27 lists the fields in the MONITOR_LIST packet.

Table 77-27 MONITOR_LIST Packet Fields

Name Format Description

BALANCE_GROUP_ID

String

Balance monitor group ID.

Mandatory.

MONITOR_OWNER_ACCT_ID

String

Monitor owner's account ID.

Mandatory.

MONITOR_OWNER_ID

String

Monitor owner ID.

Mandatory.

MONITOR_OWNER_TYPE

String

Monitor owner type.

Mandatory.

MONITOR_PACKET (DETAIL.ASS_PIN.MP)

The MONITOR_PACKET packet stores information about the balance monitor impacts. This information is added to the Associated Billing Record to be loaded into the database.

Table 77-28 lists the fields in the MONITOR_PACKET packet.

Table 77-28 MONITOR_PACKET (DETAIL.ASS_PIN.MP) Fields

Name Format Description

RECORD_TYPE

String

Type of record. Extended to be 3 bytes long.

Possible value: 800

RECORD_NUMBER

9(9)

Sequence number of record in file.

Can be used to ensure a linear sequence order for all records; for example, as a sorting criteria.

Derivation:

Mandatory. Set by the first processor.

Important: This record number can change if the sequence of records changes; for example, if new record types are inserted.

ACCOUNT_POID

String

POID of the account that the monitor balance impact applies to.

Derivation:

Mandatory. Calculated.

BAL_GRP_POID

String

Balance monitor group that the monitor balance impact applies to.

Derivation:

Mandatory. Calculated.

PIN_RESOURCE_ID

9(9)

Numeric value of the balance element that is impacted; for example, 840 for US dollars.

Possible value:

Any configured balance element ID.

Derivation:

Mandatory.

PIN_AMOUNT

9(11)

Amount of impact for one balance element to the monitor balance. The value might be either positive or negative. The value is added to the PIN_FLD_CURRENT_BAL field of the PIN_FLD_BALANCES array in the account's monitor object specified by PIN_FLD_ACCOUNT_OBJ field.

Note: In case of Multiple-RUM rating, this value might be a total value.

Possible values:

Price (see below for maximum and minimum). If no price given, space; for example, NULL in a database.

The format is variable floating point. The floating decimal point must be set if the given value is not in the required format.

Example:

'00000000125' for 125,00

'00000012.50' for 12,50

'-0012.56780' for -12,5678

Derivation:

Mandatory. Derived from the object /event/PIN_FLD_BAL_IMPACTS.PIN_FLD_AMOUNT. The post-mapping processor decides what mapping rule applies to this attribute; for example, add multiple charge packet values.

Note: This value does not include any granted discounts.

MONITOR_SUB_BAL_IMPACT (DETAIL.ASS_PIN.MSBI)

Table 77-29 lists the fields in the MONITOR_SUB_BAL_IMPACT packet.

Table 77-29 MONITOR_SUB_BAL_IMPACT Fields

Name Format Description

RECORD_TYPE

String

Type of record. Extended to be 3 bytes long.

Possible value:

805

RECORD_NUMBER

9(9)

Sequence number of the record in file.

Can be used to ensure a linear sequence order for all records; for example, as a sorting criteria.

Derivation:

Mandatory. Set by the first processor.

Important: This record number can change if the sequence of records changes; for example, if new record types are inserted.

BAL_GRP_POID

String

Balance monitor group that the monitor balance impact applies to.

Derivation:

Mandatory. Calculated.

PIN_RESOURCE_ID

9(9)

Numeric value of the balance element that is impacted; for example, 840 for US dollars.

Possible values:

Any configured balance element ID.

Derivation:

Mandatory.

MONITOR_SUB_BAL

SB

Sub-balance monitor.

MONITOR_SUB_BAL (DETAIL.ASS_PIN.MSB)

Table 77-30 lists the MONITOR_SUB_BAL Packet fields.

Table 77-30 MONITOR_SUB_BAL Fields

Name Format Description

RECORD_TYPE

String

Type of record. Extended to be 3 bytes long.

Possible value:

807

Derivation:

Mandatory.

RECORD_NUMBER

Integer

Contains the UTC time offset that normalizes the VALID_FROM timestamp to the UTC time zone.

PIN_AMOUNT

Decimal

Sub-balance amount.

VALID_FROM

Date

Contains a timestamp of the event end time, rounded to midnight.

VALID_TO

Date

Contains a timestamp of the VALID_FROM time plus 1 day.

CONTRIBUTOR

String

None

NEXT_BAL

Decimal

None

DELAYED_BAL

Decimal

None

ACCOUNT_POID_STR

String

None

SERVICE_POID_STR

String

None

OFFERING_POID_STR

String

None

START_T

Date

None

UTC_TIME_OFFSET

String

None

DESCRIPTION

String

Optional.

FLAGS

Integer

Optional.

Associated Invoice Data Record (RECType @INTEGRATE)

The Associated Invoice Data Record stores data for displaying on invoices.

Table 77-31 lists the fields in the Associated Invoice Data Record.

Table 77-31 Associated Invoice Data Record Fields

Name Format Description

RECORD_TYPE

String

The name of the invoice data template, preceded by the @ symbol.

Values:

@INTEGRATE

A_NUMBER

String

See A_NUMBER.

B_NUMBER

String

See B_NUMBER.

BASIC_SERVICE

String

See BASIC_SERVICE.

NUMBER_OF_UNITS

Decimal

See NUMBER_OF_UNITS.

USAGE_CLASS

String

See USAGE_CLASS.

TERMINATING_SWITCH_IDENTIFICATION

String

See TERMINATING_SWITCH_IDENTIFICATION.

BALANCE_IMPACT

 N/A

Balance impact data.

INVOICE_DATA_TERMINATOR

String

N/A

Associated Zone Breakdown Record (RECType 960-969)

Stores zoning information. For each evaluated zone type, a single Zone Breakdown Record is generated, following the Basic Detail Record (020, 021, 030, 031, etc.). A new Basic Record or the Trailer Record end the sequence of Zone Breakdown Records. Also for zone values already contained within the Basic Detail Record, these sub-details could be generated.

Table 77-32 lists the fields in the Associated Zone Breakdown Record.

Table 77-32 Associated Zone Breakdown Record Fields

Name Format Description

RECORD_LENGTH

Integer

Optional for backward compatibility.

RECORD_TYPE

String

Extended to be 3 bytes long.

Values:

960: Standard Zoning (multiple global Zoning per logical EDR Format)

961: Segmentation Zoning (multiple Zoning per customer segment)

RECORD_NUMBER

9(9)

Sequence number of record in file.

Can be used to ensure a linear sequence order for all records; for example, as a sorting criteria.

Derivation:

Mandatory. Set by the first processor.

Important: Following modules might change this record number; for example, if new record types are inserted.

CONTRACT_CODE

X(20)

External unique contract code as defined within the associated billing system. Uniquely identifies a charge offer-related contract.

Could by used by any post-processors to look up and reference contract, subscriber, and customer data (if needed later on within this post processor).

Derivation:

Optional. As assigned to an ACCOUNT Object and referenced by a primary CLI. Alternatively the A Number could be used as reference.

SEGMENT_CODE

X(5)

External Segmentation ID as defined within the associated billing system or as defined within the rating process. Segments could vertically group multiple subscriber (for example, for quality reasons) or network operator.

Could be used by any post-processor to identify the related customer/network segment that was used during the rating processor for this A Number.

Derivation:

Only mandatory for RECORD_TYPE 981, 984.

As assigned to a SUBSCRIBER Object related to the A Number or as assigned to a network operator related to the file stream.

CUSTOMER_CODE

X(20)

External Customer Code as defined within the associated billing system. Could group multiple subscribers.

Could be used by any post-processors as an alternative identifier to look up and reference subscriber or customer data (if needed later on within this post-processor).

Derivation:

Optional. As assigned to a CUSTOMER Object and referenced by a primary CLI.

ACCOUNT_CODE

X(20)

External Customer-Account Code as defined within the associated billing system. Could group multiple charge offers assigned to a customer. A customer might have multiple accounts.

Could be used by any post-processors as an alternative identifier to look up and reference subscriber or customer data (if needed later on within this post-processor).

Derivation:

Mandatory. As assigned to a CUSTOMER Object and referenced by a primary CLI.

SYSTEM_BRAND_CODE

X(5)

External system or brand, specialist system Code as defined within the associated rating or billing. Could be used for vendor-specific reasons (for example, reseller code or target system identification for post processing, NOSP identification, etc.).

Derivation:

Mandatory, default 0. As defined within the SYSTEM_BRAND Object and assigned to a PRODUCT Object referenced by a primary CLI.

SERVICE_CODE

X(5)

Internal (mapped, normalized) Service Code used for the zone determination within the associated rating or billing processor, out of the object IFW_SERVICE (.CODE).

Could be used by any post-processor to evaluate the service that was really used during the related rating process.

Derivation:

Mandatory. The external service code is mapped to a unique representation, either:

  • Out of the service code included in the origin record (might be mapped).

  • Out of the service code associated to the SUBSCRIBER's A Number.

CUSTOMER_RATEPLAN_CODE

X(10)

The Original charge offer related and Customer/Subscriber specific charge as defined within the associated billing system. If no customer data is present, the actual, internally used charge could be used instead.

Could be used by any post-processor to evaluate the charge that was really used during the related rating process.

Derivation:

Only mandatory for RECORD_TYPE 981, 984.

As assigned to an ACCOUNT Object and referenced by a primary CLI or as assigned to the associated charge.

SLA_CODE

X(5)

The Original charge offer-related and customer-specific Service Level Agreement as defined within the associated billing system. If no customer data is present, the actual, internally default value could be used instead.

Could be used by any post-processor to evaluate the charge that was really used during the related rating process.

Derivation:

Only mandatory for RECORD_TYPE 981, 984.

As assigned to an ACCOUNT Object and referenced by a primary CLI or as assigned to the associated charge.

CUSTOMER_BILLCYCLE

X(2)

The Customers associated Billcycle Code as defined within the associated billing system.

Could be used by any post-processor to evaluate the billcycle period that applies to this call.

Derivation:

Only mandatory for RECORD_TYPE 981, 984.

As assigned to a CUSTOMER Object and referenced by a primary CLI.

CUSTOMER_CURRENCY

X(3)

The Customers associated Currency as defined within the associated billing system.

Could be used by any post-processor to evaluate the currency and to apply exchange rates that apply to this call.

Derivation:

Only mandatory for RECORD_TYPE 981, 984.

As assigned to a CUSTOMER Object and referenced by a primary CLI.

CUSTOMER_TAX_GROUP

X(5)

The Customers associated Tax Group Code as defined within the associated billing system.

Could be used by any post-processor to evaluate the tax rate (together with the charge configuration related G/L account's tax code) that applies to this call.

Derivation:

Only mandatory for RECORD_TYPE 981, 984.

As assigned to a CUSTOMER Object and referenced by a primary CLI.

NUMBER_OF_ZONE_PACKET

9(2)

Defines the number of supplementary zone records following these base fields (dynamic structure); for example, a number of '05' means that 5 records are following.

Must be used to evaluate how the record structure continues.

Values:

01 - 99: A minimum of at least 1 record is required

Derivation:

Mandatory.

Supplementary Zone Packet Record (RECType 660)

For each zone model (evaluated by any rating processor), one packet is added to this structure.

This applies only to standard and segmentation zoning (where multiple zoning is possible). All other zone values are listed in the charge breakdown records.

Table 77-33 lists the fields in the Supplementary Zone Packet Record.

Table 77-33 Supplementary Zone Packet Record Fields

Name Format Description

RECORD_TYPE

String

Extended to be 3 bytes long.

Value:

660: Zone Packet

Derivation:

Mandatory. Set by the first processor and left unchanged.

RECORD_NUMBER

9(9)

Sequence number of record in file.

Can be used to ensure a linear sequence order for all records; for example, as a sorting criteria.

Derivation:

Mandatory. Set by the first processor.

Important: Following modules might change this record number; for example, if new record types are inserted.

ZONEMODEL_CODE

X(10)

External Zone Model Code as defined in the related ZONEMODEL Object (.CODE) of the rating processor.

Could be used by any post-processor to evaluate the zone model that was used during the related rating process.

Derivation:

Mandatory.

ZONE_RESULT_VALUE_WS

X(5)

Wholesale zone result value as defined for the zone model references by the field ZONEMODEL_CODE.

Could be used by any post-processor to evaluate the wholesale zone value that was estimated during the related rating process.

Derivation:

Optional.

ZONE_RESULT_VALUE_RT

X(5)

Retail zone result value as defined for the zone model references by the field ZONEMODEL_CODE.

Could be used by any post-processor to evaluate the retail zone value that was estimated during the related rating process.

Derivation:

Mandatory.

ZONE_ENTRY_NAME

String

Calculated, will be used by zoning and rating modules.

ZONE_DESCRIPTION

String

Calculated, will be used by zoning and rating modules.

DISTANCE

9(5)

Distance value as calculated by any geographical zone model.

Could be used by any post-processor to evaluate the distance value that was estimated during the related rating process.

Condition:

This applies only if the associated zone model references to a geographical one.

Values:

The value is given in full and rounded kilometers; for example, 00150 for 150 km.

Derivation:

Optional. Dependent on the setup of the zone models within the related rating processor. This value represents the internal calculated distance.

Associated Charge Breakdown Record (RECType 970-998)

Stores charge data. For each evaluated charge or partial charge, a single Charge Breakdown Record might be generated, following the Basic Detail Record. A new Detail Record or the Trailer Record end the sequence of Charge Breakdown Records. For charge values already contained within the Basic Detail Record, these sub-details could be generated.

Table 77-34 lists the fields in the Associated Charge Breakdown Record.

Table 77-34 Associated Charge Breakdown Record Fields

Name Format Description

RECORD_LENGTH

Integer

Optional for backward compatibility.

RECORD_TYPE

String

Extended to be 3 bytes long.

Values:

980: Global Charge (multiple EDR-format-related charge)

981: Customer Charge (subscriber-related charge)

982: Reseller/SP Charge (specialist-system-related charge)

983: Content Provider Charge (content-related charge)

990: Carrier Interconnection Charge (trunk-related charge)

991: Reseller Interconnection Charge (EDR-format-related charge)

Derivation:

Mandatory. Set by the first processor and left unchanged.

RECORD_NUMBER

9(9)

Sequence number of record in file.

Can be used to ensure a linear sequence order for all records; for example, as a sorting criteria.

Derivation:

Mandatory. Set by the first processor.

Important: Following modules might change this record number; for example, if new record types are inserted.

CONTRACT_CODE

X(20)

External unique contract code as defined within the associated billing system. Uniquely identifies a charge offer-related contract.

Could by used by any post-processors to look up and reference contract, subscriber, and customer data (if needed later on within this post-processor).

Derivation:

Optional. As assigned to an ACCOUNT Object and referenced by a primary CLI. Alternatively the A Number could be used as reference.

SEGMENT_CODE

X(5)

External Segmentation ID as defined within the associated billing system or as defined within the rating process. Segments could vertically group multiple subscriber (for example, for quality reasons) or network operator.

Could be used by any post-processor to identify the related customer/network segment that was used during the rating processor for this A Number.

Derivation:

Only mandatory for RECORD_TYPE 981, 984.

As assigned to a SUBSCRIBER Object related to the A Number or as assigned to a network operator related to the file stream.

CUSTOMER_CODE

X(20)

External Customer Code as defined within the associated billing system. Could group multiple subscribers.

Could be used by any post-processors as an alternative identifier to look up and reference subscriber or customer data (if needed later on within this post-processor).

Derivation:

Optional. As assigned to a CUSTOMER Object and referenced by a primary CLI.

ACCOUNT_CODE

X(20)

External Customer-Account Code as defined within the associated billing system. Could group multiple charge offers assigned to a customer. A customer might have multiple accounts.

Could be used by any post-processors as an alternative identifier to look up and reference subscriber or customer data (if needed later on within this post-processor).

Derivation:

Mandatory. As assigned to a CUSTOMER Object and referenced by a primary CLI.

SYSTEM_BRAND_CODE

X(5)

External system or brand, specialist system Code as defined within the associated rating or billing. Could be used for vendor-specific reasons (for example, reseller code or target system identification for post-processing, NOSP identification, etc.)

Derivation:

Mandatory, default 0. As defined within the SYSTEM_BRAND Object and assigned to a PRODUCT Object referenced by a primary CLI.

SERVICE_CODE

X(5)

Internal (mapped, normalized) Service Code used for the zone determination within the associated rating or billing processor, out of the object IFW_SERVICE (.CODE).

Could be used by any post-processor to evaluate the service that was really used during the related rating process.

Derivation:

Mandatory. The external service code is mapped to a unique representation, either:

  • Out of the service code included in the origin record (might be mapped).

  • Out of the service code associated to the SUBSCRIBERs A Number.

CUSTOMER_RATEPLAN_CODE

X(10)

The Original charge offer related and Customer/Subscriber specific charge as defined within the associated billing system. If no customer data is present, the actual, internally used charge could be used instead.

Could be used by any post-processor to evaluate the charge that was really used during the related rating process.

Derivation:

Only mandatory for RECORD_TYPE 981, 984.

As assigned to an ACCOUNT Object and referenced by a primary CLI or as assigned to the associated charge.

SLA_CODE

X(5)

The Original charge offer-related and customer-specific Service Level Agreement as defined within the associated billing system. If no customer data is present, the actual, internally default value could be used instead.

Could be used by any post-processor to evaluate the charge that was really used during the related rating process.

Derivation:

Only mandatory for RECORD_TYPE 981, 984.

As assigned to an ACCOUNT Object and referenced by a primary CLI or as assigned to the associated charge

CUSTOMER_BILLCYCLE

X(2)

The Customer's associated Billcycle Code as defined within the associated billing system.

Could be used by any post-processor to evaluate the billcycle period that applies to this call.

Derivation:

Only mandatory for RECORD_TYPE 981, 984.

As assigned to a CUSTOMER Object and referenced by a primary CLI

CUSTOMER_CURRENCY

X(3)

The Customer's associated Currency as defined within the associated billing system.

Could be used by any post-processor to evaluate the currency and to apply exchange rates that apply to this call.

Derivation:

Only mandatory for RECORD_TYPE 981, 984.

As assigned to a CUSTOMER Object and referenced by a primary CLI.

CUSTOMER_TAXGROUP

X(5)

The Customers associated Tax Group Code as defined within the associated billing system.

Could be used by any post-processor to evaluate the tax rate (together with the charge configuration-related G/L account's tax code) that applies to this call.

Derivation:

Only mandatory for RECORD_TYPE 981, 984.

As assigned to a CUSTOMER Object and referenced by a primary CLI.

NUMBER_OF_CHARGE_PACKETS

9(2)

Defines the number of CBRs (charge breakdown records); does not reflect the actual number of charge packets per CBR.

NUMBER_OF_TAX_PACKETS

Integer

Mandatory. Calculated.

Default = 1.

CUSTOMER_OPENING_BALANCE

Decimal

If prepaid rated call, the opening balance for the subscriber.

Optional.

CUSTOMER_CLOSING_BALANCE

Decimal

If prepaid rated call, the closing balance for the subscriber.

Optional.

RUM_NAME

String

Optional.

Calculated.

FU_DISCOUNT_OBJECTS

String

The account's discounts that have first-usage start times which were used to discount the event.

Mandatory.

Calculated.

Update Balance Packet

This block contains initialized sub-balances of related balance elements based on a bundle.

Table 77-35 lists the fields in the Update Balance Packet.

Table 77-35 Update Balance Packet Fields

Name Format Description

RECORD_TYPE

String

The type of call record.

Mandatory.

BALANCE_GROUP_ID

Integer

POID of the account's balance group for which a balance element balance starts on first usage.

Mandatory.

RESOURCE_ID

Integer

ID of the associated balance element.

Mandatory.

RECORD_NUMBER

Integer

Sequence number of the record in the file.

Mandatory.

VALID_FROM

Date

The balance element balance start time.

Mandatory.

VALID_TO

Date

The balance element balance end time.

Mandatory.

VALID_FROM_DETAIL

Integer

The start time mode (such as first-usage or relative), relative offset unit (such as minutes, months, or cycles), and number of offset units.

Mandatory.

VALID_TO_DETAIL

Integer

The end time mode (such as relative), relative offset unit (such as minutes, months, or cycles), and number of offset units.

Mandatory.

CONTRIBUTOR

String

Balance group contributor.

GRANTOR

String

Balance group grantor.

GRANT_VALID_FROM

Date

Grant validity start time.

GRANT_VALID_TO

Date

Grant validity end time.

RUM Map Block

RUM_MAP block contains all the RUMs that are used in the ACB block.

Table 77-36 lists the fields in the RUM Map Block.

Table 77-36 RUM Map Block Fields

Name Format Description

RECORD_TYPE

String

None

RECORD_NUMBER

Integer

None

RUM_NAME

String

None

NET_QUANTITY

Decimal

Contains the summation of BALANCE_PACKET.PIN_QUANTITY for RUM_NAME.

UNRATED_QUANTITY

Decimal

None

Supplementary Minimum Charge Information

Minimum charge information (the MINIMUM_CHARGE block) prevents charging a customer less than the minimum charge for a call. The values are taken from the pricing configuration.

Table 77-37 lists the Supplementary Minimum Charge Information fields.

Table 77-37 Supplementary Minimum Charge Information Fields

Name Format Description

RESOURCE

String

Balance Element used when rating the call.

TOTAL_CHARGE_VALUE

Decimal

Total charge of the call.

MINIMUM_CHARGE_VALUE

Decimal

Minimum charge of the call.

Supplementary Charge Packet Record (RECType 660)

For each charge (evaluated by any rating processor), at least one packet is added to this structure. This applies only to rating models as defined in the record type.

Note:

If a call had to be split over several time zones, there is a separate packet for each part of the call. The charge sum of all parts (where the related charge is equal) represents the total charge of the related basic detail EDR.

Table 77-38 lists the fields in the Supplementary Charge Packet Record.

Table 77-38 Supplementary Charge Packet Record Fields

Name Format Description

RECORD_TYPE

String

Value:

660: Charge Packet Record

Derivation:

Mandatory. Set by the first processor and left unchanged.

RECORD_NUMBER

9(9)

Sequence number of record in file.

Can be used to ensure a linear sequence order for all records; for example, as a sorting criteria.

Derivation:

Mandatory. Set by the first processor.

Important: Following modules might change this record number; for example, if new record types are inserted.

RATEPLAN_CODE

X(10)

External Charge Code as defined in the related RATEPLAN Object (.CODE) used by the rating process.

Could be used by any post-processor to evaluate the RATEPLAN that was used during the related rating process.

Derivation:

Mandatory.

RATEPLAN_TYPE

X(1)

A charge could be either wholesale or retail.

Could be used by any post-processor to determine if the charge calculated throughout the RATEPLAN used is a wholesale or retail one.

Values:

W: Wholesale

R: Retail

Derivation:

Mandatory. Taken from the setup related to the RATEPLAN_CODE Field

RATETAG_CODE

String

Derivation:

Mandatory. Calculated.

ZONEMODEL_CODE

X(10)

External Zone Model Code as defined in the related ZONEMODEL Object (.CODE) defined within the related charge used by the rating process.

Could be used by any post-processor to evaluate the zone model that was really used during the related rating process.

Derivation:

Mandatory.

SERVICE_CODE_USED

X(5)

Internal (RATEPLAN related mapped) Service Code used for the zone determination within the associated rating or billing processor, out of the object IFW_RATESERVICE_MAP (.NEW_SERVICECODE).

Could be used by any post-processor to evaluate the service that was really used during the related rating process.

Derivation:

Mandatory.

SERVICE_CLASS_USED

X(5)

External Service Class Used as defined within the RATEPLAN (for example, for specific QoS) and used by the rating process.

Could be used by any post-processor to evaluate the level of service quality that was really used during the related rating process.

Derivation:

Mandatory. Default = '*'.

IMPACT_CATEGORY

X(10)

Impact Category result value as defined; for example, a zone value references or a usage scenario map result.

Could be used by any post-processor to evaluate the zone value that was estimated during the related rating process.

Derivation:

Mandatory.

ZONE_DESCRIPTION

String

Calculated. Used by zoning and rating modules.

IC_DESCRIPTION

String

Calculated. Used by zoning and rating modules.

ZONE_ENTRY_NAME

String

Calculated. Used by zoning and rating modules.

DISTANCE

9(5)

Distance value as calculated by any geographical zone model.

Could be used by any post-processor to evaluate the distance value that was estimated during the related rating process.

Condition:

This applies only if the associated zone model references to a geographical one.

Values:

The value is given in full and rounded kilometers; for example, 00150 for 150 km.

Derivation:

Optional. Dependent on the setup of the zone models within the related rating processor. This value represents the internal calculated distance.

TIMEMODEL_CODE

X(10)

External Time Model Code as estimated and used by the rating process.

Time model and Time zone define a unique relationship between a day code (special day, weekday, weekend, etc.) and a time interval (time band within a day).

Could be used by any post-processor to evaluate the time model that was really used during the related rating process.

Derivation:

Mandatory. The time model is given by evaluating the RATEPLAN configuration and the starting timestamp of the record.

TIMEZONE_CODE

X(10)

External Time Zone Code as estimated and used by the rating process.

Time model and Time zone define a unique relationship between a day code (special day, weekday, weekend, etc.) and a time interval (time band within a day).

Could be used by any post-processor to evaluate the time zone that was really used during the related rating process.

Derivation:

Mandatory. The time zone is given by evaluating the RATEPLAN configuration and the starting timestamp of the record within the related TIMEMODEL.

DAY_CODE

X(10)

External Day Code as estimated and used by the rating process.

Time model and Time zone define a unique relationship between a day code (special day, weekday, weekend, etc.) and a time interval (time band within a day). This attribute describes the evaluated day code within the above relationship.

Could be used by any post-processor to evaluate the day code that was really used during the related rating process, even if single charge packets are being generated in case of time zone splitting.

Derivation:

Mandatory. DAY_CODE as defined in the related DAYCODE object (.CODE). The day is given by evaluating the RATEPLAN configuration and the starting timestamp of the record within the related TIMEMODEL and TIMEZONE. If Splitting of single charge packets is not performed, the day code of the start of the call is being used.

TIME_INTERVAL_CODE

X(10)

External Time Interval Code as estimated and used by the rating process.

Time model and Time zone define a unique relationship between a day code (special day, weekday, weekend, etc.) and a time interval (time band within a day). This attribute describes the evaluated time interval within the above relationship.

Could be used by any post-processor to evaluate the time interval that was really used during the related rating process, even if single charge packets are being generated in case of time zone splitting.

Derivation:

Mandatory. TIME_INTERVAL Code as defined in the related TIME_INTERVAL object (.CODE). The time zone is given by evaluating the RATEPLAN configuration and the starting timestamp of the record within the related TIMEMODEL and TIMEZONE. If Splitting of single charge packets is not performed, the time interval of the start of the call is being used.

PRICEMODEL_CODE

X(10)

External Pricing Code as defined in the related PRICEMODEL Object (.CODE) used by the rating process.

Could be used by any post-processor to evaluate the pricing that was really used during the related rating process.

Derivation:

Mandatory. Dependent on the setup of the RATEPLAN within the related rating processor. This value represents the external pricing code as it had been set up and used.

PRICEMODEL_TYPE

X(1)

Defines which type of the pricing was used for this charge packet.

Could be used by any post-processor to evaluate which pricing was really used during the related rating process.

Values:

S: Standard pricing was used

A: Alternative pricing was used

Derivation:

Mandatory, default 'S'. Dependent on the setup of the RATEPLAN within the related rating processor. This value represents the external type of pricing as it had been set up and used. A packet with a pricing type 'S' does always exist. If an alternative pricing is configured, a second packet of type 'A' is generated.

RESOURCE

X(10)

Balance Element, which has been used for rating or discounting purposes. A balance element might be a currency or any other type (for example, loyalty points) that should be used to calculate parallel charges.

Could be used by any post-processor to classify the different charge items.

Values:

Any configured values of the IFW_RESOURCE object.

Derivation:

Mandatory, directly taken out of the PRICEMODEL configuration appropriate to the charge packet.

RESOURCE_ID

Integer

Derivation:

Optional. Calculated. If 0, the RESOURCE field is ignored.

RESOURCE_ID_ORIG

Integer

Optional. Used if the exchange rate module is configured.

RUMGROUP

X(10)

Classifies the charging item which was derived from the service. A RUM group defines a list of RUMs that should be used together to define a total charge. For example, 'total' could consist of 'DUR'+'VOL_S'+'VOL_R'.

Could be used by any post-processor to classify the different charge items.

Values:

Any configured values of the IFW_RUMGROUP object.

Derivation:

Mandatory, directly taken out of the Service object's RUM group definition.

RUM

X(10)

Classifies the charging part of a call in a intercarrier relationship, for interconnection or roaming.

Values:

Dependent on the setup of the IFW_RUM object. Filled by default with '*' if multiple RUMs are used within one Charge Packet.

NETWORK_OPERATOR_CODE

X(10)

Network Operator Code (or Reseller / Content Provider Code) as defined in the NO Objects (.CODE) of the related rating process.

Could be used by any post-processor (especially by interconnection billing) to evaluate the network operator to which the calculated charge belongs.

Condition:

Network operators can be assigned as follows:

  • Directly to an EDR-format

  • Via a trunk identification (carrier/reseller interconnection)

  • A content provider code via a special number, b#

Derivation:

Only mandatory for RECORD_TYPE 983, 990, 991.

The network operator is given by evaluating the relationship during the estimation process which RATEPLAN should be used.

NETWORK_OPERATOR_BILLINGTYPE

X(1)

Classifies the Type of the associated network operator involved within this charge.

Could be used by any interconnection processor to distinguish between incoming and outgoing charges.

Condition:

Only applies to interconnection rating.

Values:

O: Outgoing NO, charges have to be paid to the related NO

I: Incoming NO, charges are received by the related NO

Derivation:

Only mandatory for RECORD_TYPE 983, 990, 991; else default I.

The NO billing type is directly related to the network operator setup.

CHARGE_TYPE

X(1)

Classifies the charging part of a call in an intercarrier relationship, for interconnection or roaming.

Could be used by any interconnection processor to classify the different charge types.

Condition:

Only applies to interconnection rating.

Values:

I: Inroute Charge (only applies for carrier interconnection)

O: Outroute Charge (only applies for carrier interconnection)

T: Transit Charge (only applies for carrier interconnection)

N: Normal Charge (applies for all other charges, default)

Derivation:

Only mandatory for RECORD_TYPE 983, 988, 990, 991, 995, 996; else default N.

The switch/trunk is directly related to the type setup.

TRUNK_USED

X(15)

Trunk ID or MSC which was used to calculate the interconnection charges within this packet. This field contains the internal, virtual or mapped trunk address and not the external one and is related either to the inroute or outroute trunk (see field CHARGE_TYPE as a reference).

Could be used by any interconnection processor to classify the different service/charge types.

Condition:

Only applies to interconnection rating.

Derivation:

Only mandatory for RECORD_TYPE 990, 991.

The trunk ID is directly related to the network model and mapping rules used.

POI_USED

X(10)

POI In which was used to calculate the interconnection charges within this packet.

Could be used by any interconnection processor to classify the different service/charge types.

Condition:

Only applies to interconnection rating.

Derivation:

Only mandatory for RECORD_TYPE 990, 991.

The POI is directly related to the network model and mapping rules used.

PRODUCTCODE_USED

X(10)

Internal charge offer which was used to calculate the charges within this packet. This field contains the internal, virtual or mapped network service type and is related either to the inroute or outroute trunk (ICPRODUCT).

Could be used by any interconnection processor to classify the different service/charge types.

Condition:

Only applies to interconnection rating.

Derivation:

Only mandatory for RECORD_TYPE 990, 991.

The Charge Offer Code is directly related to the IC Charge Offer Code configuration.

PIN_LOGIN_ALIAS

String

Optional. Calculated.

CHARGING_START_TIMESTAMP

YYYYMMDDHH24MISS

The timestamp used for charging.

Format:

YYYYMMDDHHMISS; for example, 19990518190357.

Optional Field Usage:

It is possible to read/write dates in number of seconds since 01.01.1970 00:00:00; for example, 12345. The internal representation is the format YYYYMMDDHHMISS anyway. This is just an optional input/output format conversion.

CHARGEABLE_QUANTITY_VALUE

9(15)

Original chargeable units (beats, duration), as provided by the sender (for example, network element or any other given input format). Contains the original, not-rounded quantity value.

Might be useful by some kind of processors analyzing as how many units the call was originally treated by the sender and/or as many the record was treated during rating.

Values:

Maximum: 999999999999999

Examples:

CHARGABLE_QUANTITY_VALUE = 87 sec.

a) if RATEPLAN is defined with a 60sec. beat

-> ROUNDED_QUANTITY_VALUE will contain 120sec.

b) if RATEPLAN is defined with a 30sec. beat

-> ROUNDED_QUANTITY_VALUE will contain 90sec.

Derivation:

Optional, defaulted by ROUNDED_QUANTITY_VALUE if not provided or present. Set by either the input format or the rating processor generating this packet and left unchanged.

ROUNDED_QUANTITY_VALUE

9(15)

Charged units (beats, duration), as calculated via the related RATEPLAN. Contains the rounded quantity value as it has been calculated during rating.

Might be useful by some kind of processors analyzing as how many units the call was originally treated by the sender and/or as many the record was treated during rating.

Values:

Maximum: 999999999999999

Examples:

CHARGABLE_QUANTITY_VALUE = 87 sec.

a) if RATEPLAN is defined with a 60sec. beat

-> ROUNDED_QUANTITY_VALUE will contain 120sec.

b) if RATEPLAN is defined with a 30sec. beat

-> ROUNDED_QUANTITY_VALUE will contain 90sec.

Derivation:

Mandatory, defaulted 0. Set by the rating processor generating this packet and left unchanged.

ROUNDED_QUANTITY_FROM

Decimal

Mandatory. Calculated.

ROUNDED_QUANTITY_TO

Decimal

Mandatory. Calculated.

ROUNDED_QUANTITY_UoM

X(3)

The Unit of Measurement associated with the Rounded Chargeable Quantity Value.

Can be used to interpret the quantity value, but usually not needed because the quantity itself is sufficient for all rating steps.

Values:

As specified in the database model, if a UoM conversion had been carried out; else as defined in the related Basic Detail Record.

Derivation:

Mandatory, default 'SEC'. Set by the rating processor and left unchanged.

QUANTITY_FROM

Decimal

Charge packet start quantity.

QUANTITY_TO

Decimal

Charge packet end quantity.

EXCHANGE_RATE

9(11)

Contains the exchange rate which has been used to convert the Incoming currency to the internal currency as indicated in the field CHARGED_CURRENCY_TYPE.

Can be used to convert the virtual currency SDR (which is used in conjunction of TAP) to internal currencies and convert the Charge back to SDR after Rating. This would be a typical usage for Interconnection Rating.

Values:

Variable floating point format: Given value, might be 0.000. The floating decimal point must be set.

Minimum: -9999999999

Maximum: 99999999999

Examples:

'00000000125' for 125,00

'00000012.50' for 12,50

'-0012.56780' for -12,5678

Derivation:

Optional, defaulted 00000000001 (=1,00).

EXCHANGE_CURRENCY

X(3)

Currency code as defined for the exchange rate; for example, "DEM" or "EUR".

Can be used to interpret the exchange rate to distinguish to which currency the exchange rate was used for. For example, for TAP: the charged amount might be given in SDR currency and the exchange rate will define the rate used to convert into local currency.

Derivation:

Optional. As related to the exchange rate value used for. Use the three-digit ISO currency code.

CHARGED_CURRENCY_TYPE

X(1)

Indicates which of the available currencies was used to generate the charge packet.

Could be used by any post-processor to classify the different charge packets.

Values:

R: Rating Currency (default)

B: Billing Currency

H: Home Currency

Note: In case of currency conversion, where in parallel all three currency models are supported (R, B, and H); there is one charge packet for each currency type.

Derivation:

Depending on the function module which generated the charge packet, the value is set to one of the values given above. The rating modules set the value to "R", while the ExchangeRate module generates two charge packets (one for the home currency and one for the billing currency). This feature is usually required for interconnection purposes.

CHARGED_AMOUNT_VALUE

9(11)

The charge for the call (could be any kind of price). A monetary amount assigned to the call by any rating processor. This includes any toll charge but does not include any CAMEL invocation fee. In case of interconnection or roaming charges, this is the advice of charge.

Can be used by any post-processor to collect multiple charges related to one record. This opens the possibility to keep more then one charge. With this structure there is the possibility to keep all charges related to the record/call (for example, end-customer, wholesale, content provider, reseller, optimized data warehouse etc.).

Values:

Space: No price given, like NULL in a database

Variable floating point format: Given value, might be 0.000. The floating decimal point must be set.

Minimum: -9999999999

Maximum: 99999999999

Examples:

'00000000125' for 125,00

'00000012.50' for 12,50

'-0012.56780' for -12,5678

Derivation:

Mandatory.

CHARGE_REFUND_INDICATOR

Integer

Optional. Charge refund indicator item.

CHARGED_AMOUNT_VALUE_ORIG

Decimal

Optional. Used if the exchange rate module is configured.

CHARGED_AMOUNT_CURRENCY

X(3)

Currency code as defined within the associated RATEPLAN; for example, DEM or EUR.

Can be used to interpret the amount value and to distinguish between different currencies (multicurrency support). Any rating or billing processor might convert the different currencies.

Derivation:

Mandatory. As related to the RATEPLAN used. Use the three-digit ISO currency code.

CHARGED_TAX_TREATMENT

X(1)

Charges might be inclusive or exclusive of tax.

Can be used to interpret the amount value and to distinguish between net and gross charges.

Values:

Y: Tax included in the charge

N: Tax not included in the charge (default)

Derivation:

Mandatory (default N).

CHARGED_TAX_RATE

9(4)

Defines the tax rate applicable to the charge. Because some national legal definitions dictate that the tax rate applicable is determined by the invoice date, there is a possibility that the rate on the invoice might differ from the rate on the transfer. However, the likelihood of this happening is extremely low.

Can be used to interpret the amount value and to convert between net and gross charges or to represent customer-specific rates.

Values:

0000 through 9999 (2 fixed decimals)

Example:

16.00% 1600

Derivation:

Optional. As related to the taxation module used (refer to IFW_TAX.TAXRATE).

CHARGED_TAX_CODE

X(5)

Defines the tax rate applicable to the charge. Because some national legal definitions dictate that the tax rate applicable is determined by the invoice date, there is a possibility that the rate on the invoice might differ from the rate on the transfer. However, the likelihood of this happening is extremely low.

Can be used by any billing processor to interpret the amount value and to convert and calculate a customer-specific tax rate.

Values:

As defined via the reference IFW_GLACCOUNT.TAXCODE.

Example:

M16 for tax code M16.

Derivation:

Optional. As related to the RATEPLAN configuration's general ledger account used.

USAGE_GL_ACCOUNT_CODE

X(10)

The General Ledger Code defines a reference applicable to the usage revenue account.

Can be used by any billing processor to interpret the amount value and to convert and calculate a customer-specific tax rate or to trigger any account balance bookings within a financial accounting system.

Values:

As defined in the database object IFW_RATEPLAN_CNF.USG_GLACCOUNT.

Example:

USG_AIRTEL for account usage revenue airtime.

Derivation:

Optional. As related to the RATEPLAN used.

REVENUE_GROUP_CODE

X(5)

The Revenue Group Code defines a reference applicable to a specific group of usage revenue. Different usage groups can be used to define split billing rules to be distributed to different customers; for example, airtime is paid by a subscriber and monthly periodic fees are paid by the customer above.

Usage:

Can be used by any billing processor to interpret a split billing based on different revenue groups.

Values:

As defined in the database object IFW_RATEPLAN_CNF.REVENUEGROUP.

Example:

AIR for usage revenue group airtime.

Derivation:

Optional. As related to the RATEPLAN used.

DISCOUNTMODEL_CODE

X(10)

External Discount Code as defined in the related DISCOUNTMODEL Object (.CODE) used by the rating process.

Could be used by any post-processor to evaluate the discount that was really used during the related rating process.

Derivation:

Mandatory. Dependent on the setup of the RATEPLAN within the related rating processor. This value represents the external discount code as it had been set up and used.

GRANTED_DISCOUNT_AMOUNT_VALUE

9(11)

The field records the total discount value, which was granted to calculate the correct CHARGED_AMOUNT_VALUE.

Can be used by any post-processor analyzing the discounts that had been granted and must be used to calculate the exact charge (with discount included). This will give a good indicator of the discount structure and usage.

Note: The CHARGED_AMOUNT_VALUE never contains this DISCOUNT_VALUE.

Values:

Space: No price given, like NULL in a database

Variable floating point format: Given value, might be 0.000. The floating decimal point must be set.

Minimum: -9999999999

Maximum: 99999999999

Examples:

'00000000125' for 125,00

'00000012.50' for 12,50

'-0012.56780' for -12,5678

Derivation:

Mandatory, default 0.

Note: The currency is always the same currency as given in the field CHARGED_AMOUNT_CURRENCY.

GRANTED_DISCOUNT_QUANTITY_VALUE

9(15)

The total discount quantity value, which was granted to calculate the correct CHARGED_AMOUNT_VALUE; for example, Applied free minutes.

Not updated by discounting. Used in interconnect mapping.

Can be used by any post-processor analyzing the discounts that had been granted. Could be used to recalculate the original quantity value (without any discount). This will give a good indicator of the discount structure and usage.

Condition:

Only relevant for quantity (duration) based service discounts.

Values:

Maximum: 999999999999999

Derivation:

Mandatory, default 0. Might be set by any rating or pre-billing processor.

GRANTED_DISCOUNT_QUANTITY_UoM

X(3)

The Unit of Measurement associated with the Granted Discount Quantity Value.

Not updated by discounting. Used in interconnect mapping.

Can be used to interpret the quantity value, but usually not needed because the quantity itself is sufficient for all rating steps.

Values:

As specified in the database model, if a UoM conversion had been carried out; else as defined in the related Basic Detail Record.

Derivation:

Mandatory, default 'SEC'. Set by the rating processor and left unchanged.

DEFERRED_AMOUNT

Decimal

Optional

Calculated

PIN_PERCENT

Decimal

Optional

Calculated

NUMBER_OF_DISCOUNT_PACKETS

9(2)

Defines the number of supplementary discount packet records following these base fields (dynamic structure); for example, 05 means that 5 records are following.

Must be used to evaluate how the record structure continues.

Values:

00 - 99: either zero or N record(s) are following

Derivation:

Mandatory.

VALID_FROM

Date

Optional.

VALID_TO

Date

Optional.

CYCLE_OFFSET

Integer

Optional. Identifies a grant's validity period.

CHARGE_INDEX

Integer

The array index of incoming charge packets, used by the discount pipeline to match existing charges, in case a credit limit check changed the original charges.

Split Charge Packet

FCT_Discount splits charge packets if necessary during prepaid authorization. Each split charge packet represents a segment with a single net rate, including discounts.

Table 77-39 lists the fields in the Split Charge Packet.

Table 77-39 Split Charge Packet Fields

Name Format Description

RESOURCE_ID

Integer

Numeric ID of the balance element. Used for filtering in the discount detail. Copied from the original charge packet.

RUM

String

RUM name. Copied from the original charge packet.

QUANTITY_FROM

Decimal

Split charge packet start quantity. Calculated by the module.

QUANTITY_TO

Decimal

Split charge packet end quantity. Calculated by the module.

CHARGED_AMOUNT_VALUE

Decimal

Amount of the charge for this split charge packet. Calculated by the module.

INTERN_PACKET_INDEX

Integer

The index of the split charge packet.

INTERN_SRC_PACKET_INDEX

Integer

The packet index of the charge packet from which this split charge packet was generated.

Supplementary Last Beat Information

Information about the last beat (the LAST_BEAT_INFO block) is mainly used for abnormal call terminations.

Table 77-40 lists the fields in the Supplementary Last Beat Information block fields.

Table 77-40 Supplementary Last Beat Information Fields

Name Format Description

LAST_BEAT_QUANTITY

Decimal

The length of a beat. The value of a beat (for example, clicks or bytes) is defined in the pricing and determined by FCT_MainRating.

LAST_BEAT_CHARGE

Decimal

The charge for a beat.

Charge Breakdown Record Tax Packet (RECType 660)

Add code to the OutGrammar to store tax information from the EDR container into the output TAP blocks.

Block. n times. Optional.

Table 77-41 lists the fields in the Charge Breakdown Record Tax Packet.

Table 77-41 Charge Breakdown Record Tax Packet Fields

Name Format Description

RECORD_TYPE

String

Mandatory. Must be set to 660.

RECORD_NUMBER

Integer

Mandatory. Auto-generated.

TAX_CODE

Integer

None

TAX_RATE

String

None

TAX_VALUE

Decimal

None

TAX_PERCENT

Decimal

None

TAX_VALUE_ORIG

Decimal

Optional. Used when exchange rate is configured.

TAX_TYPE

String

None

CHARGE_TYPE

String

None

TAXABLE_AMOUNT

Decimal

None

TAX_QUANTITY

Decimal

None

RELATED_RECORD_NUMBER

Integer

None

RELATED_CHARGE_INFO_ID

Integer

None

CHARGE_INFORMATION_COUNTER

Integer

None

CHARGE_INFORMATION_COUNTER

Integer

None

Associated Message Description Record (RECType 999)

Stores errors that occur in preprocessing. For each error a single Message Description Record is generated, following the Basic Record. A new Basic Record or the Trailer Record end the sequence of Message Description Records.

Table 77-42 lists the fields in the Associated Message Description Record.

Table 77-42 Associated Message Description Record Fields

Name Format Description

RECORD_TYPE

String

Value:

999: Message Description Record

Derivation:

Mandatory. Set by the first processor and left unchanged.

Usage:

Determination of the different record types.

RECORD_NUMBER

9(9)

Sequence number of record in file.

Can be used to ensure a linear sequence order for all records; for example, as a sorting criteria.

Derivation:

Mandatory. Set by the first processor.

Important: Following modules might change this record number; for example, if new record types are inserted.

SYSTEM

X(8)

Description or Code of the system which produced this record; for example, Host name or process name.

MESSAGE_SEVERITY

X(1)

Severity code for this message.

Values:

N: Normal (Hint)

W: Warning

E: Error (could be either a minor, major, or critical error)

Derivation:

Mandatory. Set by the first processor and left unchanged.

MESSAGE_ID

N(7)

An error code used to cross-reference the call to the relevant description.

Values:

0000000 through 9999999

Derivation:

Mandatory. Set by the first processor and left unchanged.

MESSAGE_DESCRIPTION

X(50)

Description of the error. It is mandatory but the content is entirely at the discretion of the pre-processor.

Derivation:

Mandatory. Set by the first processor and left unchanged.

Associated TAP Error Record

Table 77-43 lists the Associated TAP Error Record fields.

Table 77-43 Associated TAP Error Record Fields

Name Format

RECORD_TYPE

String

RECORD_NUMBER

Integer

ERROR_NAME

String

ERROR_SEVERITY

Integer

TAP3_ERROR_CODE

String

TAP3_ERROR_APPLICATION_TAG

String

TAP3_ERROR_DEPTH

String

Associated SMS Record (RECType 580)

This optional record is used to store SMS call data.

Table 77-44 lists the fields in the Associated SMS Record.

Table 77-44 Associated SMS Record Fields

Name Format Description

RECORD_TYPE

String

Record type for Associated SMS Record.

Value:

580

Derivation:

Mandatory. Set by the first processor.

RECORD_NUMBER

9(9)

Sequence number of record in file.

Used to ensure a linear sequence order for all records; for example, as a sorting criteria.

Values:

Minimum: 000000002

Maximum: 999999998

Derivation:

Mandatory. Auto-generated. Set by the first processor.

Important: Record number may change; for example, if new record types are inserted.

CONTENT_INDICATOR

X(1)

Indicator as to the contents of the message sent or received.

Derivation:

Optional.

ORIGINATING SWITCH IDENTIFICATION

X(10)

SMS-C from which the SMS was issued by the A party.

Derivation:

Optional.

DESTINATION SWITCH IDENTIFICATION

X(10)

SMS-C from which the SMS was issued to the B party.

Derivation:

Optional.

PROVIDER ID

X(2)

Unique Service Provider Identifier.

Derivation:

Optional.

SERVICE ID

X(2)

Unique Service ID.

Derivation:

Optional.

DEVICE NUMBER

X(24)

Identifies the equipment used by the subscriber during the call; for example, the International Mobile Equipment Identity number (IMEI).

Derivation:

Optional.

PORT NUMBER

X(24)

Identifies the unique subscriber ID; for example, the IMSI number.

Derivation:

Optional.

DIALED DIGITS

X(40)

The number dialed by the customer when establishing a call or the number to which the call is forwarded or transferred.

Derivation:

Optional.

Associated MMS Record (RECType 590)

This optional record is used to store MMS call data.

Table 77-45 lists the Associated MMS Record fields.

Table 77-45 Associated MMS Record Fields

Field Name Data Format Description

RECORD TYPE

String

Record type for Associated MMS Record.

Value:

590

Derivation:

Mandatory. Set by the first processor.

RECORD NUMBER

9(9)

Sequence number of record in file.

Used to ensure a linear sequence order for all records; for example, as a sorting criteria.

Values:

Minimum: 000000002

Maximum: 999999998

Derivation:

Mandatory. Auto-generated. Set by the first processor.

Important: Record number may change; for example, if new record types are inserted.

ACCOUNT STATUS TYPE

X(2)

Indicator of the account type from which the message was sent.

Derivation:

Optional.

PRIORITY

X(2)

Indicator as to the priority of the message; for example, high, medium or low.

Derivation:

Optional.

MESSAGE CONTENT

X(255)

Content type; for example, image or plain text.

Derivation:

Optional.

MESSAGE ID

X(16)

Unique message group ID. If the message was sent as part of a group, an indicator as to which group it was sent from.

Derivation:

Optional.

STATION IDENTIFIER

X(255)

Station from which message was sent.

Value:

MMS identifier.

Derivation:

Optional.

FC INDICATOR

X(9)

Indicator as to whether the message was forwarded or copied.

Derivation:

Optional.

CORRELATION ID

X(16)

Correlation ID for the message if part of a group.

Derivation:

Optional.

DEVICE NUMBER

X(24)

Identifies the equipment used by the subscriber during the call; for example, the International Mobile Equipment Identity number (IMEI).

Derivation:

Optional.

PORT NUMBER

X(24)

Identifies the unique subscriber ID; for example, the IMSI number.

Derivation:

Optional.

DIALED DIGITS

X(40)

The number dialed by the customer when establishing a call or the number to which the call is forwarded or transferred.

Derivation:

Optional.

CELL ID

X(10)

Cell ID of the A party, or the cell from which the call originated.

Derivation:

Optional.

B CELL ID

X(10)

Cell ID of the B party, or the cell receiving the call.

Derivation:

Optional.

A TERM CELL ID

X(10)

Cell ID of the A party when the call terminated.

Derivation:

Optional.

Trailer Record (RECType 090)

Table 77-46 lists the fields in the Trailer Record.

Table 77-46 Trailer Record Fields

Name Format Description

RECORD_LENGTH

Integer

Optional for backward compatibility.

RECORD_TYPE

String

Extended to be 3 bytes long, first byte denotes market like GSM, ISDN.

Value:

090: Trailer Record

Derivation:

Mandatory. Set by the first processor and left unchanged.

Usage:

Determination of the different record types.

RECORD_NUMBER

9(9)

Sequence number of record in file.

Can be used to ensure a linear sequence order for all records; for example, as a sorting criteria.

Derivation:

Mandatory. Set by the first processor.

SENDER

X(10)

Identifies the PLMN or physical (network) operator, which is sending the file, used to determine the network, which is the sender of the data. The full list of mobile codes in use is given in MoU TADIG PRD TD. 13: PLMN Naming Conventions.

Can be used to determine a unique NOSP_ID together with the RECIPIENT. Can also be used to determine the network operator responsible for the EDR.

Derivation:

Optional, but should be defaulted if not present on the input side, for example, by own NO-Id, for example, 'DTAG'. Set by the first processor and left unchanged.

RECIPIENT

X(10)

Identifies the PLMN or physical (network) operator to whom the file is being sent, used to determine the network, which is the recipient of the data. The full list of mobile codes in use is given in MoU TADIG PRD TD. 13: PLMN Naming Conventions.

Can be used to determine a unique NOSP_ID together with the SENDER. Can also be used to determine the reseller or service provider who is responsible for billing these CDRs.

Derivation:

Optional, but should be defaulted if not present on the input side, for example, by own NO-Id, for example, 'DTAG'. Set by the first processor and left unchanged.

SEQUENCE_NUMBER

9(6)

Identifies each file sent by the VPLMN or logical sender to a particular HPLMN or logical recipient. It indicates the file number of the specific file type, starting at 1 and increments by one for each new file of that type sent. Separate sequence numbering must be used for Test- and Chargeable-Data. Having reached the maximum value (99999), the number must recycle to 1.

Note: In the case of retransmission for any reason, this number does not increment.

Range:

000001 - 999999 for Test Data

000001 - 999999 for Chargeable Data

Derivation:

Mandatory. Set by the first processor and could be changed by any following processor in case of recycling to assure a unique and linear sequence order to all following processors.

ORIGIN_SEQUENCE_NUMBER

9(6)

Original file sequence number as generated the first time. Identical content as for the SEQUENCE_NUMBER, but will never be changed.

Used as a reference to the original file/stream, if any processor has changed the actual file sequence number.

Derivation:

Mandatory, defaulted by SEQUENCE_NUMBER. Set by the first processor and left unchanged.

TOTAL_NUMBER_OF_RECORDS

9(9)

The total number of Basic Record in the file, excluding header and trailer.

Should be used as a check value, to determine that all records have been correctly transmitted and/or used.

Condition:

Not Present in a Notification File or if no Detail records are present.

Maximum Number: 999999999

Derivation:

Mandatory. Might be recalculated by any processor.

TAP_TOTAL_NUMBER_OF_RECORDS

Integer

Mandatory. Set by TAP input grammar.

FIRST_START_TIMESTAMP

YYYYMMDD HHMISS

The earliest start of charging timestamp on any Basic Detail Record. It is not necessarily the start of charging timestamp of the first charge record on the file.

Should be used as a check value, to determine that all records have been correctly transmitted and/or used.

Condition:

Not present in a Notification File or if no Detail records are present.

Format:

YYYYMMDD HHMISS (see also 'Time-stamp') local time, and not UTC time, is used to determine the earliest call.

Optional Field Usage:

It is possible to read/write dates in number of seconds since 01.01.1970 00:00:00; for example, 12345. The internal representation is the format YYYYMMDDHHMISS anyway. This is just an optional input/output format conversion.

Derivation:

Mandatory.

FIRST_CHARGING_UTC_TIME_OFFSET

X(5)+/-HHMI

All timestamps are sender (VPLMN) local time. So that the time can be equated to time in the recipient (HPLMN) local time, the sender shall give the difference between local time and UTC time. UTC Time Offset = Local Time minus UTC Time.

Can be used to translate the TRANSFER_CUTOFF_TIMESTAMP into a unified UTC time. This might be useful if a centralized rating and billing will take place.

Example:

Washington DC, USA 1000hrs 10/10/97

   UTC Time 1500hrs 10/10/97

   UTC Time Offset = 10 - 15 = -0500

Madrid, Spain 1600hrs 10/10/97

   UTC Time 1500hrs 10/10/97

   UTC Time Offset = 16 - 15 = +0100

Sydney, Australia 0100hrs 11/10/97

   UTC Time 1500hrs 10/10/97

   UTC Time Offset = (01 + 24) - 15 = +1000

Note: Where dates are different, 24 is added to the time of the greater date

Derivation:

Mandatory. Set by the first processor and left unchanged.

LAST_START_TIMESTAMP

YYYYMMDDHHMISS

The latest start of charging timestamp on any Basic Detail Record. It is not necessarily the start of charging timestamp of the last charge record on the file.

Should be used as a check value, to determine that all records have been correctly transmitted and/or used. Might also be used to validate that all records are earlier then the given transfer cutoff timestamp (see header record).

Condition:

Not present in a Notification File or if no Detail records are present.

Format:

YYYYMMDD HHMISS (see also 'Time-stamp') local time, and not UTC time, is used to determine the earliest call.

Optional Field Usage:

It is possible to read/write dates in number of seconds since 01.01.1970 00:00:00; for example, 12345. The internal representation is the format YYYYMMDDHHMISS anyway. This is just an optional input/output format conversion.

Derivation:

Mandatory.

LAST_CHARGING_UTC_TIME_OFFSET

X(5)+/-HHMI

All timestamps are sender (VPLMN) local time. So that the time can be equated to time in the recipient (HPLMN) local time, the sender gives the difference between local time and UTC time. UTC Time Offset = Local Time minus UTC Time.

Can be used to translate the TRANSFER_CUTOFF_TIMESTAMP into a unified UTC time. This might be useful if a centralized rating and billing will take place.

Example:

Washington DC, USA 1000hrs 10/10/97

   UTC Time 1500hrs 10/10/97

   UTC Time Offset = 10 - 15 = -0500

Madrid, Spain 1600hrs 10/10/97

   UTC Time 1500hrs 10/10/97

   UTC Time Offset = 16 - 15 = +0100

Sydney, Australia 0100hrs 11/10/97

   UTC Time 1500hrs 10/10/97

   UTC Time Offset = (01 + 24) - 15 = +1000

Note: Where dates are different, 24 is added to the time of the greater date.

Derivation:

Mandatory. Set by the first processor and left unchanged.

TOTAL_RETAIL_CHARGED_VALUE

9(15)

The sum of the Retail Charged Amount Value of any Basic Detail Record. The toll element of a charge is that portion related to the carrier and Destination. There will only be one toll charge present for all chained records.

Should be used as a check value, to determine that all records have been correctly transmitted and/or used.

Values:

Space: No price given, like NULL in a database.

Variable floating point format: Given value, might be 0.000. The floating decimal point must be set.

Minimum: -99999999999999

Maximum: 999999999999999

Examples:

'00000000125' for 125,00

'00000012.50' for 12,50

'-0012.56780' for -12,5678

Derivation:

Mandatory.

TOTAL_WHOLESALE_CHARGED_VALUE

9(15)

The sum of the Wholesale Charged Amount Value of any Basic Detail Record contained in the batch. This is present for audit purposes only.

Should be used as a check value, to determine that all records have been correctly transmitted and/or used.

Values:

Variable floating point format: Given value, might be 0.000. The floating decimal point must be set.

Minimum: -99999999999999

Maximum: 999999999999999

Examples:

'00000000125' for 125,00

'00000012.50' for 12,50

'-0012.56780' for -12,5678

Derivation:

Mandatory.

TAP_TOTAL_CHARGE_VALUE

Decimal

Mandatory. Set by TAP input grammar.

TOTAL_TAX_VALUE

Decimal

Calculated. Auto-generated.

TAP_TOTAL_TAX_VALUE

Decimal

Mandatory. Set by TAP input grammar.

TAP_TOTAL_DISCOUNT_VALUE

Decimal

Mandatory. Set by TAP input grammar.

OPERATOR_SPECIFIC_INFO

String

Stores a key to identify the CDR used to generate a specific EDR.

Useful for RAP or CIBER return.

Optional. Default = ' '

Must be set by an iScript.

CIBER_FILLER

String

Optional.

CREATION_TIMESTAMP

Date

Optional. See the CIBER specification for usage.

CIBER_RECORD_TYPE

String

Optional. See the CIBER specification for usage.

SETTLEMENT_PERIOD

String

Optional. See the CIBER specification for usage.

CLEARINGHOUSE_ID

String

Optional. See the CIBER specification for usage.

CURRENCY

String

Optional. See the CIBER specification for usage.

SENDING_CLEARINGHOUSE_BID

String

Optional. See the CIBER specification for usage.

CIBER_R70 BATCH_TOTALS_SIGN

String

Optional. See the CIBER specification for usage.

CIBER_R70 ORIGINAL_TOTALS_SIGN

String

Optional. See the CIBER specification for usage.

ORIGINAL_SEQUENCE_NUMBER

Integer

Optional. See the CIBER specification for usage.

ORIGINAL_CREATION_TIMESTAMP

Date

Optional. See the CIBER specification for usage.

ORIGINAL_TOTAL_NUMBER_OF_RECORDS

Integer

Optional. See the CIBER specification for usage.

ORIGINAL_TOTAL_WHOLESALE_CHARGED_VALUE

Decimal

Optional. See the CIBER specification for usage.

NOTIFICATION_END_INDEX

Integer

Notification block end index.

AUDIT_CONTROL_INFO_START_INDEX

Integer

AuditControlInfo block start index.

AUDIT_CONTROL_INFO_END_INDEX

Integer

AuditControlInfo block end index.

DELAYED_ERROR_BLOCK

String

Stores the block name that has the fatal error.

TOTAL_CHARGE_VALUE_LIST

Block

n times. Mandatory.

The TAP record is used by GSM operators and data clearinghouses to exchange roaming information.

TOTAL_CHARGE_VALUE

Decimal

Mandatory. Set by TAP grammar.

CHARGE_TYPE

String

Mandatory. Set by TAP grammar.

TOTAL_CHARGE_REFUND

String

Optional.

TOTAL_CHARGE_REFUND

Decimal

Optional.

Associated UTCOffset Record

Table 77-47 lists the fields in the Associated UTCOffset Record.

Table 77-47 Associated UTCOffset Record Fields

Name Format Description

UTCTIMEOFFSETCODE

Integer

Stores the UTC time offset code from TAP header.

UTCTIMEOFFSET

String

Stores the UTC time offset value from TAP header.

Associated Recentity Record

Table 77-48 lists the fields in the Associated Recentity Record.

Table 77-48 Associated Recentity Record Fields

Name Format Description

RECENTITYCODE

Integer

Stores the REC entity code from TAP header.

RECENTITYTYPE

Integer

Stores the REC entity type from TAP header.

RECENTITYID

String

Stores the REC entity ID from TAP header.

TAP Total Charge Value List

Mandatory. 0 .. N times.

Table 77-49 lists the TAP Total Charge Value List fields.

Table 77-49 TAP Total Charge Value List Fields

Name Format Description

TOTAL_CHARGE_VALUE

Decimal

Set by TAP grammar.

Mandatory.

CHARGE_TYPE

String

Set by TAP grammar.

Mandatory.

TOTAL_CHARGE_REFUND

Decimal

Optional.

Internal Service Control Container

This record is used internally by the framework.

Table 77-50 lists the fields in the Internal Service Control Container.

Table 77-50 Internal Service Controller Container Fields

Name Format Description

STREAM_NAME

String

Calculated.

OFFSET_GENERATION

Integer

Calculated.

SEQ_CHECK

Integer

Calculated.

SEQ_GENERATION

Integer

Calculated.

TRANSACTION_ID

Decimal

Calculated.

PROCESS_STATUS

Integer

Values:

0: Normal (default)

1: Recycling

2: Recycling test

Mandatory. Calculated.

Customer Data Record

This record is used internally to save all customer-related attributes along with an event.

Table 77-51 lists the fields in the Customer Data Record.

Table 77-51 Customer Data Record Fields

Name Format Description

ACCOUNT_ID

String

Mandatory.

ACCOUNT_PARENT_ID

String

Optional.

ACCOUNT_NO

String

Mandatory.

CREATION_DATE

Date

Mandatory.

CURRENCY

String

Mandatory.

CUST_SEG_LIST

String

Mandatory.

RESIDENCE_TYPE

String

Optional.

SYSTEM_BRAND

String

Optional.

BILL_CYCLE

String

Values:

00-28

Mandatory.

BILL_FREQUENCY

Integer

Values:

1-12

Mandatory.

PAYMENT_TYPE

String

Optional.

BILL_STATE

Integer

Mandatory.

ACTG_LAST_DATE

Date

Mandatory.

ACTG_NEXT_DATE

Date

Mandatory.

ACTG_FUTURE_DATE

Date

Mandatory.

ACTG_USED_DATE

Date

Mandatory.

BILL_LAST_DATE

Date

Mandatory.

BILL_NEXT_DATE

Date

Mandatory.

BILL_FUTURE_DATE

Date

Mandatory.

RESOURCE_LIST

String

Optional.

LEAST_COST

Integer

Optional.

PROMOTIONAL_SAVING

Integer

Optional.

PROMOTION

Integer

Optional.

Purchased Charge Offers

Table 77-52 lists the fields in the Purchase Products block.

Table 77-52 Purchased Products Fields

Name Format Description

PRODUCT_NAME

String

Mandatory.

USAGE_START

Date

Optional.

USAGE_END

Date

Optional.

QUANTITY

Decimal

Optional.

OFFERING_POID

String

Optional.

OVERRIDDEN_OFFERING_POID

String

Optional.

NODE_LOCATION

String

Mandatory.

DEAL_NAME

String

Mandatory.

Important: The DEAL_NAME value is not stored in memory nor retained in the EDR. Therefore, this value will not appear in the EDR dump.

PLAN_NAME

String

Mandatory.

PRODUCT_TYPE

Integer

Defines system or normal product; for example, 603 or 602.

RATEPLAN_NAME

String

Mandatory.

PRIORITY

Integer

Mandatory.

PRODUCT_ID

String

Optional.

SERVICE_TYPE

String

For example, /service/telco/gsm/data.

Mandatory.

SERVICE_ID

String

Optional.

SERVICE_PROMO_CODE

String

Optional.

SERVICE_VENDOR

String

Optional.

SERVICE_SOURCE

String

Optional.

SERVICE_LOGIN

String

Mandatory.

SERVICE_MSISDN

String

Optional.

SERVICE_IMSI

String

Optional.

SERVICE_STATUS

String

Mandatory.

SERVICE_USED_ITEM_POID

String

Mandatory.

NETWORK_IDENT

String

Optional.

FIRST_USAGE_INDICATOR

Integer

Specifies whether the charge offer is configured to start when first used and the first-usage validity period status.

Optional.

Extended Rating Attributes List

Table 77-53 lists the fields in the Extended Rating Attributes List.

Table 77-53 Extended Rating Attributes List Fields

Name Format Description

PROFILE

String

Mandatory.

LABEL

String

Optional.

Profile Attributes

Table 77-54 lists the Profile Attributes fields.

Table 77-54 Profile Attributes Fields

Name Format Description

KEY

String

Mandatory.

VALUE

String

Mandatory.

Alias List

Table 77-55 lists the Alias list field.

Table 77-55 Alias List Field

Name Format Description

ALIAS_NAME

String

Mandatory.

Discount List

Table 77-56 lists the Discount List fields.

Table 77-56 Discount List Fields

Name Format Description

BALANCE_GROUP_ID

String

Mandatory.

DISCOUNT_OWNER_ACCT_ID

String

Mandatory.

DISCOUNT_OWNER_ID

String

Mandatory.

DISCOUNT_OWNER_TYPE

String

Mandatory.

Purchased Discounts

Table 77-57 lists the Purchased Discounts fields.

Table 77-57 Purchased Discounts Fields

Name Format Description

DISCOUNT_ID

String

Mandatory.

DISCOUNT_MODEL

String

Mandatory.

PURCHASE_START

Date

Mandatory.

PURCHASE_END

Date

Mandatory.

USAGE_START

Date

Optional.

USAGE_END

Date

Optional.

PRIORITY

Integer

Mandatory.

MODE

Integer

Mandatory.

VALID_FLAG

Integer

Mandatory.

TYPE

Integer

Mandatory.

OFFERING_POID

String

Mandatory.

NODE_LOCATION

String

Mandatory.

STATUS

Integer

Mandatory.

QUANTITY

Integer

Mandatory.

FLAGS

Integer

Mandatory.

SCALE

Decimal

Mandatory.

FIRST_USAGE_INDICATOR

Integer

Specifies whether the charge offer is configured to start when first used and the first-usage validity period status.

Optional.

Sponsor List

Table 77-58 shows the Sponsor List fields.

Table 77-58 Sponsor List Fields

Name Format Description

BALANCE_GROUP_ID

String

Mandatory.

SPONSOR_OWNER_ACCT_ID

String

Mandatory.

SPONSOR_OWNER_ID

String

Mandatory.

SPONSOR_OWNER_TYPE

String

Mandatory.

Sponsorship Details

Table 77-59 lists the Sponsorship Details fields.

Table 77-59 Sponsorship Details Fields

Name Format Description

SPONSORSHIP_ID

String

Mandatory.

DISCOUNT_MODEL

String

Mandatory.

VALID_FLAG

Integer

Mandatory.

Plan List

Table 77-60 lists the Plan List field.

Table 77-60 Plan List Field

Name Format Description

PLAN_ID

String

Mandatory.

Balance Group

Table 77-61 lists the Balance Group field.

Table 77-61 Balance Group Field

Name Format Description

BALANCE_GROUP_ID

String

Mandatory.

Balance Element

Table 77-62 lists the Balance Element fields.

Table 77-62 Balance Element Fields

Name Format Description

RESOURCE_ID

Integer

Mandatory.

CURR_BAL

Decimal

Mandatory.

CREDIT_FLOOR

Decimal

Mandatory.

CREDIT_LIMIT

Decimal

Mandatory.

RESERVED_AMOUNT

Decimal

Mandatory.

Name

Format

Description

Associated CIBER Extension Record

See the CIBER 2.5 specification for explanations of the fields listed in Table 77-63.

Table 77-63 Associated CIBER Extension Record Fields

Name Format Description

RECORD_TYPE

String

Default = 701 (this is not yet the final value).

Mandatory.

RECORD_NUMBER

Integer

Auto-generated.

Mandatory.

FILLER

String

The filler for CIBER optional fields at the end of a record.

Optional.

NO_OCC

Integer

Flag to suppress OCC (type 50 or 52) record-creation process.

Optional.

INTERN_MOBILE_ID_NO

String

None

INTERN_CALLED_NO

String

None

INTERN_MSISDN_MDN

String

None

INTERN_CALLER_ID

String

None

INTERN_ROUTING_NO

String

None

INTERN_TLDN_NO

String

None

CIBER_RECORD_TYPE

String

Optional.

RETURN_CODE

String

Optional.

RETURN_REASON_CODE

String

Optional.

INVALID_FIELD_ID

String

Optional.

HOME_CARRIER_SID

String

Optional.

MOBILE_ID_NO_LENGTH

Integer

Optional.

MOBILE_ID_NO

String

Optional.

MOBILE_ID_NO_OVERFLOW

String

Optional.

ELECTRONIC_SERIAL_NO

String

Optional.

CALL_DATE

Date

Optional.

SERVING_CARRIER_SID

String

Optional.

TOTAL_CHARGE_AND_TAX

Decimal

Optional.

TOTAL_STATE_TAX

Decimal

Optional.

TOTAL_LOCAL_TAX

Decimal

Optional.

CALL_DIRECTION

String

Optional.

CALL_COMPLETION_INDICATOR

String

Optional.

CALL_TERMINATION_INDICATOR

String

Optional.

CALLED_NO_LENGTH

Integer

Optional.

CALLED_NO

String

Optional.

CALLED_NO_OVERFLOW

String

Optional.

TEMP_LOCAL_DIRECTORY_NO

String

Optional.

CURRENCY_TYPE

String

Optional.

ORIG_BATCH_SEQ_NO

Integer

Optional.

INITIAL_CELL_SITE

String

Optional.

TIME_ZONE_INDICATOR

String

Optional.

DAYLIGHT_SAVINGS_INDICATOR

String

Optional.

MSG_ACCOUNTING_DIGITS

String

Optional.

SSU_CONNECT_TIME

Date

Optional.

SERVING_STATE

String

Optional.

RECV_CARRIER_SID

String

Optional.

TRANS_CODE1

String

Optional.

TRANS_CODE2

String

Optional.

SENDING_CARRIER_SID

String

Optional.

CHARGE_NO_1_IND

String

Optional.

CHARGE_NO_1_CONNECT_TIME

Date

Optional.

CHARGE_NO_1_CHARGEABLE_TIME

String

Optional.

CHARGE_NO_1_ELAPSED_TIME

String

Optional.

CHARGE_NO_1_RATE_PERIOD

String

Optional.

CHARGE_NO_1_MULTIRATE_PERIOD

String

Optional.

CHARGE_NO_1

Decimal

Optional.

CHARGE_NO_2_IND

String

Optional.

CHARGE_NO_2_CONNECT_TIME

Date

Optional.

CHARGE_NO_2_CHARGEABLE_TIME

String

Optional.

CHARGE_NO_2_ELAPSED_TIME

String

Optional.

CHARGE_NO_2_RATE_PERIOD

String

Optional.

CHARGE_NO_2_MULTIRATE_PERIOD

String

Optional.

CHARGE_NO_2

Decimal

Optional.

CHARGE_NO_3_IND

String

Optional.

CHARGE_NO_3_CONNECT_TIME

Date

Optional.

CHARGE_NO_3_CHARGEABLE_TIME

String

Optional.

CHARGE_NO_3_ELAPSED_TIME

String

Optional.

CHARGE_NO_3_RATE_PERIOD

String

Optional.

CHARGE_NO_3_MULTIRATE_PERIOD

String

Optional.

CHARGE_NO_3

Decimal

Optional.

CHARGE_NO_4_IND

String

Optional.

CHARGE_NO_4_CONNECT_TIME

Date

Optional.

CHARGE_NO_4_CHARGEABLE_TIME

String

Optional.

CHARGE_NO_4_ELAPSED_TIME

String

Optional.

CHARGE_NO_4_RATE_PERIOD

String

Optional.

CHARGE_NO_4_MULTIRATE_PERIOD

String

Optional.

CHARGE_NO_4

Decimal

Optional.

CHARGE_NO_1_SURCHARGE_IND

String

Optional.

CHARGE_NO_2_SURCHARGE_IND

String

Optional.

CHARGE_NO_3_SURCHARGE_IND

String

Optional.

CHARGE_NO_4_SURCHARGE_IND

String

Optional.

TOLL_CONNECT_TIME

Date

Optional.

TOLL_CHARGEABLE_TIME

String

Optional.

TOLL_ELAPSED_TIME

String

Optional.

TOLL_TARIFF_DESC

String

Optional.

TOLL_RATE_PERIOD

String

Optional.

TOLL_MULTIRATE_PERIOD

String

Optional.

TOLL_RATE_CLASS

String

Optional.

TOLL_FROM_RATING_NPA_NXX

String

Optional.

TOLL_CHARGE

Decimal

Optional.

TOLL_STATE_TAX

Decimal

Optional.

TOLL_LOCAL_TAX

Decimal

Optional.

TOLL_NETWORK_CARRIER_ID

String

Optional.

MSID_INDICATOR

String

Optional.

MSID

String

Optional.

MSISDN_MDN_LENGTH

Integer

Optional.

MSISDN_MDN

String

Optional.

ESN_IMEI_INDICATOR

String

Optional.

ESN_IMEI

String

Optional.

CALLER_ID_LENGTH

Integer

Optional.

CALLER_ID

String

Optional.

ROUTING_NO_LENGTH

Integer

Optional.

ROUTING_NO

String

Optional.

TLDN_NO_LENGTH

Integer

Optional.

TLDN_NO

String

Optional.

AIR_CONNECT_TIME

Date

Optional.

AIR_CHARGEABLE_TIME

String

Optional.

AIR_ELAPSED_TIME

String

Optional.

AIR_RATE_PERIOD

String

Optional.

AIR_MULTIRATE_PERIOD

String

Optional.

AIR_CHARGE

Decimal

Optional.

OTHER_CHARGE_1_INDICATOR

String

Optional.

OTHER_CHARGE_1

Decimal

Optional.

CALLED_COUNTRY

String

Optional.

SERVING_COUNTRY

String

Optional.

TOLL_RATING_POINT_LENGTH

Integer

Optional.

TOLL_RATING_POINT

String

Optional.

FEATURE_USED_AFTER_HO_IND

String

Optional.

OCC_START_DATE

Date

Optional.

OCC_CHARGE

Decimal

Optional.

FET_EXEMPT_INDICATOR

String

Optional.

PASS_THROUGH_CHARGE_IND

String

Optional.

CONNECT_TIME

Date

Optional.

RECORD_USE_INDICATOR

String

Optional.

OCC_DESCRIPTION

String

Optional.

OCC_END_DATE

Date

Optional.

RECORD_CREATE_DATE

Date

Optional.

SEQ_INDICATOR

String

Optional.

OCC_INTERVAL_INDICATOR

String

Optional.

EVENT_DATE

Date

Optional.

MIN_ESN_APP_INDICATOR

String

Optional.

R70_RECORD_USE_INDICATOR

String

Optional.

EVENT_TIME

Date

Optional.

Discount Balance Packet

Table 77-64 lists the Discount Balance Packet fields.

Table 77-64 Discount Balance Packet Fields

Name Format Description

DISCOUNT_KEY

String

Discount key (normally the account ID).

ACCOUNT_ID

Integer

Related account ID.

RESOURCE_ID

Integer

BRM mapped balance element ID.

DISCOUNT_STEP

Integer

Alternative key if balance element ID 0.

DISCOUNT_MASTER

Integer

Alternative key if balance element ID 0.

UPDATE_LEVEL

String

Always empty. Supports backward compatibility.

SERVICE_ID

Integer

Supports backward compatibility.

Aggregation Period

Table 77-65 lists the Aggregation Period fields.

Table 77-65 Aggregation Period Fields

Name Format Description

PERIOD

String

The accounting cycle. YYYYMMDD.

ITEM_POID

String

POID of the item that identifies the accounting cycle.

CREATED

String

Creation date.

TOTAL_CHARGE

Decimal

Total charge.

TOTAL_QUANTITY

Decimal

Total quantity based on RUMs in the discount filter.

TOTAL_EVENT

Decimal

Sum of events based on charge packets.

GRANTED_CHARGE

Decimal

The discounted charge.

GRANTED_QUANTITY

Decimal

The discounted quantity.

FRAME_CHARGE

Decimal

Total charge of the discount frame, based on the frame.

FRAME_QUANTITY

Decimal

Total quantity in the discount frame based on RUMs in the discount filter.

FRAME_EVENT

Decimal

Total events of the discount frame, based on charge packets.

Discount Packet

Table 77-66 lists the Discount Packet fields.

Table 77-66 Discount Packet Fields

Name Format Description

RECORD_TYPE

String

Mandatory.

CREATED

String

Creation date.

OBJECT_ID

String

Discount/sponsor object ID.

OBJECT_TYPE

String

Discount/sponsor object that generated the event.

OBJECT_ACCOUNT

Integer

POID of the discount owner.

OBJECT_OWNER_ID

Integer

POID type of the discount owner.

OBJECT_OWNER_TYPE

String

POID type of the discount owner.

DISCOUNTMODEL

String

Discount.

DISCOUNTRULE

String

Discount rule.

DISCOUNTSTEPID

Integer

Discount step ID.

DISCOUNTBALIMPACTID

Integer

Discount balance impact ID.

TAX_CODE

String

Tax code.

GRANTED_AMOUNT

Decimal

Granted discount/sponsorship amount. Can be currency or noncurrency.

GRANTED_AMOUNT_ORIG

Decimal

Original granted discount/sponsorship amount. Used when exchange rate is configured.

GRANTED_QUANTITY

Decimal

The discount base value used to compute the granted amount.

AMOUNT

Decimal

Discounted currency amount.

PIN_PERCENT

Decimal

Percent value filled from charge packet

QUANTITY

Decimal

Discounted noncurrency amount.

QUANTITY_FROM

Decimal

Discounted quantity start value.

QUANTITY_TO

Decimal

Discounted quantity end value.

VALID_FROM

Date

Grant case, valid-from date.

VALID_TO

Date

Grant case, valid-to date.

VALID_FROM_DETAIL

Integer

First Usage Offset and Unit for valid-from date.

VALID_TO_DETAIL

Integer

First Usage Offset and Unit for valid-to date.

CYCLE_OFFSET

Integer

Charge offer cycle that identifies a grant's validity period.

BALANCE_GROUP_ID

Integer

Balance group ID.

SERVICE_CODE

String

Service code.

RESOURCE_ID

Integer

Balance Element ID.

RESOURCE_ID_ORIG

Integer

Original balance element ID. Used when exchange rate is configured.

ZONEMODEL_CODE

String

Zone model.

IMPACT_CATEGORY

String

Impact category.

TIMEZONE_CODE

String

Time-zone code.

TIMEMODEL_CODE

String

Time model code.

SERVICE_CLASS

String

Service class.

PRICEMODEL_CODE

String

Pricing code.

RUM

String

RUM.

RATETAG

String

Rate tag.

RATEPLAN

String

Charge.

GLID

String

G/L ID.

OFFERING_POID

String

Purchased discount offer POID.

NODE_LOCATION

String

Node location.

INTERN_PACKET_INDEX

Integer

Packet ID.

INTERN_SRC_PACKET_INDEX

Integer

Source packet ID.

INTERN_RUM_ID

Integer

RUM ID passed in and out, used in real-time pipeline only.

INTERN_DISC_MATCH_FACTOR

Decimal

Discount match factor (the percentage of usage discounted).

INTERN_TOTAL_MATCH_FACTOR

Decimal

Total discounted match factor (the total percentage of usage discounted).

DEFERRED_AMOUNT

Decimal

Deferred amount.

Discount Sub-Balance Packet

Table 77-67 lists the Discount Sub-Balance Packet fields.

Table 77-67 Discount Sub-Balance Packet Fields

Name Format Description

REC_ID

Integer

Record ID.

VALID_FROM

Date

Validity start time.

VALID_TO

Date

Validity end time.

AMOUNT

Decimal

Amount.

CONTRIBUTOR

String

Contributor.

NEXT_BAL

Date

Next balance.

DELAYED_BAL

Decimal

Delayed balance.

GRANTOR

String

The charge offer or discount offer that granted this balance element.

VALID_FROM_DETAILS

Date

Sub-balance start time mode (such as first-usage or relative) and relative offset and unit.

VALID_TO_DETAILS

Date

Sub-balance end time mode (such as relative) and relative offset and unit.

GRANT_VALID_FROM

Date

Grant validity start time.

GRANT_VALID_TO

Date

Grant validity end time.

Associated SMS Extension Record

Table 77-68 lists the Associated SMS Extension Record fields.

Table 77-68 Associated SMS Extension Record Fields

Name Format Description

RECORD_TYPE

String

Mandatory.

Default = 580.

RECORD_NUMBER

Integer

Mandatory.

Auto-generated.

CONTENT_INDICATOR

String

Optional.

ORIGINATING_SWITCH_IDENTIFICATION

String

Optional.

DESTINATION_SWITCH_IDENTIFICATION

String

Optional.

PROVIDER_ID

String

Optional.

SERVICE_ID

String

Optional.

DEVICE_NUMBER

String

Optional.

PORT_NUMBER

String

Optional.

DIALED_DIGITS

String

Optional.

Associated MMS Extension Record

Table 77-69 lists the Associated MMS Extension Record fields.

Table 77-69 Associated MMS Extension Record Fields

Name Format Description

RECORD_TYPE

String

Mandatory.

Default = 590.

RECORD_NUMBER

Integer

Mandatory.

Auto-generated.

ACCOUNT_STATUS_TYPE

String

Optional.

PRIORITY

String

Optional.

MESSAGE_CONTENT

String

Optional.

MESSAGE_ID

String

Optional.

STATION_IDENTIFIER

String

Optional.

FC_INDICATOR

String

Optional.

CORRELATION_ID

String

Optional.

CELL_ID

String

Optional.

B_CELL_ID

String

Optional.

A_TERM_CELL_ID

String

Optional.

DEVICE_NUMBER

String

Optional.

PORT_NUMBER

String

Optional.

SGSN Information

Table 77-70 lists the SGSN Information field.

Table 77-70 SGSN Information Field

Name Format Description

SGSN_ADDRESS

String

Mandatory.

Profile Event Ordering

Table 77-71 lists the Profile Event Ordering fields.

Table 77-71 Profile Event Ordering Fields

Name Format Description

RECORD_TYPE

String

Mandatory.

Must be set to 850.

RECORD_NUMBER

Integer

Mandatory.

BAL_GRP_POID

String

Mandatory.

CRITERIA_NAME

String

Mandatory.

PROFILE_POID

String

Mandatory.

BILLING_CYCLE_TIMESTAMP

Date.

Mandatory.

Associated Roaming Extension Record

Table 77-72 lists the Associated Roaming Extension Record fields.

Table 77-72 Associated Roaming Extension Record Fields

Name Format Description

RECORD_TYPE

String

None

RECORD_NUMBER

Integer

None

TAP_FILE_SEQ_NO

Integer

None

RAP_FILE_SEQ_NO

Integer

None

RAP_RECORD_TYPE

String

None

SENDER

String

None

RECIPIENT

String

None

TAP_FILE_PATH

String

None

START_MISSING_SEQ_NUM

Integer

None

END_MISSING_SEQ_NUM

Integer

None

SUSPENSION_TIME

Date

None

PORT_NUMBER

String

None

TOTAL_TAX_REFUND

Decimal

None

TOTAL_DISCOUNT_REFUND

Decimal

None

GUARANTEED_BIT_RATE

String

None

MAXIMUM_BIT_RATE

String

None

HSCSD_INDICATO

String

None

SMS_ORIGINATOR

String

None

SMS_DESTINATION_NUMBER

String

None

DISCOUNTABLE_AMOUNT

Decimal

None

DISCOUNT_CODE

Integer

None

NETWORKACCESS_IDENTIFIE

String

None

ISM_SIGNALLING_CONTEXT

Integer

None

IMSI

String

None

HOME_BID

String

None

HOMELOCATION_DESCRIPTION

String

None

MOBILE_ID_NUMBER

String

None

MOBILE_DIR_NUMBER

String

None

TOTAL_ADVISEDCHARGE

Decimal

None

TOTAL_ADVISEDCHARGE_REFUND

Decimal

None

TOTAL_COMMISSION

Decimal

None

TOTAL_COMMISSION_REFUND

Decimal

None

ITEM_OFFSET

Integer

None

ERROR_CODE

Integer

None

TOTAL_SEVERE_RETURN_VALUE

Decimal

None

RETURN_DETAILS_COUNT

Integer

None

CLIR_INDICATOR

String

None

TAP_CURRENCY

String

Currency used for TAP3 and TAP 311.

Associated RAP Extension

Table 77-73 lists the Associated RAP Extension fields.

Table 77-73 Associated RAP Extension Fields

Name Format Description

PATH_ITEMID

Integer

None

ITEM_OCCURRENCE

Integer

None

ITEM_LEVEL

Integer

None

Total Advised Charge Value List

Table 77-74 lists the Total Advised Charge Value List fields.

Table 77-74 Total Advised Charge Value List Fields

Name Format Description

TOTAL_ADVISEDCHARGE

Decimal

None

TOTAL_ADVISEDCHARGE_REFUND

Decimal

None

ADVISED_CHARGE_CURRENCY

String

Optional.

AdvisedChargeCurrency item.

TOTAL_COMMISSION;

Decimal

None

TOTAL_COMMISSION_REFUND

Decimal

None

Field Usage

Roaming

The following conditions are checked to determine if the usage record is for roaming:

if [DETAIL.USAGE_DIRECTION] = 2
       then Roaming = TRUE; Roaming-Type = MOC
elseif [DETAIL.USAGE_DIRECTION] = 3
       then Roaming = TRUE; Roaming-Type = MTC
else   Roaming = FALSE

International-Call

The following conditions are checked to determine if the usage record is for an international call:

if [DETAIL.CONNECT_SUB_TYPE] = '04'
       then International-Call=TRUE

CLI Normalization

The result of the mapping operation (performed either within an input module or within an iScript) must be written/copied to the following internal container fields:

DETAIL.A_NUMBER -> normalize -> DETAIL.INTERN_A_NUMBER_ZONE

DETAIL.B_NUMBER -> normalize -> DETAIL.INTERN_B_NUMBER_ZONE

DETAIL.C_NUMBER -> normalize -> DETAIL.INTERN_C_NUMBER_ZONE

The original values within the Basic Detail Record are kept unchanged.

The following fields determine how and which a normalization function should be carried out:

DETAIL.A_NUMBERING_PLAN -> normalize DETAIL.A_NUMBER

DETAIL.B_NUMBERING_PLAN -> normalize DETAIL.B_NUMBER

DETAIL.C_NUMBERING_PLAN -> normalize DETAIL.C_NUMBER

if DETAIL.x_NUMBERING_PLAN between 1 and 9 -> use "ISDN, MSISDN"

if DETAIL.x_NUMBERING_PLAN between A and B -> use "Ipv4, IPv6"

if DETAIL.x_NUMBERING_PLAN = 0 -> no normalization

ISDN, MSISDN

The following rules normalize the A number and B number. All CLIs are normalized to match the international format: International_access_codeCountry_codeNational_destination_codeSubscriber_number; for example, '00491711234567' or '004980012345'.

To handle a flexible international format, the following parameters must be set prior to the normalization:

International_access_code (iac): international access code; for example, '00'

Note:

Multiple iacs might be defined.

International_access_code_sign (iacs): international access code sign; for example, '+'

Country_code (cc): country code of the home country; for example, '49'

National_destination_access_code (ndac): national destination access code for long distance; for example, '0'

National_destination_code (ndc): default national destination code; for example, '172' (only for special mobile calls)

Normal-Call

Table 77-75 lists the Normal-Call fields.

Table 77-75 Normal-Call Fields

Item Description

A#:

[DETAIL.A_NUMBER, X(40)]

B#:

[DETAIL.B_NUMBER, X(40)]

  1. if <empty>-> replace with '<iac><cc>' (break)

  2. if Prefix = '<iacs>'-> replace with '<iac>' (continue)

  3. if Prefix = '<iac>'-> do nothing (break)

  4. if Prefix = '<ndac>'-> replace with '<iac><cc>' (break)

  5. if [TYPE_OF_NUMBER] = 1-> prefixing '<iac>' (break)

Roaming-Call (Mapping only for Zone- and PrefixDesc.-Determination)

An Associated GSM/Wireline Extension Record must exist.

Table 77-76 lists the Roaming-Call fields.

Table 77-76 Roaming-Call Fields

Item Type Description

A#:

MOC

-> '0000' + Left([ASS_GSMW_SE.ORIGINATING_SWITCH_ID], 5)

A#:

MTC

-> Normalization as for normal calls

B#:

MOC

-> Normalization as for normal calls

B#:

MTC

-> '0000' + Left([ASS_GSMW_SE.TERMINATING_SWITCH_ID], 5)

If on the input side there is only one single MSC_ID or PLMN_ID available, the related input module has to map this single value into both fields (Originating and Terminating).

Special-Mobile-Call:

A/B-MODIFICATION_INDICATOR = '04'

Normalize to: <iac><cc>'0'<ndc><number>; for example, '0049017222255'

Table 77-77 lists the Special-Mobile-Call fields.

Table 77-77 Special-Mobile-Call Fields

Item Description

A#:

[DETAIL.A_NUMBER, X(40)]

B#:

[DETAIL.B_NUMBER, X(40)]

  1. if <empty>-> replace with '<iac><cc>' (break)

  2. if Prefix = '<iacs>'-> replace with '<iac>' (continue)

  3. if Prefix = '<iac><cc>'-> replace with '<iac><cc>0' (break)

  4. if Prefix = '<ndac>'-> prefixing '<iac><cc>' (break)

  5. if Prefix != '<cc>'-> prefixing '<iac><cc>0<ndc>' (break)

  6. if [TYPE_OF_NUMBER] = 1-> prefixing '<iac>' (break)

IPv4, IPv6

If the A# (source ip) and B# (destin ip) are carrying ip-addresses, they are normalized to zero-leading-tokens without the dots or colon; for example, '192.168.10.1' is normalized to '192168010001'.

Notations are listed in Table 77-78:

Table 77-78 IPv4 and IPv6 Attributes

Item Type Description

IPv4:

nnn.nnn.nnn.nnn

n = (0..9)

IPv6:

hhhh:hhhh:hhhh:hhhh:hhhh:hhhh:hhhh:hhhh

h = (0..F)

IPv4 as v6:

0000:0000:0000:0000:0000:0000:nnn.nnn.nnn.nnn

None

or

0000:0000:0000:0000:0000:FFFF:nnn.nnn.nnn.nnn

None

IPv4 Record

Table 77-79 lists the IPv4 Record fields.

Table 77-79 IPv4 Record Fields

Item Type Description

A#:

[DETAIL.A_NUMBER, X(40)]

(source ip-address)

B#:

[DETAIL.B_NUMBER, X(40)]

(destination ip-address)

  1. determine the four decimal ip-tokens

  2. fill each token with leading zeros (up to 3-digits)

  3. remove all dots '.'

IPv6 Record

Table 77-80 lists the IPv6 Record fields.

Table 77-80 IPv6 Record Fields

Item Type Description

A#:

[DETAIL.A_NUMBER, X(40)]

(source ip-address)

B#:

[DETAIL.B_NUMBER, X(40)]

(destination ip-address)

  1. determine the eight hexadecimal ip-tokens

  2. fill each token with leading zeros (up to 4-digits)

  3. remove all colons ':'

IPv4 as IPv6 Record

Table 77-81 lists the IPv4 vs IPv6 Record fields.

Table 77-81 IPv4 as IPv6 Record Fields

Item Type Description

A#:

[DETAIL.A_NUMBER, X(40)]

(source ip-address)

B#:

[DETAIL.B_NUMBER, X(40)]

(destination ip-address)

  1. determine the six fix hexadecimal v6 ip-tokens

  2. fill each token with leading zeros (up to 4-digits)

  3. remove all colons ':'

  4. determine the four decimal ip-tokens at the end of the address

  5. take the first two v4 tokens and convert them to hexadecimal (for example, '192.168' = 192*256ˆ1 + 168*256ˆ0 = 49320 = 'C0A8')

  6. take the last two v4 tokens and convert them to hexadecimal

  7. replace the origin v4 address by the two calculated v6 equivalents filled with leading zeros

UsageClass (CallClass)

The result of the mapping operation (performed either within an input module or within an early iScript) must be written/copied to the following internal container fields:

DETAIL.USAGE_CLASS -> mapping -> DETAIL.INTERN_USAGE_CLASS

The original values within the Basic Detail Record are kept unchanged.

The following rules apply to determine the external UsageClass value:

Always: Value of the field [DETAIL.USAGE_CLASS]

ServiceCode / ServiceClass

The result of the mapping operation (performed either within an input module or within an early iScript) must be written/copied to the following internal container fields:

DETAIL.BASIC_SERVICE -> mapping -> DETAIL.INTERN_SERVICE_CODE

mapping -> DETAIL.INTERN_SERVICE_CLASS

The original values within the Basic Detail Record are kept unchanged.

The following rules apply to determine the external ServiceCode value:

Always: Value of the field [DETAIL.BASIC_SERVICE];

containing [SERVICE_TYPE, X(1)]+ [SERVICE_CODE, X(2)]