Configuring BAMS for NICS Output

Overview

This chapter describes the NICS billing record output by the Cisco Billing and Measurements Server (BAMS). You enable NICS output with the NODEPARMS tag ID. For more information, see the "NODEPARMS Tag ID" section on page 5-10.

Once you have configured your system for NICS output you also need to populate the prefix field in the Trunk Group table (see the "TRUNKGRP—Trunk Group Table" section on page 5-28), and the fields in the Trunk Group Prefix table (see the "TKGPREFIX—Trunk Group Prefix Table" section on page 5-30).

NICS Output

NICS output files are created by the NIC task. These files are stored in the NICS subdirectory of the /data/nodename directory (for example, /data/s0x/NICS). The fields generated in the NICS output are explained in Table 9-1. The NICS file-naming conventions are explained in "File-Naming Conventions" section on page A-4.

NICS Data Format

Table 9-1 defines the field name, format, length, PGW 2200 CDB, CDE tag numbers and derivation mapping, and padding and alignment for NICS output.

Note This version of the Cisco Billing and Measurements Server User's Guide, Release 3.13 (NICS Phase 2) defines how the NICS output changed from the preceding release of Cisco BAMS 3.13 Table 9-1 includes two columns for information about PGW 2200 CDB, CDE Tag Numbers and Derivation.
The (NICS Phase 2) column defines how this information changed from the initial release of Cisco BAMS 3.13.

Table 9-1 NICS Output Field Ordering 

Field
Field Name
Format
PGW 2200 CDB, CDE Tag Numbers and Derivation
Padding and Alignment

1

Record Sequence Number (RSN)

(1-25 digits), number in decimal format

No direct mapping.

BAMS generates the RSN on its own as a 64-bit integer, starting from 1.

First record, RSN = 1.

Second record, RSN=2, ...

The Nth record, RSN = N, ...

The RSN is not reset when BAMS restarts or when BAMS generates a new output file.

None

2

Call Event ID

char (26)

Char (1-6), softswitch group ID, first 6 characters of tag 6000 from 1090 CDB.

Char (7-14), date in YYYYMMDD format, using value from tag 4100/4101 in CDB 1010 or 1030, uses 4001 if neither is available.

Char (15-23), time in HHMMSSmmm format.

Char (24-26), the sequence number, decimal format left padded by 0. Uses the last 3 digits of the following number:

(tag4002) & 0xffffffff

 

3

NICS Identifier (a.k.a. Switch id)

char (10)

CDE tag 6000 from CDB 1090. Tag 6000 may contain up to 32 characters, only up to the first 10 characters are used

None

4

Call Direction

number 1

No direct mapping available, not required, always populated with the digit "0"

None

5

Link ID

number 1

All 1030 CDBs:

0 1040 CDBs without any previous 1060s 0
the first 1060, 1 the second and later 1060, 2 1040 with any previous 1060s, 3

None

6

Calling Party Cat

char(3)

Same as tag 3000 or tag 2000 in 1010 or 1030 CDB, whichever is present. In decimal format, such as 000, 013, etc. Defaults to "000" if no tag 2000 or 3000 is found.

Right aligned, zero padded on left.

7

Origin Line Info

 

Same as tag 2002 or 3002 in 1010 or 1030 CDB. In decimal format, such as 000, 013, etc., defaults to "000" if no 3002 or 2002 is found.

Right aligned, zero padded on left.

8

Jurisdiction

char(6)

Populated with NUL.

None

9

Called NAI

number, 3 digits, decimal format

Tag 3007 or 2007 from 1010 or 1030 CDB.

Right aligned, pad by 0

10

Calling NAI

number, 3 digits, decimal format

Tag 3003 or 2003 from 1010 or 1030 CDB.

Right aligned, pad by 0

11

Charge NAI

number, 3 digits, decimal format

Tag 2004 from 1010 or 1030 CDB, defaults to 000 if tag is not available.

Right aligned, pad by 0

12

Caller Presentation

char (2)

Always 00.

 

13

Media Type

char (2)

Always 00.

 

14

Connection Date

char (8)

Tag 4100 from 1010 or 1030 CDB.

Format: YYYYMMDD

 

15

Connection Time

char (9)

Tag 4100 from 1010 or 1030 CDB.

Format: HHMMSSmmm

 

16

Answer Indicator

number (1)

If both tags 4104 and 4105 are present in 1030 or 1010 CDB, the digit is 1. Otherwise the digit is 0.

None

17

Call Termination Code

number (3), decimal

Same as in tag 2008 or 3008 CDE. For example, "016", "031", defaults to NUL for long-duration records.

Right aligned, padded by "0".

18

Originating Country Code

number (5)

Always NUL, not required.

None

19

Originating Number

char (40)

CDE 4010 from 1010 or 1030 CDB, with special rules.

Note Simplified, these rules change the prefix to 00 in the calling party number if the calling party number nature of address is international. The rules change the prefix to 0 if the calling party number nature of address is national. This applies to egress trunk groups of types 1, 2, 4, and 5 in the TKGPREFIX table associated with the prefix configured in the TRUNKGRP table.

None

20

Dialed Country Code

number (5)

Always NUL, not required.

None

21

Dialed Number

char (40)

CDE 4012 or CDE 4014 from 1010 or 1030 CDB.

None

22

Terminating Country Code

number (5)

Always NUL, not required.

None

23

Terminating Number

char (40)

CDE 4014 from 1010 or 1030 CDB.

None

24

Charge Number

char (40)

CDE 4011.

None

25

Elapsed Time

char (10)

The earlier of 4106 or 4107 from CDB 1040/1030 minus the later of 4104 or 4105 from 1010/1030 CDB.

For long durations, this field uses the time stamp of the 1060 (4001) minus the later of 4104/4105 from the 1010 CDB.

Format: HHHMMSSmmm

Right aligned for each subfield, 0 padded.

26

Carrier ID Code

char (4)

CDE 2014 from 1010/1030, in decimal format, default NUL.

None

27

Ingress carrier connection date

char (8)

4103 from 1010/1030 CDB.

Format: YYYYMMDD

None

28

Ingress carrier connection time

char (9)

4103 from 1010/1030 CDB.

Format: HHMMSSmmm

None

29

Ingress carrier disconnection date

char (8)

If (CDE 4028 != 1), it uses earlier of CDE 4107 and 4106, otherwise it uses the later of the two.

Format: YYYYMMDD

NUL for long-duration records.

None

30

Ingress carrier disconnection time

char (9)

If (CDE 4028 != 1), it uses earlier of CDE 4107 and 4106, otherwise it uses the later of the two.

Format: HHMMSSmmm

NUL for long-duration records.

 

31

Ingress Remote Point Code

char (9)

CDE 4034 from 1010 or 1030.

 

32

Ingress CIC ID

number (4)

CDE 4068 from 1010 or 1030, default 0000

Right aligned, zero padded

33

Ingress - Access Device ID

number (10)

Always 0000000000

Right aligned, zero padded

34

Ingress Module

number (4)

Always 0000

Right aligned, zero padded

35

Ingress Line

number (4)

Always 0000

Right aligned, zero padded

36

Ingress Channel

number (4)

Always 0000

Right aligned, zero padded

37

Ingress trunk group name

char (8)

CDE 4008 from 1010 or 1030 and the prefix value from the trunkgrp table.

For example, if the trunk group is 1001 and the prefix is "SIP", this field is "SIP1001"

None

38

Ingress trunk name

number (8)

CDE 4009 from 1010 or 1030

None

39

Ingress Protocol

char (10)

CDE 4069 from 1010/1030. Values:

0 = ISDN_PRI

1 = SS7

2 = DPNSS

3 = CAS

4 = ASN

5 = Unknown

6 = EISUP

7 = H323

8 = SIP

9 = MGCP

Default = Unknown

None

40

Ingress Coding

char (16)

Uses value from CDE 4207. This CDE is available from 1010, 1030 or 1040. The latest value is always used.

None

41

Ingress Audio Cap

char (16)

Always NUL.

 

42

Ingress - IP Address

char (15)

Uses value from CDE 4205. This CDE is available from 1010, 1030 or 1040. The latest value is always used.

If a fully qualifying Domain Name is passed from CDE 4205 instead of the dot address, BAMS uses up to the first 15 characters of the Domain Name for this field.

Three characters for each dot-
separated field of the IP address. Right aligned, zero padded.

43

Ingress RTP Port

number (6)

Uses value from CDE 4209. This CDE is available from 1010, 1030 or 1040. The latest value is always used.

Right aligned, zero padded

44

Ingress Pkts sent

number (9)

Always 000000000

Right aligned, zero padded

45

Ingress Pkts recv

number (9)

Always 000000000

Right aligned, zero padded

46

Ingress Pkts dropped

number (9)

Always 000000000

Right aligned, zero padded

47

End Date

char (8)

Derived from the earlier of CDE 4106 or 4107 in 1010 or 1030 CDB.

Format: YYYYMMDD

Long-duration records use the time stamp of the current CDB (CDE 4001).

 

48

End Time

char (9)

Derived from the earlier of CDE 4106 or 4107 in 1010 or 1030 CDB.

Format: HHMMSSmmm

Long-duration records use the time stamp of the current CDB (CDE 4001).

 

49

Answer Date

char (8)

The first record (Link_ID = 0 or 1) is derived from 4104 in 1010 or 1030. If 4104 is not present, the record is derived from 4105 in 1010 or 1030.

The second and later records of the same call use the time stamp (CDE 4001) of the previous 1060 CDB.

Format: YYYYMMDD

 

50

Answer Time

char (9)

The first record (Link_ID = 0 or 1) is derived from 4104 in 1010 or 1030.. If 4104 is not present the record is derived from 4105 in 1010 or 1030.

The second and later record of the same call use the time stamp (CDE 4001) of the previous 1060 CDB.

Format: HHMMSSmmm,

 

51

Carrier Select Info

number (2)

CDE 2015 from 1010 or 1030, default 00

 

52

Routing select

number (2)

Route index, first two octets of CDE 4045 from 1010, default 00

Right aligned, zero padded

53

Egress Remote PC

char (9)

CDE 4037 from 1010 or 1030.

 

54

Egress CIC

number (4)

CDE 4072 from 1010 or 1030, default 0000

Right aligned, zero padded

55

Egress - Access Device ID

char (10)

Always NUL.

None

56

Egress Module

char (4)

Always NUL.

 

57

Egress Line

char (4)

Always NUL.

 

58

Egress Channel

char (4)

Always NUL.

 

59

Egress trunk group name

char (8)

CDE 4015 from 1010 or 1030, and the prefix value from the Trunk Group table.

For example, if the trunk group is 2001 and the prefix is "P", this field is "P2001".

None

60

Egress trunk name

number (8)

CDE 4016 from 1010 or 1030.

 

61

Egress Protocol

char (10)

CDE 4073 from 1010 or 1030. Values:

0 = ISDN_PRI

1 = SS7

2 = DPNSS

3 = CAS

4 = ASN

5 = Unknown

6 = EISUP

7 = H323

8 = SIP

9 = MGCP

Default = Unknown

 

62

Egress Coding

char (16)

Uses value from CDE 4208. This CDE is available from 1010, 1030 or 1040. The latest value is always used.

 

63

Egress Audio Cap

char (16)

Always NUL.

 

64

Egress - IP Address

char (15)

Uses value from CDE 4206. This CDE is available from 1010, 1030 or 1040. The latest value is always used.

Three characters for each dot- separated field of the IP address. Right aligned, zero padded.

65

Egress RTP Port

number (6)

Uses value from CDE 4210. This CDE is available from 1010, 1030 or 1040. The latest value is always used.

Right aligned, zero padded

66

Egress Pkts sent

number (9)

Always 000000000

 

67

Egress Pkts recv

number (9)

Always 000000000

Right aligned, zero padded

68

Egress Pkts dropped

number (9)

Always 000000000

Right aligned, zero padded

69

Egress carrier connection date

char (8)

4103 from 1010 or 1030.

Format: YYYYMMDD

None

70

Egress carrier connection time

char (9)

4103 from 1010 or 1030.

Format: HHMMSSmmm

None

71

Egress carrier disconnection date

char (8)

If (CDE 4028 == 1), it uses the earlier of CDE 4106 and 4107; otherwise, it uses the later of the two.

Format: YYYYMMDD

None

72

Egress carrier disconnection time

char (9)

If (CDE 4028 == 1), it uses the earlier of CDE 4106 and 4107; otherwise, it uses the later of the two.

Format: HHMMSSmmm

None

73

Services

 

Not used, always NUL.

None