Table of Contents

Resource Allocation ($80) Report

Report Type
Destination VCA
Description
Action Causing Report Generation
Format
Examples

Hardware Allocation ($81) Report

Report Type
Destination VCA
Description
Action Causing Report Generation
Format
Example

Card Status ($82) Report

Report Type
Destination VCA
Description
Action Causing Report Generation
Format
Example

Port Status ($83) Report

Report Type
Destination VCA
Description
Action Causing Report Generation
Format
Example

MF Digit ($D0) Report

Report Type
Destination VCA
Description
Action Causing Report Generation
Format
Examples

DTMF Digit ($D1) (Standard) Report

Report Type
Destination VCA
Description
Action Causing Report Generation
Format
Examples

DTMF Digit ($D1) (Enhanced) Report

Report Type
Destination VCA
Description
Action Causing Report Generation
Format
Examples

Permanent Signal Condition ($D2) Report

Report Type
Destination VCA
Description
Action Causing Report Generation
Format
Examples

System Port Status ($D3) Report

Report Type
Destination VCA
Description
Action Causing Report Generation
Format
Examples

Routing Action ($D5) Report

Report Type
Destination VCA
Description
Action Causing Report Generation
Format
Examples

Resource Limitation ($D6) Report

Report Type
Destination VCA
Description
Action Causing Report Generation
Format
Examples

System Card Status ($D9) Report

Report Type
Destination VCA
Description
Action Causing Report Generation
Format
Examples

Outgoing Port Change of State ($DA) Report

Report Type
Destination VCA
Definition
Action Causing Report Generation
Format
Examples

Incoming Port Change of State ($DB) Report

Report Type
Destination VCA
Definition
Action Causing Report Generation
Format
Examples

Active/Standby Mode ($DC) Report

Report Type
Destination VCA
Description
Action Causing Report Generation
Format
Examples

Inpulse Rule Complete (Macro) ($DD) Report

Report Type
Destination VCA
Description
Action Causing Report Generation
Format
Examples

Voice Port Status ($DE) Report

Report Type
Destination VCA
Description
Action Causing Report Generation
Format
Example

ISDN Port Change of State ($EA) Report

Report Type
Destination VCA
Definition
Action Causing Report Generation
Format

ISDN Inpulse Rule Complete ($ED) Report

Report Type
Destination VCA
Description
Action Causing Report Generation
Format

Alarm Condition ($F0) Report

Report Type
Destination VCA
Description
Action Causing Report Generation
Format
Examples

System Reports

The system reports communicate the operating and call processing status of the system to the host. These reports fall into three categories: configuration control, system status, and resource control.

The system reports consist of a string of bytes immediately following the Network Header (refer to "Message Structure Overview." Although the format of the reports varies, they all begin with a Function Identifier. Table 5-1 shows the report type and Function ID for each system report.

Each byte in a report is a hexadecimal (base 16) number. Most reports require you to convert this hexadecimal number into binary (base 2) or decimal (base 10) numbers to interpret the byte. A decimal-hexadecimal-binary conversion table is provided in "Decimal/Hexadecimal/Binary Conversion."

Byte offset values under the Format heading are counted from the initial byte of the Network Header (byte offset 0 D 3). Interpret these values according to the following list:

Note   Unless otherwise stated, all MF processing described in this chapter applies to both MF and MFCR2 processing.

Resource Allocation ($80) Report

Report Type

System Status

Destination VCA

Same as Source VCA of command requesting this report.

Description

The Resource Allocation ($80) report returns a bit map containing the status of each port within a given range and specified resource group. This report takes the same form as the Request Resource Allocation ($80) command, with the port information attached. The report shows if a port is of the specified resource group and whether it is on line or off line. Ports in Maintenance Busy state are reported as off line. The report does not specify if a port is idle or busy. Each status byte contains information on four adjacent ports.

Action Causing Report Generation

The $80 report is generated in response to an $80 command. If the resource group for which the report is requested is empty, the report is returned with the Network Status byte set to $01 (message processing was successful) but without any $80 report Status Bytes attached.

Format

Figure 5-1 shows the byte formatting for this report.

Address Range (byte offsets 5 to 8)—Specifies the range of port addresses shown in this report. Calculate the hexadecimal and decimal representation of the address range according to the calculation formula described below. Refer to Table 5-2 as you read the following explanation to interpret the displayed address range.

To determine a displayed address range, you must interpret bytes 5 through 8 in your $80 report. Ports are divided into groups of 512, decimal; however, the groups of ports are specified in hexadecimal. For example, the address range of 00 00 00 00 is a hexadecimal representation of the first group of ports, ports 0 to 511 (decimal), or 00000000 to 000001FF (hexadecimal) inclusive. The address range of 00 00 00 01 is a hexadecimal representation of the second group of ports, ports 512 to 1023 (decimal), or 00000200 through 000003FF (hexadecimal) inclusive. The address range of 00 00 00 02 is a hexadecimal representation of the third group of ports, ports 1024 to 1535 (decimal), or 00000400 through 000005FF. Notice that the bytes listed in your $80 report, which designate the address range, increase by one for each group of 512 ports. This leads to a method of calculation for the hexadecimal representation of address ranges in $80 reports.

To demonstrate the method of calculation, assume that an address range of 00 00 00 20 is displayed in an $80 report. Convert the hexadecimal value (00000020) to a decimal value (32). Next, multiply that decimal value by the number of ports in each group (512). The resulting value is 16,384, decimal. Convert this decimal value to hexadecimal. The resulting value is 00004000. The address range of the $80 report is the range of ports from 16, 384 to 16, 895 (decimal), or 00004000 to 000041FF (hexadecimal).

Refer to Table 5-2 for a summary of these figures, and extrapolate this information to interpret the bytes specified in the address ranges of your $80 reports.

Examples

The following report is in response to an $80 command.

Function ID = 80 (Resource Allocation)

Address Range = 00000007 (ports $E00 to $FFF)

Resource Group = 0000

Status Byte 1 = 00000000

Ports $E00 to $E03—Not in group 21

Status Byte 2 = 00000000

Ports $E04 to $E07—Not in group 21

Status Byte 3 = 11111111

Ports $E08 to $E0B—In group 21 and on line

Status Byte 4 = 11000001

Port $E0C—In group 21, and on line

Port $E0D—Not in group 21

Port $E0E—Not in group 21

Port $E0F—In group 21 but off line

Status Byte 128 = 01010101

Port $FFC—Port in group 21 but off line

Port $FFD—Port in group 21 but off line

Port $FFE—Port in group 21 but off line

Port $FFF—Port in group 21 but off line

The following report is in response to a Request Resource Allocation command for a resource group that is not defined in the database.

Function ID = 80 (Resource Allocation)

Address Range = 00000006 (ports $C00 to $DFF)

Resource Group = 0000 (resource group 0)

No status bytes attached

Hardware Allocation ($81) Report

Report Type

System Status

Destination VCA

Same as Source VCA of command requesting this report.

Description

The Hardware Allocation ($81) report returns a bit map of ports within a given range. The report contains 66 bytes. The first two bytes contain the Function ID and Address Range information. The next 64 bytes contain hardware address information, with each byte representing 8 port addresses.

Action Causing Report Generation

The $81 report is generated in response to a Request Hardware Allocation ($81) command.

Format

Figure 5-1 shows the byte formatting for this report.

Function ID (byte offset 4)—Byte immediately following the Network Header; uniquely identifies the report from the system.

Address Range (byte offsets 5 to 8)—Specifies the port address range for which the report was generated. Interpret the byte according to the following list:

00—Ports $00 to $1FF (0 to 511)

40—Ports $200 to $3FF (512 to 1023)

80—Ports $400 to $5FF (1024 to 1535)

C0—Ports $600 to $7FF (1536 to 2047)

100—Ports $800 to $9FF (2048 to 2559)

140—Ports $A00 to $BFF (3072 to 3583)

180—Ports $C00 to $DFF (3072 to 3583)

1C0—Ports #E00 to $FFF (3584 to 4095)

Rack-Level-Slot (byte offsets 9 to 72)—Each report contains 64 Rack-Level-Slot (R-L-S) Bytes; each byte contains 8 port addresses worth of information. Interpret the bytes according to the information in Table 5-3.

Example

The following report gives the R-L-S locations for ports in the address range $200 to $3FF. Port addresses $220 to $237 correspond to a card in R-L-S location 1-2-2, and port addresses $2E0 to $2F8 correspond to a card in R-L-S location 1-3-9. All other port addresses in this range are not allocated. Because they are T1 cards, they have 24 port addresses assigned to them.

Card Status ($82) Report

Report Type

System Status

Destination VCA

Same as Source VCA of command requesting this report.

Description

The Card Status ($82) report informs the host of the status of a card. The card location is represented both by the port address and the physical rack, level, and slot (R-L-S) address. The report includes the status of the card and the type of the card.

One $82 report is generated for each card specified in the Card Status ($82) command. For a multispan card, an $82 report is generated for each span in the slot.

The $82 report takes the form of a command returned with a network status byte set to $01.

Action Causing Report Generation

The system response to an $82 command is a separate $82 report for each card specified in the $82 command from the host. For a multispan card, a separate $82 report is generated for each interface.

Format

Figure 5-3 shows the byte formatting for this report.

Example

The following command requests the status of the cards 1,1,6 and 1,1,7:

Function ID = 82 (Card Status report)

Starting RLS = 01,01,06

Span = all spans

Ending RLS = 01,01,07

Span = spans 1 and 2

The following three reports are generated for this command:

• First report:

04 05060708 09101112 131415 16171819 20 21 82 00000020 0000003F 010C20 01010601 19 01

Function ID = 82 (Card Status report)

Lowest Port Affected = 00000020

Highest Port Affected = 0000003F

Real Time Clock = 010C20 (1:12:32 am: 01 = 1; 0C = 12; 20 = 32)

RLSS = 01010601

Card Type = 19 (PRI/N card)

Card State = 01 (Active)

• Second report:

04 05060708 09101112 131415 16171819 20 21 82 00000040 0000005F 010C20 01010701 1F 02

Function ID = 82 (Card Status report)

Lowest Port Affected = 00000040

Highest Port Affected = 0000005F

Real Time Clock = 010C20 (1:12:32 am: 01 = 1; 0C = 12; 20 = 32)

RLSS = 01010701

Card Type = 1F (4 Span E1 card)

Card State = 02 (Maintenance)

• Third report:

04 05060708 09101112 131415 16171819 20 21 82 00000060 0000007F 010C20 01010702 1E 02

Function ID = 82 (Card Status report)

Lowest Port Affected = 00000060

Highest Port Affected = 0000007F

Real Time Clock = 010C20 (1:12:32 am: 01 = 1; 0C = 12; 20 = 32)

RLSS = 01010702

Card Type = 1E (4 Span E1 card)

Card State = 02 (Maintenance)

Port Status ($83) Report

Report Type

System Status

Destination VCA

Same as Source VCA of command requesting this report.

Description

The Port Status ($83) report informs the host of the status of a range of ports. The command, for which the report is generated, forms the leading portion of the report. This leading portion is followed by a series of port status report elements, each of which is three bytes long. The first two bytes specify the port address; the third byte specifies the call processing status of the port.

If the port range for which the status report is requested is such that one $83 report cannot accommodate all the port status report elements, the report is split into as many $83 reports as necessary. Such fragments are distinguished from each other through a continuity bit.

Up to 30 port status report elements can be in one $83 report, considering that the maximum length of the report is 256 bytes.

Action Causing Report Generation

The Port Status ($83) command generates the $83 report. If the $83 command is successfully processed, the network status byte (NSB) is set to $01.

Format

Figure 5-4 shows the byte formatting for this report.

Table 5-4 lists the possible port call processing major states.

---

Note   If Range Specifier 2 is not present, the Report Element 1 starts at byte offset 10.

---

Table 5-5 lists the possible port call processing supplementary states.

Table 5-6 lists the possible port call processing major ISDN states.

Table 5-7 lists the possible port call processing supplementary ISDN states.

Example

The following command requests status reports for ports $27 and $28. The command specifies the range through port addresses.

Function ID = 83 - (Port Status command)

Access Code = 0000 1000 (C000 AGRS)

C = 0; A = 1 (Address Range specified); G = 0; R = 0;

Starting Port Address = $0027

Ending Port Address = $0028

The following report is generated for the above command:

Function ID = 83 (Port Status report)

Access Code = 08

0000 1000 (C000 AGRS)

C = 0 (Only fragment); A = 1 (Address Range specified);

G = 0; R = 0; S = 0;

Starting Port Address = 00000027 (Copied from command)

Ending Port Address = 00000028 (Copied from command)

Port Address = 00000027 (Report Element 1)

Port Status = 0D (CP_MBUSY)

Supplementary State = 02 (DIAG_PATH)

ISDN State = fd (Unknown)

ISDN Supplementary state (Unknown)

Port Address = 00000028 (Report Element 2)

Port Status = 00 (CP_IDLE)

Supplementary State = 00 (IDLE)

ISDN State = 00 (PT_ACTIVE)

ISDN Sub-state = 00 (ISDN Idle)

MF Digit ($D0) Report

Note   Unless otherwise stated, the MF processing described in this section applies to both MF and MFCR2 processing.

Report Type

Resource Control

Destination VCA

$40

Description

The MF Digit ($D0) report transfers MF digit collection information from the system to the host. The report indicates if the digit report is valid and the incoming port from which the digits were collected. If a collection error occurred, the present state of the Controlling Port (CP_SETUP or forced to idle) is also indicated. This report can be included as a report segment in an Inpulse Rule Complete ($DD) report.

The report indicates if garbled MF digits were detected by the receiver. A garbled MF digit is declared if one of the following conditions exists:

• Twist is greater than 8 dB.

• A single tone of the tone pair for all or part of the digit is present.

• More than two tones are present.

Action Causing Report Generation

The $D0 report is generated in direct response to an MF Collection Control command ($68), or as a result of inpulse rule processing. In MF processing, KP and ST are stripped from the digit report by the system. In MFCR2 processing, the system strips group I-15 digits from the digit report.

Format

Figure 5-5 shows the byte formatting for this report.

Examples

The following report shows an MF receiver port at address $34 used to collect three MF digits (1, 2, 3) from the incoming port at address $18. The "Enable Digit Field Reporting" feature has not been enabled.

Function ID = D0 (MF Digit)

Controlling Port Address = 00000018

Spacer Bytes = 0000

MF Receiver Address = 00000034

MF Status = 01

00000001

V = 0 (report not garbled)

S = 0 (no meaning since V and Y = 0)

X = 0 (MF receiver available on initial request)

Y = 0 (MF digit collection timer did not fire)

Z = 1 (valid MF digit string collected)

Field Designator = 12

Digit String = 3F (F marks end of string)

The following report shows the MF digit collection was aborted due to a timeout. The controlling port at address $021 was placed into CP_SETUP state to await further host action. No digits are reported.

Function ID = D0 (MF Digit)

Controlling Port Address = 00000021

Spacer Bytes = 0000

MF Receiver Address = 00000034

MF Status = 42

01000010

V = 0 (report not garbled)

S = 1 (Controlling Port in CP_SETUP due to collection timeout)

X = 0 (MF receiver available on initial request)

Y = 1 (MF digit collection timer fired)

Z = 0 (no valid MF digit string collected)

No digit string attached

DTMF Digit ($D1) (Standard) Report

Report Type

Resource Control

Destination VCA

$40

Description

The DTMF Digit ($D1) (Standard) report transfers DTMF/DP digit collection information from the system to the host. The report indicates whether the digit report is valid and the line or trunk from which the digits were collected. If a timeout occurs, any digits collected up to that point are returned. This report can also indicate if one of the following conditions occurred:

• Report is generated for first digit receipt

• Voice prompt being presented was aborted

• Timeout occurred while waiting for supervision

• Digit field overflow (for append of collected digits) occurred

• Receiver port was not available at first request (hunting only)

This report can be included as a report segment in an Inpulse Rule Complete ($DD) report.

Action Causing Report Generation

The $D1 (Standard) report is generated in direct response to a DTMF Collection Control ($67) command, or as a result of inpulse rule processing. No distinction is made between DTMF or DP digits. If first digit reporting was specified by the host in the $67 command, digit collection produces two reports. The first report indicates it is a first digit report and contains only one digit. The second report is a valid digit report with all collected digits, including the first digit that was previously reported.

An exception to first digit reporting is when the first digit entered is a single-digit end-of-string code ($F). In this case, the first digit report is returned with bit settings in the DTMF Status byte (offset 11) indicating a first digit report without a valid digit string (V = 1 and Z = 0).

Format

Figure 5-6 shows the byte formatting for this report.

Examples

The following report shows a DTMF receiver at address $52 collected seven DTMF digits (1, 2, 3, 4, 5, 6, 7) from the port at address $18. The "Enable Digit Field Reporting" feature has not been enabled.

Function ID = D1 (DTMF Digit, standard)

Controlling Port Address = 00000018

Report Status = 00

00000000

V = 0 (no voice prompt abort performed)

D = 0 (no outgoing detach performed)

T = 0 (no supervision timer fired)

A = 0 (no digit field overflow)

Supervision = 00 (supervision timer is not set in the $67 command or the timer did not fire)

DTMF Receiver Address = 00000052

DTMF Status = 01

00000001

T = 0 (interdigit timer did not fire)

V = 0 (not a first digit report)

W = 0 (DTMF receiver available on initial request)

X = 0 (DTMF digit collection timer did not fire)

Y = 0 (DTMF first-digit collection timer did not fire)

Z = 1 (DTMF digit string reported)

Digit String = 1234567F (F marks end of string).

The following report shows that a DTMF receiver at address $52 was enabled to collect digits from the port at address $18. One digit was received before the DTMF interdigit timer fired, so there is only one digit in this report. The "Enable Digit Field Reporting" feature has not been enabled.

Function ID = D1 (DTMF Digit, standard)

Controlling Port Address = 00000018

Report Status = 00

00000000

V = 0 (no voice prompt abort performed)

D = 0 (no outgoing detach performed)

T = 0 (no supervision timer fired)

A = 0 (no digit field overflow)

Supervision = 00 (supervision timer is not set in the $67 command or the timer did not fire)

DTMF Receiver Address = 00000052

DTMF Status = 41

01000001

T = 1 (interdigit timer fired)

V = 0 (not a first digit report)

W = 0 (DTMF receiver available on initial request)

X = 0 (DTMF digit collection timer did not fire)

Y = 0 (DTMF first-digit collection timer fired)

Z = 1 (DTMF digit string reported)

Digit String = 9F (F marks end of string)

The following report shows a DTMF receiver at address $35 has received the first digit of a string and is reporting it to the host. A voice prompt was aborted when the first digit was received. The "Enable Digit Field Reporting" feature has not been enabled.

Function ID = D1 (DTMF Digit, standard)

Controlling Port Address = 00000021

Report Status = 40

01000000

V = 1 (voice prompt aborted when first digit received)

D = 0 (no outgoing detach performed)

T = 0 (no supervision timer fired)

A = 0 (no digit field overflow)

Supervision = 00 (supervision timer is not set in the $67 command or a timer did not fire)

DTMF Receiver Address = 00000052

DTMF Status = 11.

00010001

T = 0 (interdigit timer fired)

V = 1 (first digit report)

W = 0 (DTMF receiver available on initial request)

X = 0 (DTMF digit collection timer did not fire)

Y = 0 (DTMF first-digit collection timer fired)

Z = 1 (DTMF digit string reported)

Digit String = 5F (F marks end of string)

DTMF Digit ($D1) (Enhanced) Report

Report Type

Resource Control

Destination VCA

$40

Description

The DTMF Digit ($D1) (Enhanced) report transfers DTMF/DP digit collection information from the system to the host. The report indicates if the digit report is valid and the line or trunk from which the digits were collected. If a timeout occurs, any digits collected up to that point are returned. This report can also indicate if one of the following conditions occurred:

• A report is generated for the first digit receipt.

• A voice prompt that was being presented was aborted.

• A timeout occurred while waiting for supervision.

• A digit field overflow (for append of collected digits) occurred.

• A receiver port was not available at first request (hunting only).

This report can be included as a report segment in an Inpulse Rule Complete ($DD) report.

Action Causing Report Generation

The $D1 (Enhanced) report is generated in direct response to the Enable Fourth Column DTMF system feature being enabled, or as a result of inpulse rule processing. No distinction is made between DTMF or DP digits. If first digit reporting was specified by the host in the DTMF Collection Control ($67) command, digit collection produces two reports: the first report indicates it is a first digit report and contains only one digit; the second is a valid digit report with all collected digits, including the first digit that was previously reported.

Format

Figure 5-7 shows the byte formatting for this report.

Examples

The following report shows that a DTMF receiver at address $52 collected seven DTMF digits (1, 2, 3, 4, 5, 6, 7) from the port at address $18. The "Enable Digit Field Reporting" feature has not been enabled.

Function ID = D1 (DTMF Digit)

Controlling Port Address = 00000018

Report Status = 00

00000000

V = 0 (no voice prompt abort performed)

D = 0 (no outgoing detach performed)

T = 0 (no supervision timer fired)

A = 0 (no digit field overflow)

Supervision = 00 (supervision timer is not set in $67 command or timer did not fire)

DTMF Receiver Address = 00000052

DTMF Status = 91

10000001

E = 1 (enhanced DTMF digit report)

T = 0 (interdigit timer did not fire)

V = 0 (not a first digit report)

W = 0 (DTMF receiver available on initial request)

X = 0 (DTMF digit collection timer did not fire)

Y = 0 (DTMF first-digit collection timer did not fire)

Z = 1 (DTMF digit string reported)

Number of Digits = 07

Digit String = 1234567 (0 marks end of byte).

The following report shows that a DTMF receiver at address $52 was enabled to collect digits from the port at address $18. One digit was received before the DTMF interdigit timer fired, so there is only one digit in this report. The "Enable Digit Field Reporting" feature has not been enabled.

Function ID = D1 (DTMF Digit)

Controlling Port Address = $0018

Report Status = 00

00000000

V = 0 (no voice prompt abort performed)

D = 0 (no outgoing detach performed)

T = 0 (no supervision timer fired)

A = 0 (no digit field overflow)

Supervision = 00 (supervision timer is not set in $67 command or timer did not fire)

DTMF Receiver Address = 00000052

DTMF Status = C1

11000001

E = 1 (enhanced DTMF digit report)

T = 1 (interdigit timer fired)

V = 0 (not a first digit report)

W = 0 (DTMF receiver available on initial request)

X = 0 (DTMF digit collection timer did not fire)

Y = 0 (DTMF first-digit collection timer fired)

Z = 1 (DTMF digit string reported)

Digit String = 9 (0 marks end of byte).

The following report shows that a DTMF receiver at address $35 has received the first digit of a string and is reporting it to the host. A voice prompt was aborted when the first digit was received. The "Enable Digit Field Reporting" feature has not been enabled.

Function ID = D1 (DTMF Digit)

Controlling Port Address = 00000021

Report Status = 40

01000000

V = 1 (voice prompt aborted when first digit received)

D = 0 (no outgoing detach performed)

T = 0 (no supervision timer fired)

A = 0 (no digit field overflow)

Supervision = 00 (supervision timer is not set in $67 command or timer did not fire)

DTMF Receiver Address = 00000052

DTMF Status = 91

10010001

E = 1 (enhanced DTMF digit report)

T = 0 (interdigit timer fired)

V = 1 (first digit report)

W = 0 (DTMF receiver available on initial request)

X = 0 (DTMF digit collection timer did not fire)

Y = 0 (DTMF first-digit collection timer fired)

Z = 1 (DTMF digit string reported)

Digit String = 5 (0 marks end of byte).

Permanent Signal Condition ($D2) Report

Report Type

Resource Control

Destination VCA

$44

Description

The Permanent Signal Condition ($D2) report informs the host that a line or trunk port has not released within 30 seconds of a release by the system. This report is also sent when a line/trunk that was in Permanent Signal Condition (PSC) goes back on hook.

Action Causing Report Generation

The $D2 report is generated if the system has tried to release a line/trunk and that port is still off hook after 30 seconds of inactivity. Generated with Permanent Signal Condition Code of $00 when line/trunk finally does release. When a port goes on hook, this report may be accompanied by an Incoming Port Change of State ($DB) or Outgoing Port Change of State ($DA) report, depending upon the settings in the Incoming Port Control ($6A) or Outgoing Port Control ($69) command used in the call. Refer to the "Outgoing Port Control ($69) Command" section and the "Incoming Port Control (Macro) ($6A) Command" section for more information.

PSC reports are never generated for ports with a Class of Service = A.

Format

Figure 5-8 shows the byte formatting for this report.

Examples

Assume an incoming port was linked to an outgoing port in Resource Group 5 and at address $0028. When the incoming port went back on hook to end the call, the outgoing port did not release within 30 seconds. The following report shows a Permanent Signal Condition for the outgoing trunk.

Function ID = D2 (Permanent Signal Condition)

Port Address = 00000028

Permanent Signal Condition Code = 81

10000001

A = 1 (other port on hook/hung up)

B = 0 (PSC not due to error)

C = 0 (host not responsible for PSC)

D = 0 (host command not responsible for PSC)

E = 0 (MF Receiver limitation not responsible for PSC)

F = 0 (System internal problem not responsible for PSC)

G = 0 (MF garbled digits/timeout not responsible for PSC)

H = 1 (PSC exists)

Resource Group = 0005

Real Time Clock = 121E00, which represents 6:30:00 p.m. ($12 = 18; $1E = 30; $00 = 00).

The following report indicates that the outgoing port in the above example has finally released, clearing the Permanent Signal Condition.

Function ID = D2 (Permanent Signal Condition)

Port Address = 00000028

Permanent Signal Condition Code = 01

00000001

A = 0 (PSC not due to on hook)

B = 0 (PSC not due to error)

C = 0 (host not responsible for PSC)

D = 0 (port not responsible for PSC)

E = 0 (MF Receiver limitation not responsible for PSC)

F = 0 (System internal problem not responsible for PSC)

G = 0 (MF garbled digits/timeout not responsible for PSC)

H = 1 (PSC cleared)

Resource Group = 0005

Real Time Clock = 122911, which represents 6:41:17 p.m. ($12 = 18; $29 = 41; $11 = 17).

System Port Status ($D3) Report

Report Type

System Status

Destination VCA

$40

Description

The System Port Status ($D3) report informs the host of an attempted change in the status of a system resource port. The change can be the result of the following:

• Activating or deactivating a port using the system administration Card Maintenance menu P command (refer to the Cisco VCO/4K System Administrator's Guide).

• Activating or deactivating a port using the Change Port Status ($90) command.

• Setting a voice path between ports using the system administration Set Up Paths screen and Port Reset screen (refer to the Cisco VCO/4K System Administrator's Guide).

• Detecting an inward seize for a port with COS = O or COS = 2 and internal COS = U; port is busied out by connected equipment.

• Using the Auto Makebusy feature; port is busied out after the specified number of supervision errors (1 to 255) have been detected for it (refer to the Cisco VCO/4K System Administrator's Guide).

Action Causing Report Generation

This report is generated when a change occurs in the operating status of an individual resource port on a system card. Status changes can be caused by an action at the system administrative console, an internally detected fault, or a host command.

A report indicating a port's availability may be returned from a card in Active, Maintenance, Diagnostic, or Maintenance Busy mode. When the card is in Standby mode or Out-of-Service, the port cannot be used for a call and no $D3 reports are generated for the port.

Any $D3 report generated for the first port on the DTG card will always indicate no status change (this port is not supported and remains deactivated at all times). Also, port status changes applied to DTG ports are only performed on the ports residing on the Active tone card. Although the ports on the Standby tone card are assigned the same logical addresses as the ports on the Active card, the $D3 report represents the status of the Active tone card port.

Format

Figure 5-9 shows the byte formatting for this report.

Examples

The following report indicates that the port at address $18, in resource group 3, is currently available due to a change originated by the system.

Function ID = D3 (System Port Status)

Old Status/New Status = 13

00010011

MMMM = 0001 (resource was unavailable)

NNNN = 0011 (resource currently on line and available)

Port Address = 00000018

Originator = 02 (port returned to service by the system)

Resource Group = 0003

Real Time Clock = 092312, which represents 9:35:18 am ($09 = 9; $23 = 35; $12 = 18).

The following report indicates that the port at address $21, in resource group 3, is currently unavailable because it has been busied out from the distant end.

Function ID = D3 (System Port Status)

Old Status/New Status = 31

00110001

MMMM = 0011 (resource was on line and available)

NNNN = 0001 (resource currently unavailable)

Port Address = 00000021

Originator = 32 (port busied out from distant end)

Resource Group = 0003

Real Time Clock = 0D2D00, which represents 1:45:00 pm ($0D = 13; $2D = 45; $00 = 00).

Routing Action ($D5) Report

Report Type

Resource Control

Destination VCA

$40

Description

The Routing Action ($D5) report notifies the host of routing actions performed by TeleRouter. This report is generated only when TeleRouter is functioning in the hosted configuration. It indicates the success or failure of the routing action, specifies the type of action performed, and identifies the two ports linked by the routing path.

Action Causing Report Generation

The $D5 report is generated in response to a digit-matching attempt by TeleRouter. Because digit-matching is initiated by a ROUTE [Tx] inpulse rule token, the $D5 report always follows an Inpulse Rule Complete ($DD) report. The $DD report indicates whether an inpulse rule or outpulse rule was executed as part of the routing action. This report allows the host the track resource allocation by specifying the incoming and outgoing resources linked by the routing action.

Format

Figure 5-10 shows the byte formatting for this report.

Status (byte offset 11)—Specifies successful completion of the routing action or the cause for failure. Corresponds to network status byte (NSB) values. Refer to Table 5-8 to interpret NSB values. Refer to "Network Status Byte Definitions," for additional NSB values and more detailed descriptions.

Outgoing Port Address (byte offsets 12 to 15)—Hexadecimal representation of the outgoing port address that was linked to the controlling port as a result of the routing action. These bytes will be $0000 when the Routing Action byte is set to $01, indicating that an inpulse rule was executed.

.

Examples

The following report indicates a successful routing action. The incoming port at address $0038 has been routed to the outgoing port at address $0045.

Function ID = D5 (Routing Action)

Incoming Port Address = $0038

Spacer Byte = $00

Routing Action = $00 (outpulse rule executed)

Status = $01 (routing action successful)

Outgoing Port Address = $0045

The following report indicates that TeleRouter executed an inpulse rule on the incoming port at port address $0038. The status byte indicates that the inpulse rule execution was successful although no actual routing was performed.

Function ID = D5 (Routing Action)

Incoming Port Address = $0038

Spacer Byte = $00

Routing Action = $01 (inpulse rule executed)

Status = $01 (action successful)

Outgoing Port Address = $0000 (no outgoing port involved in action)

Resource Limitation ($D6) Report

Report Type

System Status

Destination VCA

$44

Description

The Resource Limitation ($D6) Report is used to inform the host when a resource limitation condition has been detected or cleared. When the condition is detected, the system informs the host there are no units in a specific resource group available to satisfy an allocation request (a resource control command, inpulse rule, outpulse rule, etc.). This report is sent only the first time a limitation condition is detected for a resource group. No subsequent limitation condition reports are sent until after the condition has cleared. If the report is generated in response to a Resource Control command, the original command packet with the appropriate status ($1F in the network status byte) is returned.

For a resource limitation to clear, the system informs the host that resources in a group for which a $D6 report was generated have been successfully allocated for three consecutive requests.

Action Causing Report Generation

The $D6 report is generated for the first occurrence in a specific group until the condition clears. A limitation condition is declared in response to a host resource control command, inpulse rule processing, or outpulse rule processing when all resources of the type requested are busy or otherwise unavailable. Command must specify to hunt a resource group instead of requesting a specific port address.

For the Conference Control ($6D) command, this report is generated when all ports in the conference resource group are busy or unavailable.

For internal service circuits (DRCs, MRCs, DVCs, IPRCs, DCCs, and CPAs), if no group exists that contains the resource type requested, this report is not sent.

This report is also generated after three consecutive successful allocations from a resource group for which allocation attempts have previously failed.

Format

Figure 5-11 shows the byte formatting for this report.

Examples

The following report indicates that all ports in resource group 3 are unavailable. This report is sent the first time an allocation attempt fails for this group until the condition has cleared.

Function ID = D6 (Resource Limitation)

Condition = 80

10000000

A = 1 (limitation condition present)

Resource Group = 0003

GGGGGG = 000000 (resource group 3)

Requesting Port Address = 00000020

Real Time Clock = 0A2313—10:35:19 a.m. ($0A = 10; $23 = 35; $13 = 19).

The following report indicates that the limitation condition reported in Example 1 has cleared (three consecutive allocations from this group have been successfully performed).

Function ID = D6 (Resource Limitation)

Condition = 00

00000011

A = 0 (limitation condition cleared)

Resource Group = 0003

GGGGGG = 3 (resource group 3)

Requesting Port Address = 00000038

Real Time Clock = 0A3522—10:53:34 a.m. ($0A = 10; $35 = 53; $22 = 34).

System Card Status ($D9) Report

Report Type

System Status

Destination VCA

$40

Description

The System Card Status ($D9) report informs the host of a change in the status of a system resource card. The card location is represented both by the port address and the physical rack, level, and slot (R-L-S) address.

Action Causing Report Generation

The $D9 report is generated when a change occurs in the operating status of a system card. Status changes can be caused by an action at the System Administration Console, a host command, or physical removal and/or replacement of the card. The report is also sent for each card in the system as it comes on line after system boot.

For T1, the card is reported as on line when the carrier and remote carrier alarms clear. If either the carrier alarm or remote carrier alarm reoccurs, the card is reported as being off line.

For DVC, IPRC, and SRC, the card is reported as on line when the card download is complete.

Format

Figure 5-12 shows the byte formatting for this report.

Examples

The following report indicates the card at rack 1, level 1, slot 5 was taken out of service through a System Administration Console command.

Function ID = D9 (System Card Status)

Lowest Port Address Affected = 00000020

Highest Port Address Affected = 00000027

Status and Originator = 82

10000010

L = 1 (card off line)

D = 0 (card not deleted from database)

A = 0 (card not added to database)

S = 1 (system originated change)

H = 0 (host not responsible for change)

Real Time Clock = 010C20 (1:12:32 a.m. ($01 = 1; $0C = 12; $20 = 32))

Card State = 04 (card is out of service)

Rack-Level-Slot Code = 25

00100101

LLL = 001 (rack 1, level 1)

SSSSS = 5 (Slot 5)

The following report indicates the card at Rack/Cabinet 2, Level 0, Slot 20 was added to the system database but is still off line.

Function ID = D9 (System Card Status)

Lowest Port Address Affected = 00000018

Highest Port Address Affected = 0000001F

Status and Originator = A2

10100010

L = 1 (card off line)

D = 0 (card not deleted from database)

A = 1 (card added to database)

S = 1 (system originated change)

H = 0 (host not responsible for change)

Real Time Clock = 142D00 (8:45:00 p.m. ($14 = 20; $2D = 45; $00 = 00))

Card State = 04 (card out of service)

Rack-Level-Slot Code = 94

10010100

LLL = 100 (Rack/Cabinet 2, Level 0)

SSSSS = 20 (Slot 20)

Outgoing Port Change of State ($DA) Report

Note   Unless otherwise stated, the MF processing described in this section applies to both MF and MFCR2 processing.

Report Type

Resource Control

Destination VCA

$40

Definition

In MF processing, the Outgoing Port Change of State ($DA) report informs the host of a change in the hardware state of an outgoing system port. Note that in-band signaling is only detected during outpulse rule processing when a CPA port is attached. This report can also be issued to indicate an outpulse rule has successfully completed for the outgoing port.

Supervision errors are indicated by the appropriate value in the Change byte. The Change byte also indicates when a rehunt of an outgoing port is performed. When a rehunt occurs, the new outgoing port is indicated in byte offsets 19 to 22.

For the system to generate this report indicating outpulse rule completion, a REP END token must be contained in the outpulse rule.

In MFCR2 processing, this report indicates the final backward supervision tone detected to the host as part of the R2 signaling on outgoing trunks. This tone is indicated in the Answer Supervision Code (byte offset 16 and 17). Values of "33 xx" indicate the backward supervision tone, where "xx" indicates the Group-A or Group-B tone (tone meaning subject to context of call).

The supervision template (byte offset 18) indicates the number of the outpulse rule used during MFCR2 outpulsing.

Action Causing Report Generation

The $DA report is generated in response to a change in the hardware state of an outgoing port or the end of outpulse rule processing (REP END in an outpulse rule).

Format

Figure 5-13 shows the byte formatting for this report.

Table 5-9 describes the Standard Supervision Codes for MF/MFCR2 processing.

Table 5-10 describes the R2 backward signaling codes for MFCR2 processing.

Examples

The following report indicates that the outgoing port at address $35 and connected to the incoming port at address $20 has gone off hook. Answer supervision has been detected (SLIC, T1, E+M, or UTC only).

Function ID = DA (Outgoing Port Change of State)

Resource Group = 0004

Change = 80 (off hook)

Outgoing Port Address = 00000035

Incoming Port Address = 00000020

Answer Supervision Code = 3206 (true answer detected—answered with reversal)

Supervision Template = 00 (no answer supervision template used)

The following report indicates the outgoing port at address $35 that was connected to the incoming port at address $20 has gone on hook.

Function ID = DA (Outgoing Port Change of State)

Resource Group = 0004

Change = 40 (on hook)

Outgoing Port Address = 00000035

Incoming Port Address = 00000020

Answer Supervision Code = 0000 (because Change = $40)

Supervision Template = 00 (no answer supervision template used)

The following report indicates that a supervision error occurred on an outgoing port at address $35 that was being connected to the incoming port at address $20. The outgoing port ($35) is removed from the call and the incoming port ($20) is placed into CP_SETUP state (no rehunt performed). Answer Supervision Template #2 specifies detection of SIT tones as an error condition.

Function ID = DA (Outgoing Port Change of State)

Resource Group = 0004

Change = 20 (supervision error detected)

Outgoing Port Address = 00000035

Incoming Port Address = 00000020

Answer Supervision Code = 3105 (SIT tones detected)

Supervision Template = 02 (answer supervision template used)

The following report indicates that supervision was received outside of outpulse rule processing. The circuit at 00000035 is a T1 port.

Function ID = DA (Outgoing Port Change of State)

Resource Group = 0004

Change = 08 (supervision detected outside an outpulse rule)

Outgoing Port Address = 00000035

Incoming Port Address = 00000020

Answer Supervision Code = 3203 (wink detected)

Supervision Template = 00 (no answer supervision template used)

The following report indicates that a supervision error caused the system to rehunt to replace the outgoing port at address $035. The new outgoing port is supplied in the final two bytes.

Function ID = DA (Outgoing Port Change of State)

Resource Group = 0004

Change = 02 (outgoing rehunt performed; new outgoing port in final two bytes)

Outgoing Port Address = 00000035

Incoming Port Address = 00000020

Answer Supervision Code = 3101 (reorder tone detected)

Supervision Template = 00 (no answer supervision template used)

New Outgoing Port Address = 00000038

Incoming Port Change of State ($DB) Report

Report Type

Resource Control

Destination VCA

$40

Definition

The Incoming Change of State ($DB) report informs the host of a change in the hardware state of an incoming system port. It also indicates if an outpulse rule has been processed for the incoming port. This report can be included as a report segment in an Inpulse Rule Complete ($DD) report.

Action Causing Report Generation

The $DB report is generated in response to a change in the hardware state of an incoming port or completion of an outpulse rule.

Format

Figure 5-14 shows the byte formatting for this report.

Examples

The following report indicates that the port at address $20 has gone off hook.

Function ID = DB (Incoming Port Change of State)

Resource Group = 0004

Change = 80 (off hook)

Incoming Port Address = 00000020

Supervision Code = 0000

Supervision Template = 00 (no answer supervision template used)

The following report indicates the port at address $20 has gone on hook.

Function ID = DB (Incoming Port Change of State)

Resource Group = 0004

Change = 40 (on hook)

Incoming Port Address = 00000020

Supervision Code = 0000

Supervision Template = 00 (no answer supervision template used)

The following report indicates the system attempted to answer a nonringing incoming port. This port must be a UTC circuit (only UTC ports report this condition).

Function ID = DB (Incoming Port Change of State)

Resource Group = 0004

Change = 20 (supervision error)

Incoming Port Address = 00000020

Supervision Code = 3002

Supervision Template = 00 (no answer supervision template used)

The following report indicates that an outpulse rule has completed processing for the port at $0020. The outpulse rule included a REP END to generate this report.

Function ID = DB (Incoming Port Change of State)

Resource Group = 0004

Change = 04 (outpulse rule complete)

Incoming Port Address = 00000020

Supervision Code = 0500 (outpulse rule 5)

Supervision Template = 00 (no answer supervision template used)

Active/Standby Mode ($DC) Report

Report Type

Configuration Control

Destination VCA

$40

Description

The Active/Standby Mode ($DC) report informs the host of a system boot, system initialization, or transfer in control between the active and standby sides of a redundant system. It also reports when a link between the host and the system becomes established. In a redundant system, both the active and standby sides report a transfer.

Action Causing Report Generation

The $DC report is sent when the system boots, system initialization is complete, or when a transfer of control occurs. A transfer of control could be caused by a Change Active Controllers ($C0 01) command or an event internal to the system.

This report is also sent over a host-system link when that link becomes active. A report is sent by each link in the system. System reboot causes all links to reset.

Format

Figure 5-15 shows the byte formatting for this report.

Examples

The following reports indicate a system boot for a redundant system with a link on each side. When the system initially comes on line, the Alarm Arbiter Card (AAC) determines which processor is active (in this example, the A side). The first report shows the event from the A side, the second from the B side.

Event shown from the A side:

Function ID = DC (Active/Standby Mode)

Action Code = 10100001

R = 1 (system has booted or link is established)

I = 0 (report is a result of an event other than completed initialization)

E = 1 (extended operational mode)

S = 0 (report is from the A side)

M = 1 (reporting side is currently active)

Spacer Byte = 00 (no meaning)

Event shown from the B side:

Function ID = DC (Active/Standby Mode)

Action Code = 10100010

R = 1 (system has booted or link is established)

I = 0 (report is a result of an event other than completed initialization)

E = 1 (extended operational mode)

S = 1 (report is from the B side)

M = 0 (reporting side is currently standby)

Spacer Byte = 00 (no meaning)

The following reports reflect a change in active and standby sides initiated by host command or an action at the administrative console or Alarm Arbiter Card.

Event shown from the A side:

Function ID = DC (Active/Standby Mode)

Action Code = 00100000

R = 0 (run-time transfer)

I = 0 (report is a result of an event other than completed initialization)

E = 1 (extended operational mode)

S = 0 (report is from the A side)

M = 0 (reporting side is currently standby)

Spacer Byte = 00 (no meaning)

Event shown from the B side:

Function ID = DC (Active/Standby Mode)

Action Code = 00100011

R = 0 (run-time transfer)

I = 0 (report is a result of an event other than completed initialization)

E = 1 (extended operational mode)

S = 1 (report is from the B side)

M = 1 (reporting side is currently active)

Spacer Byte = 00 (no meaning)

The following reports indicate that one of the host-to-system links has just become active.

Note   This report is not interpreted as a system reboot when received from only one link.

Function ID = DC (Active/Standby Mode)

Action Code = 10000001

R = 1 (system has booted or link is established)

I = 0 (report is a result of an event other than completed initialization)

E = 0 (standard operational mode)

S = 0 (report is from the A side)

M = 1 (reporting side is currently active)

Spacer Byte = 00 (no meaning)

Inpulse Rule Complete (Macro) ($DD) Report

Report Type

Resource Control

Destination VCA

$40

Description

The Inpulse Rule Complete (Macro) ($DD) report informs the host that an inpulse rule has been processed. The content of the report is controlled by the type of reporting specified in the inpulse rule. If REP EACH is specified, the report will indicate only that inpulse rule processing has ended. If REP END is specified, the report is a macro containing Resource Control reports (segments) to represent all actions taken during inpulse rule execution. Resource report segments included in the macro can include:

• Incoming Port Change of State ($DB)

• DTMF Digit ($D1)

• MF Digit ($D0)

Segments are reported in the following order:

• Incoming Port Change of State ($DB)

• Digit report for field 1

• Digit report for field 2

• Digit report for field 3

• Digit report for field 4

• Digit report for field ANI (originating number field)

Digit segments follow the general format for their report, but the Controlling Port Address and Spacer bytes are omitted in MF collections, and the Controlling Port Address, Report Status and Supervision bytes are omitted in DTMF collections. Incoming Port Change of State segments contain only the Function ID and Change Code.

Action Causing Report Generation

This report is generated when inpulse rule processing is terminated. Termination can be caused by: the successful completion of the rule; an error in rule processing; a looping rule which only contains setup to reporting tokens; a host command overriding the rule; or by the controlling port going on hook.

Format

Figure 5-16 shows the byte formatting for this report.

Examples

The following report indicates that inpulse rule 3 was executed on the incoming port at address $28. Three MF digits (1, 2, 3) and seven DTMF digits were collected (1, 2, 3, 4, 5, 6, 7).

Function ID = DD (Inpulse Rule Complete)

Controlling Port Address = 00000028

Spacer Bytes = 0000

Segment Control = 02

00000010

A = 0 (inpulse rule processed for incoming port)

NNN = 2 (2 segments attached)

Rule Status = 00

00000000

A = 0 (voice port available on initial request)

S = 0 (inpulse rule processing completed normally)

T = 0 (rule not aborted due to Outpulse Channel exhaust condition)

Inpulse Rule = 0003

Segment 1 is as follows:

Function ID = D0 (MF Digit)

Controlling Port Address = omitted

Spacer Bytes = omitted

MF Receiver Address = 00000034

MF Status = 01

00000001

V = 0 (report not garbled)

S = 0 (no meaning since V and Y = 0)

X = 0 (MF receiver available on initial request)

Y = 0 (MF digit collection timer did not fire)

Z = 1 (valid MF digit string collected)

Digit String = 123F (F marks end of string)

End of segment 1.

Segment 2 is as follows:

Function ID = D1 (DTMF Digit)

Controlling Port Address = omitted

Report Status = omitted

Supervision = omitted

DTMF Receiver Address = 00000052

DTMF Status = 01

00000001

E = 0 (report follows the old style report format)

T = 0 (interdigit timer did not fire)

V = 0 (not a first digit report)

W = 0 (DTMF receiver available on initial request)

X = 0 (DTMF digit collection timer did not fire)

Y = 0 (DTMF first-digit collection timer did not fire)

Z = 1 (DTMF digit string reported)

Digit String = 1234567F (F marks end of string)

End of segment 2.

The following report indicates that the incoming port at address $35 went off hook and executed inpulse rule 16. During the execution of that rule, the system made two attempts before allocating a voice port (processing a SPEAK token). Three DTMF digits (4, 4, 2) were collected.

Function ID = DD (Inpulse Rule Complete)

Controlling Port Address = 00000035

Spacer Bytes = 0000

Segment Control = 02

00000010

A = 0 (inpulse rule processed for incoming port)

NNN = 2 (2 segments attached)

Rule Status = 80

10000000

A = 1 (voice port is not available on initial request)

S = 0 (inpulse rule processing has completed normally)

T = 0 (rule not aborted due to Outpulse Channel exhaust condition)

Inpulse Rule = 0010 (decimal 16)

Segment 1 is as follows:

Function ID = DB (Incoming Port Change of State)

Resource Group = omitted

Change = 80 (off hook)

Incoming Port Address = omitted

Supervision Code = omitted

End of segment 1.

Segment 2 is as follows:

Function ID = D1 (DTMF Digit)

Controlling Port Address = omitted

Report Status = omitted

Supervision = omitted

DTMF Receiver Address = 00000035 (SLIC, DID, or UTC port with onboard receiver)

DTMF Status = 05

00000101

E = 0 (report follows the old style report format)

T = 0 (interdigit timer did not fire)

V = 0 (not a first digit report)

W = 0 (DTMF receiver available on initial request)

X = 1 (DTMF digit collection timer fired

Y = 0 (DTMF first-digit collection timer did not fire)

Z = 1 (DTMF digit string reported)

Digit String = 442F (F marks end of string)

End of segment 2

Voice Port Status ($DE) Report

Report Type

Resource Control

Destination VCA

$40

Description

The Voice Port Status ($DE) report indicates when all voice prompts specified in a Voice Port Control ($6C) command have completed. This reporting is controlled by a bit setting in the $6C command.

Action Causing Report Generation

The report is generated when all voice prompts specified in a $6C command have completed if specified in the command.

Format

Figure 5-17 shows the byte formatting for this report.

Example

A $6C command specified to present five voice prompts and report to the host upon completion. The report below shows that all specified prompts have been presented.

Function ID = DE (Voice Port Status)

Controlling Port Address = 00000042

Spacer Bytes = 0000

Voice Port Address = 00000056

Status = 10 (all prompts presented).

ISDN Port Change of State ($EA) Report

Note   For a description of the known functional constraints for this report, refer to the VCO/4K System Software Version 5.n(n) Release Notes.

Report Type

Resource Control

Destination VCA

$40

Definition

Use the ISDN Port Change of State ($EA) report to inform the host of the following Integrated Services Digital Network (ISDN) call scenarios:

• A change in the state of an ISDN call.

• A failed call attempt due to a resource limitation.

Both the controlling and associated ports are represented. The port can be represented by B-channel, or by D-channel and Call ID.

In interworking scenarios, a pair of reports is produced when a port change of state affects both an ISDN port and a non-ISDN port. A non-ISDN port can be either the controlling port or the associated port. If the port is non-ISDN, the appropriate Incoming ($DB) or Outgoing ($DA) Port Change of State report is generated. Refer to the "Outgoing Port Change of State ($DA) Report" section and the "Incoming Port Change of State ($DB) Report" section for information on the $DA and $DB reports. Use the $EA report for ISDN-related events only.

The $EA report may be truncated if the network header segment, base report, and information elements exceed 255 bytes in length. No indication of truncation is provided to the host.

Action Causing Report Generation

This report is generated in response to a change in the state of an ISDN call or B-channel.

Format

Figure 5-18 shows the byte formatting for this report.

Function ID (byte offset 4)—Byte immediately following the Network Header; uniquely identifies the report from the system.

Controlling Port Address (byte offsets 5 to 8)—Hexadecimal representation of the controlling port circuit address for which the report is sent. If the Controlling Address Identifier (byte offset 11) is $01, these bytes represent the specific B-channel assigned to the call or a non-ISDN port. If the Controlling Address Identifier is $02, these bytes represent the D-channel; the Controlling Call ID is identified in byte offsets 9 and 10.

Controlling Call ID (byte offsets 9 and 10)—Specifies the ISDN Call ID for the controlling port. Use Call ID only when the controlling port is specified by the D-channel. You must set the Controlling Address Identifier (byte offset 11) to $02.

Controlling Address Identifier (byte offset 11)—Specifies whether the controlling port is identified by D-channel and Call ID or by B-channel/non-ISDN port address. Interpret the byte as follows:

01—Controlling port specified by B-channel or non-ISDN port address; Controlling Call ID = 00 00 for non-ISDN port address.

02—Controlling port specified by D-channel and Call ID.

Associated Port Address (byte offsets 12 to 15)—Hexadecimal representation of the report's associated (outgoing) port circuit address. If the Associated Address Identifier (byte offset 18) is $01, these bytes represent the specific B-channel used. If the Associated Address Identifier is $02, these bytes represent the D-channel and Call ID.

Associated Call ID (byte offsets 16 and 17)—Specifies the ISDN Call ID for the associated (outgoing) port.

Associated Address Identifier (byte offset 18)—Specifies whether the associated (outgoing) port is identified by D-channel or by B-channel/non-ISDN port/resource group. Interpret the byte as follows:

00—No associated port.

01—Associated port specified by B-channel or non-ISDN port address; Call ID = 00 00 for non-ISDN port address.

02—Associated port specified by D-channel.

Change (byte offset 19)—Specifies the type of change detected. The following list indicates the change that occurred for the outgoing port:

00—No change; report was issued to report an ISDN D-channel message (contained in Event byte).

01—Call attempt failed (FAIL token in the ISDN supervision template or ISDN protocol violation).

02—Reserved for future enhancements.

04—Outpulse rule processing has completed for this port; rule number specified in byte offsets 23 and 24 (REP END in outpulse rule).

05— Quit token processed in an ISDN supervision template.

08—Supervision detected outside of a rule.

10—Supervision detected during rule processing (REP, OKREP, ANSREP, or PRPREP token in an ISDN supervision template).

20— Supervision error detected (ERROR token in an ISDN supervision template).

40— Port became inactive.

60—VCO/4K system software is unable to process a D-channel Setup request due to congestion. Refer to the Information Elements segment (byte offsets 31 to n) to determine the reason this congestion notification was received by the host.

80—Port became active (SETUP received and processed or REP, OKREP, ANSREP, or PRPREP token present in an ISDN supervision template).

Event Code (byte offset 20)—Specifies the D-channel message received. Codeset 0 Q.931 message coding is used for all event codes. Interpret the bytes as follows:

00—Failed call attempt (error in template processing or no D-channel message processed).

01—ALERTING message was received.

02—CALL PROCEEDING message was received.

03—PROGRESS message was received.

05—SETUP message was received.

07—CONNECT message was received.

0C—SETUP ACKNOWLEDGE message was received.

0F—CONNECT ACKNOWLEDGE message was received.

20—USER INFORMATION message was received.

45— DISCONNECT message was received.

46—RESTART message was received.

4D—RELEASE message was received.

5A—RELEASE COMPLETE message was received.

6A—FACILITY ACKNOWLEDGE message was received.

6E—NOTIFY message was received.

---

Note   If the system receives a NOTIFY message from the network and the ISDN state is ACTIVE (10), the system passes the NOTIFY message to the host in bytes 26 through n. In all other states, the system ignores NOTIFY messages from the network.

---

72—FACILITY REJECT message was received.

79—CONGESTION message was received.

FF—Timeout (in ISDN supervision template processing).

Supervision Template (byte offset 21)—Specifies whether the outgoing port is considered answered (ANS condition token processed in ISDN Supervision Template) and the number of the ISDN Supervision Template used. If no ISDN Supervision Template is being used, or call failures and errors occur, set the byte to 00. Convert the byte from hexadecimal to binary and interpret the bits as follows:

A0NNNNNN

A—Indicates whether or not the associated (outgoing) port is considered answered.

A = 0—Outgoing port is not considered answered.

A = 1—Outgoing port is considered answered.

NNNNNN—Specifies the ISDN Supervision Template used. Convert from binary to decimal for the template number.

Status Code (byte offset 22)—Indicates if an error was encountered. Interpret the byte as follows:

01—No error.

80—Inpulse rule processing was aborted.

81—RELEASE message was received over the D-channel; call has been abandoned.

82—RELEASE message was transmitted over the D-channel; call could not be processed.

83—B-channel is unavailable.

86—Not all requested information elements were present in the D-channel message.

87—Looping inpulse rule was detected; rule processing aborted.

88—B-channel is in wrong call processing state for the requested action.

89—DTMF collection failure or timeout.

8A—MF collection failure or timeout.

8B—D-channel failure.

8C—Glare condition was detected; outgoing port has released; incoming port is in CP_SETUP state.

8F—Report has been truncated; report and information elements have exceeded 255 bytes.

90—Digit collection timeout.

91— No digit collection mode chosen in rule; digit collection failure.

A1—Host SETUP Timer fired; call has been cleared.

A2—Card or port is in maintenance mode; call has been cleared.

A3—Looping outpulse rule was detected; rule processing aborted.

A4—ISDN protocol violation.

C1—MF receiver was unavailable.

C2—DTMF receiver was unavailable.

C4—CPA port was unavailable.

C5—Outpulse channel was unavailable.

C6— DVC was unavailable.

C7— MFCR2 was unavailable.

Rule Code (byte offsets 23 and 24)—For Change = 04, indicates the number of the outpulse rule processed. Otherwise, this byte is 00.

Call Reference Number (byte offsets 25 and 26)—Indicates a call reference number that is reported to the host; call references are numbered sequentially.

---

Note   Set the Enable Host Call Reference feature flag to Y in the System Features administration screen when using the Call Reference Number bytes to enable the reporting of a call reference number to the host. Refer to the Cisco VCO/4K System Administrator's Guide for further information on the Enable Host Call Reference feature and feature flag setting instructions.

---

Optional Data (byte offsets 27 to 29)—Reserved for future enhancements.

Information Element Code (byte offset 30)—Indicates the number of IEs included in this report. IE reporting is controlled by ISDN Message Templates. A value of $00 indicates that no IEs follow this byte. IEs are reported exactly as they were received from the D-channel.

Information Elements (byte offset 31 to n)—This segment contains information elements which indicate one of the following:

• If the Change segment (byte offset 26) equals 60, these bytes contain a value which describes a reason that the VCO/4K system software is unable to process a D-channel setup request. Possible values are as follows:

  • A2—No circuit/channel available (preferred B-channel was not available).

  • AF—Resources unavailable, uspecified (internal memory exhausted).

  • AA—Switching equipment congestion (limbo port exhausted).

  • AC—Requested circuit/channel not available (exclusive channel not available).

  • C2—Channel type not implemented (Layer 3 protocol error).

• If the Information Element Code (byte offset 30) is greater than 00, these bytes contain any IEs received over the specified D-channel. Each IE has either a multibyte or a single-byte format. Figure 5-19 shows the multibyte format and Figure 5-20 shows the single byte format.

---

Note   Single-byte IEs have bit 8 set to 1.

---

ISDN Inpulse Rule Complete ($ED) Report

Report Type

Resource Control

Destination VCA

$40

Description

Use the ISDN Inpulse Rule Complete ($ED) report to inform the host that an inpulse rule has been processed either in response to a SETUP message received over the D-channel or for a specific B-channel. Digits collected in-band can also be included in this report. The content of the report is controlled by the type of reporting you specify in the inpulse rule and in the ISDN Receive Message Template. Information included in this report can include:

• DTMF Digit ($D1)

• MF Digit ($D0)

• Received information elements (IEs)

Received IEs are reported in the same format as they were received.

Digit segments are presented in the following order:

1. Digit report for field 1

2. Digit report for field 2

3. Digit report for field 3

4. Digit report for field 4

5. Digit report for field ANI (originating number field)

Action Causing Report Generation

This report is generated when inpulse rule processing is terminated. Termination can be caused by:

• Successful completion of the rule

• An error in rule processing

• A looping rule which only contains setup and reporting tokens

• A host command overriding the rule

• The controlling port being released

Format

Figure 5-21 shows the byte formatting for this report.

IEs (byte offset m + 3 - x)—For IE Code > 00, these bytes contain any IEs received over the specified D-channel. Each IE has either a multibyte or a single-byte format. Figure 5-22 shows the multibyte format and Figure 5-23 shows the single-byte format.

---

Note   Single-byte IEs have bit 8 set to 1.

---

Alarm Condition ($F0) Report

Report Type

System Status

Destination VCA

$44

Description

The Alarm Condition ($F0) report indicates the presence or clearance of a system alarm. Additionally, alarm severity and the number of occurrences is reported.

Action Causing Report Generation

The report is generated upon alarm detection (any occurrence), severity change, or clearance. Additionally, an alarm is set or cleared for:

• A host link (including the TeleRouter overlay); the additional data identifies the host link as defined from the system administration Host Configuration screen.

• A port interface or service circuit card; the additional data identifies the card's Rack-Level-Slot position.

Because multiple occurrences of one card alarm are normal during system initialization, reports of card alarms that were set during system initialization do not supply a card's physical location. Similar alarms are reported in one $F0 report; the number of occurrences reflects the number of cards for which the alarm was detected. When a card becomes active, an $F0 report is generated; use the additional data bytes to indicate the Rack, Level, Slot location, and the span number.

The "No Alarm Reports During System Initialization" feature lets you enable/disable Disable Alarm Reporting during system initialization. Y disables system alarm reports until the system comes into service; N enables the system alarm reports. Access the System Feature Configuration screen from the Main menu.

From the System Feature Configuration screen, define the alarm severity for the No Hosts alarm ($0B) as either Major or Fatal. If the Fatal Alarm for No Hosts feature = Y, all failed host links cause the affected system controller to reset after system initialization.

Format

Figure 5-24 shows the byte formatting for this report.

Alarm Code (byte offset 5)—Identifies the reported alarm. The system alarms, their meanings, and severity levels are described in Table 5-11. For more information on system alarms, refer to the Maintenance chapter of the Cisco VCO/4K System Administrator's Guide and the Cisco VCO/4K System Messages.

Additional Data Bytes (byte offsets 9 to 12)—Supplies additional information for the following alarm codes. Additional information bytes are not supplied for alarms set during system initialization processing. Refer to the "Action Causing Report Generation" section.

If byte offset 5 = 0A—Use byte offset 9 to indicate the host for which the alarm is being reported. In this case, possible values for byte offset 9 are as follows:

00—TeleRouter overlay.

08 to F—Host links configured from the Host Configuration screen. Refer to the Cisco VCO/4K System Administrator's Guide for more information.

If byte offset 5 = 26 to 2D, 33, or 34—Use byte offsets 9 to 12 to indicate the Rack-Level-Slot location, and the span number of the card for which the report is generated. Convert bytes from hexadecimal to decimal for the physical location.

If byte offset 5 = 4C—The length of the $F0 report is truncated to nine byte offsets and byte offset 9 indicates the reason that the incoming timing source changed to internal clock timing. Possible values of byte offset 9, and their associated meanings, are as follows:

01—T1 card Slip Maintenance reached report was received.

02—PRI card Slip Maintenance reached report was received.

03—T1 card OOF condition present report was received.

04—PRI card OOF condition present report was received.

05—T1 card Loss of Carrier condition report was received.

06—PRI card Loss of Carrier condition report was received.

07—T1 card Remote Carrier Alarm Detected report was received.

08—PRI card Remote Carrier Alarm Detected report was received.

09—T1 card Signaling bit alarm report was received.

0A—T1 card OOF Maintenance Limit reached report was received.

0B—PRI card OOF Maintenance Limit reached report was received.

0C—NBC loss of synchronization—external reference.

0D—Change in T1 synchronization source. Host sent T1 Synchronization Control ($C0 02) command.

0E—NBC incoming reference signal is not present.

0F—NBC loss of synchronization—incoming reference.

10—NBC loss of incoming reference.

11—NBC external reference signal is not present.

12—NBC cannot synchronize on the external reference.

13—NBC cannot synchronize on the incoming reference.

14—ICC hardware change has been detected. Possibilities include the insertion or removal of an I/O module, or a mismatch between hardware type and configuration.

Note   Byte 12 is optional and is used for multispan cards only.

Examples

At system initialization, the following report is generated to indicate a card alarm set for 20 T1 cards as part of normal processing. This reporting assumes the No Alarm Reports During System Initialization feature is disabled (set to N).

Function ID = F0 (Alarm Condition)

Alarm Code = 27 (ALM039: PRI/T1/E1 Carrier Lost)

Severity = 05 (Major)

Occurrences = 14 (20 occurrences)

Occurrence Severity = 05 (Major)

No Additional Data Bytes.

The following report indicates the T1 card located at the R-L-S position 1, 2, 21 comes into service following system initialization (card out of service condition is cleared). The location is indicated in the additional data bytes.

Function ID = F0 (Alarm Condition)

Alarm Code = 27 (ALM039: PRI/T1/E1 Carrier Loss)

Severity = 00 (Alarm Cleared)

Occurrences = 01 (1 occurrence)

Occurrence Severity = 00 (Alarm Cleared)

Additional Data Bytes = 01 02 15 (1, 2, 21).

Posted: Fri Aug 9 11:40:45 PDT 2002
All contents are Copyright © 1992--2002 Cisco Systems, Inc. All rights reserved.
Important Notices and Privacy Statement.