Generic Report 0x0046

SwitchKit Name

GenericReport

Type

EXS API and SwitchKit API message

Description

This message is generated in response to the following Query Types sent in the System Configuration Query message:

• 0x04 - Active Conference IDs

• 0x05 - Channel State

• 0x0A - Resource Usage

• 0x0B - DS3 Trunk MIB Report

• 0x10 - Detailed Conference Information

• 0x13 - Conference Speakers

• 0x14 - Conferencing Features

• 0x15 - Child Conference Information

• 0x16 - Child Conference IDs

 

NOTE: The AIB and Number of Resources fields apply only if the Report Type field is Resource Usage (0x0A)

In SwitchKit

If you want to get this report, you must register for it by calling the sk_msgRegister function with the parameter, SK_RESOURCE_UTIL_REPORT.

Sent by

Excel platform

Example Message (Socket Log Output for SwitchKit)

In the following socket log output/example message, the Generic Report contains resource usage data for Slot 9.

 

00 63 00 46 00 00 ff 0a 00 01 01 01 09 04 00 26 03 01 02 00

02 48 c0 00 00 01 c0 03 00 02 63 00 00 00 00 00 05 00

05 9e 00 00 03 26 00 05 00 08 8c 00 00 00 04 00 01 01

00 02 08 00 00 f4 84 01 00 5c 05 03 20 00 00 f4 84 09

00 5c 05 01 00 11 02 00 05 03 00 0f 04 01 30 05 00 34

06 00 47 07 00 26 32 04 3d

 

Switchkit Code

C Structure

typedef struct {

UBYTE ReportType;

UBYTE Data[252];

} XL_GenericReport;

C++ Class

class XLC_GenericReport : public XLC_InboundMessage {

public:

UBYTE getReportType() const;

void setReportType(UBYTE x);

const UBYTE *getData() const;

UBYTE *getData();

void setData(UBYTE *x);

};

Overview of message

The following table provides an overview of this message. The table following it provides the detail for each byte.

MESSAGE (White)

RESPONSE (Gray)

Byte

Field Description

Byte

Field Description

0

Frame (0xFE)

0

Frame (0xFE)

1, 2

Length (0x00NN)

1, 2

Length (0x0005)

3, 4

Message Type (0x0046)

3, 4

Message Type (0x0046)

5

Reserved (0x00)

5

Reserved (0x00)

6

Sequence Number

6

Same Sequence Number

7

Logical Node ID

7

Logical Node ID

8

Checksum

8

Report Type

NOTE: The AIB and Number of Resources fields apply only if the Report Type is 0x0A.

:

AIB (Individual AEs)

0x01 Slot

:

Number of Resources

:

Data [0]

:

:

:

Checksum

 

EXS API Hex Format - Detailed

MESSAGE (White)

RESPONSE (Gray)

Byte

Field Description

Byte

Field Description

0

Frame (0xFE)

0

Frame (0xFE)

1, 2

Length (0xNNNN)

1, 2

Length (0x0005)

3, 4

Message Type (0x0046)

3, 4

Message Type (0x0046)

5

Reserved (0x00)

5

Reserved (0x00)

6

Sequence Number

6

Same Sequence Number

7

Logical Node ID

7

Logical Node ID

8

Checksum

8

Report Type

0x04 - Active Conference IDs

0x05 - Channel State

0x0A - Resource Usage

0x0B - DS3 Trunk MIB Report

0x10 - Detailed Conference Information

0x13 - Conference Speakers

0x14 - Conferencing Features Configuration

0x15 - Child Conference Information

0x16 - Child Conference IDs

NOTE: The AIB and Number of Resources fields apply only if the Report Type is Resource Usage (0x0A).

:

AIB

Address Method

0x00 - Individual AEs

Number of AEs to follow

AE

0x01 Slot

:

Number of Resources

:

Data

The data depends upon the Report Type


0x04 Active Conference IDs

Data[0,1] Number of conference IDs to report (up to 50 per message)

Data[2,3] First Conference ID

Data[4,5] Second Conference ID

: :

 

0x05 Channel State

Data 0–6 is an AIB indicating the first channel to be reported:

Data[0] Address Method (0x00) Individual AEs

Data[1] Number of Address Elements (0x01)

Data[2] Address Type (0x0D, Channel)

Data[3] Data Length (0x03)

Data[4] Logical Span ID, MSB

Data[5] Logical Span ID, LSB

Data[6] Channel

Data[7] Number of channels reported (1-32)

Data[8] First channel’s current L4 state. (Repeated for each channel.)

The following are Layer 4 state values:
0x00 Out-of-Service

0x01 Incoming Call

0x02 Wait For CSA in Incoming Call State

0x03 In Service Idle

0x04 Incoming Call, Wait for L5

0x05 Outgoing Call, L3 Outseize Wait

0x06 Wait For CSA in Incoming Call Wait for Host State

0x07 Answered

0x08 L4 Clear ACK Wait, L3 Disconnect Received

0x09 L3 Clear Wait

0x0A Busied out

0x0B Outgoing Call Cut-thru

0x0C Wait for CSA in Incoming Alerted State

0x0D Wait for CSA in Incoming in Answered State

0x0E Incoming Call Alerted

0x0F L3 Clear Wait

0x10 Wait for CSA in Outgoing Cut-thru

0x11 Wait for CSA in Outgoing Alerted State

0x12 L4 Clear ACK Wait, L3 Clear Received

0x13 Outgoing Call Alerted

0x14 L4 Clear ACK Wait, L5 Clear Received

0x15 L5 Release Wait

0x16 Incoming Call, L4 Clear ACK Wait (Park Processing)

0x17 Incoming Call Alerted, L4 Clear ACK Wait (Park Processing)

0x18 Answered, L4 Clear ACK Wait (Park Processing)

0x19 Outgoing Alerted, L4 Clear ACK Wait (Park Processing)

0x1A Outgoing Cut-thru, L4 Clear ACK Wait (Park Processing)

0x1B Wait for CSA (Call Service Ack) for Internal Routing

 

Data[9] First channel’s current L3 state as viewed by L4
(Repeated for each channel.)

The following are the Layer 3 state values relevant to Layer 4:

0x00 Out-of-Service

0x01 In Service

0x02 Maintenance

0x03 In Service Blocked

0x04 Unblocked

 

: :

 

0x0A Resource Usage

Resource ID 0x00 Memory

Data[0] Length

Data[1] Number of regions configured on the card

Data[2] Number of partitions configured on the card

Data[3] Region ID of Nth region

Data[4-7] Size of the region in bytes

Data[8-11] Number of bytes used from the region

Data [12] Partition ID of Nth partition

Data[13-16] Size of the partition in bytes

Data[17-20] Used bytes of partition

:

 

Data[:] Region ID of Nth region(1 byte)
Data[:] Size of the Nth region in bytes (4 bytes)
Data[:] Number of bytes used from the Nth region(4 bytes)
Data [:] Partition ID of 1st partition (1 byte)
Data[:] Size of the 1st partition in bytes (4 bytes)
Data[:] Used bytes of 1st partition (4 bytes)
:
Data [:] Partition ID of Nth partition (1 byte)
Data[:] Size of the Nth partition in bytes (4 bytes)
Data[:] Used bytes of Nth partition (4 bytes)

 

Resource ID 0x01 MCB

Data[0] Length

Data[0] Message buffer usage

 

Resource ID 0x02 CPU Usage Level 1

Data[0] Length

Data[1-4] Time in milliseconds covering this report

Data[5] Number of tasks reported

Data[6] Logical task ID (idle task only 0x00)

Data[7] Percentage of time usage for task (integer part)

Data[8] Percentage of time usage for task (decimal part)

 

Resource ID 0x03 CPU Usage Level 2

Data[0] Length

Data[1-4] Time in milliseconds covering this report

Data[5] Number of tasks reported

Data[6] Logical task ID

Data[7] Percentage of time usage for task (integer part)

Data[8] Percentage of time usage for task (decimal part

 

0x0B DS3 Trunk MIB Report Type

Data 0-5 is an AIB:

Data[0] Address Method (0x00)

Data[1] Number of Address Elements (0x01)

Data[2] Address Type (0x32)

Data[3] Data Length (0x02)

Data[4] Slot Number

Data[5] DS3 Offset

 

Data[6] Alarm Status

A bit mask indicating what alarm is being sent and received on the DS3:

Bit 0: Receiving Red
Bit 1: Receiving RAI
Bit 2: Receiving Loss of Signal (LOS)
Bit 3: Receiving Out of Frame (OOF)
Bit 4: Receiving AIS
Bit 5: Sending AIS
Bit 6: Sending RAI
Bit 7: Reserved


Data[7-10] Code Violations – Near End – Line (CV-L)

Data[11–14] Errored Seconds – Near End – Line (ES-L)

Seconds containing one or more BPVs or EXZs defects.
Data[15–18] Severely Errored Seconds – Near End - Line (SES-L)

Seconds during which BPVs plus EXZs exceed 44.
Data[19–22] Code Violations – Near End – Path (CVP-P)

Data[23–26] Errored Seconds – Near End – Path (ESP-P)

Seconds containing one or more p-bit parity errors or SEF defects
Data[27–30] Severely Errored Seconds – Near End -Path (SESP-P)

Seconds during which p-bit parity errors exceed 44 or one or more SEF
defects

Data[31-34] Unavailable Seconds – Near End - Path (UASP-P)

Data[35–38] Code Violations – Near End - Path (CVCP-P)

Data[39–42] Errored Seconds – Near End – Path (ESCP-P)

Seconds containing one or more c-bit parity errors or SEF defects.
Data[43–46] Severely Errored Seconds – Near End - Path (SESCP-P)

Seconds during which c-bit parity errors exceed 44 or one or more SEF
defects.

Data[47-50] Unavailable Seconds – Near End - Path (UASCP-P)

Data[51–54] SEF/AIS Seconds – Near End –Path (SAS-P)

Seconds containing one or more SEF defects.

Data[55–58] Code Violations – Far End – Path (CVCP-PFE)

Data[59-62] Errored Seconds – Far End – Path (ESCP-PFE)

Data[63-66] Severely Errored Seconds – Far End - Path (SESCP-PFE)

Data[67-70] Unavailable Seconds – Far End – Path (UASCP-PFE)

Data[71-74] SEF/AIS Seconds – Far End – Path (SASCP-PFE)

Data[75-78] Time Elapsed since the counters were last cleared

Data[79-82] Interval Number (number of reports sent including this one)

 

0x10 Detailed Conference Information

Data[0,1] Conference ID

Data[2] Number of Channel Block's

Data[3] Block Number

Data[4] Node ID

Data[5] DSP Card Slot

Data[6] Module ID

Data[7] DSP Number

Data[8] Conference Number

Data[9] Conference Type

Data[10] Broadcast Enabled

Data[11, 12] Number of Channels Allocated

Data[13,14] Total Number of participant's

Data[15] Tone Attached

Data[16,17] Tone ID

Data[18] VRA Attached

Data[19] Marked for Deletion

Data[20] Recording

Data[21-32] Spare Bytes

Data[33,34] Number of Participant's in block

Data[35,36] Logical Span for Participant Number 1

Data[37] Logical Chan for Participant Number 1

Data[38] 1 or 2 legs for participant Number 1

Data[39,40] Logical Span for Participant Number 2

Data[41] Logical Chan for Participant Number 2

Data[42] 1 or 2 legs for participant Number 2

Data[… ] Continue with a list of span's and channels

Data[159,160] Logical Span for Participant Number 32

Data[161] Logical Chan for Participant Number 32

Data[162] 1 or 2 legs for participant Number 32

 

0x13 Conference Speakers (Parent Conference)

Data[0-5] Conference ID AIB

Data[6, 7] Speaker #1 Span

Data[8] Speaker #1 Channel

Data[9] Speaker #1 Average Signal Magnitude

Data[10-13] Speaker #1 Active Speaking Time (5 ms increments)

Data[14, 15] Speaker #2 Span

Data[16] Speaker #2 Channel

Data[17] Speaker #2 Average Signal Magnitude

Data[18-21] Speaker #2 Active Speaking Time (5 ms increments)

Data[22, 23] Speaker #3 Span

Data[24] Speaker #3 Channel

Data[25] Speaker #3 Average Signal Magnitude

Data[26-29] Speaker #3 Active Speaking Time (5 ms increments)

 

 

0x13 Conference Speakers (Child Conference)

 

If conference speaker information is queried for child conference, the report data will be in the following format.

Data[0-7] Child Conference ID AIB

Data[8-9] Speaker #1 Span

Data[10] Speaker #1 Chan

Data[11] Speaker #1 Energy Level (dBm)

Data[12-15] Speaker #1 Active Speaking Time

Data[16-17] Speaker #2 Span

Data[18] Speaker #2 Chan

Data[19] Speaker #1 Energy Level (dBm)

Data[20-23] Speaker #2 Active Speaking Time

Data[24-25] Speaker #3 Span

Data[26] Speaker #3 Chan

Data[27] Speaker #1 Energy Level (dBm)

Data[28-31] Speaker #3 Active Speaking Time

 

 

0x14 Conferencing Features (Parent Conference)

 

If a conference ID is queried, the Report data is in the following format:

 

Data[0-5] Conference ID AIB

Data[6-7] DTMF Clamping Enabled

Data[8-9] Output Gain

Data[10-11] Noise Gating Enabled

Data[12-13] Noise Gating Time Constant

Data[14-15] Max Noise Level

Data[16-17] Noise Gating Sensitivity

Data[18-19] Echo Suppression Enable

Data[20-21] Echo Return Loss

Data[22-23] AGC Enable

Data[24-25] AGC Input Level

Data[26-27] AGC Time Constant

Data[28-29] Conference Failure Behavior

 

If a channel is queried the Report data is in the following format:

Data[0-6] Channel AIB

Data[7-8] DTMF Clamping Enabled

Data[9-10] Output Gain

Data[11-12] Noise Gating Enabled

Data[13-14] Noise Gating Time Constant

Data[15-16] Max Noise Level

Data[17-18] Noise Gating Sensitivity

Data[19-20] Echo Suppression Enable

Data[21-22] Echo Return Loss

Data[23-24] AGC Enable

Data[25-26] AGC Input Level

Data[27-28] AGC Time Constant

Data[29-30] Conference Failure Behavior

Data[31-32] Channel Input Gain

 

0x14 Conferencing Features (Child Conference)

 

If parameters are queried for child conference, the report data will be in the following format.

Data[0-7] Child Conference ID AIB

Data[8-9] DTMF Clamping Enabled

Data[10-11] Output Gain

Data[12-13] Noise Gating Enabled

Data[14-15] Noise Gating Time Constant

Data[16-17] Max Noise Level

Data[18-19] Noise Gating Sensitivity

Data[20-21] Echo Suppression Enable

Data[22-23] Echo Return Loss

Data[24-25] AGC Enable

Data[26-27] AGC Input Level

Data[28-29] AGC Time Constant

Data[30-31] Conference Failure Behavior

 

If parameters are queried for a particular channel connected to a conference/child conference, the report data will be in the following format.

Data[0-6] Channel AIB

Data[7-8] DTMF Clamping Enabled

Data[9-10] Output Gain

Data[11-12] Noise Gating Enabled

Data[13-14] Noise Gating Time Constant

Data[15-16] Max Noise Level

Data[17-18] Noise Gating Sensitivity

Data[19-20] Echo Suppression Enable

Data[21-22] Echo Return Loss

Data[23-24] AGC Enable

Data[25-26] AGC Input Level

Data[27-28] AGC Time Constant

Data[29-30] Conference Failure Behavior

Data[31-32] Channel Input Gain

 

0x15 Detailed Child Conference Information

 

Data[0-1] Parent Conference ID

Data[2-3] Child Conference ID

Data[4] Number of Channel Blocks

Data[5] Block Number

Data[6] Node ID

Data[7] DSP Card Slot

Data[8] Module ID

Data[9] DSP Number

Data[10] Conference Number

Data[11] Conference Type

Data[12] Broadcast Enabled

Data[13-14] Number of Channels Allocated

Data[15-16] Total number of participants

Data[17] Tone attached

Data[18,19] Tone ID

Data[20] VRA Attached

Data[21] Marked for Deletion

Data[22] Recording

Data[23-34] Spare Bytes

Data[35-36] Number of Participants in Block

Data[37-38] Logical Span for Participant #1

Data[39] Logical Chan for Participant #1

Data[40] 1 or 2 legs for Participant #1

. .

. .

. .

 

Data[161-162] Logical Span for Participant #32

Data[163] Logical Chan for Participant #32

Data[164] 1 or 2 legs for Participant #32

 

 

(0x16) Child Conference IDs Information Report type

 

Data[0-5] Conference ID AIB

Data[6-7] Number of child conferences Ids to

report (Up to 50 per message)

Data[8-9] First Child Conference ID

Data[10-11] Second Child Conference ID

Data[12-13] Third Child Conference ID

. .

Data[106-107] Fiftieth Child Conference ID

:

Checksum