System Configuration Query 0x00B4

You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > System Configuration Query 0x00B4

System Configuration Query 0x00B4

SwitchKit Name

SystemConfigQuery

Type

EXS API and SwitchKit API message

Description

Use this message to query various configuration settings in the Excel platform. Some query results are reported in the response to the message, while others generate a Generic Report message.

The data for the following Query Types is returned in the response:

• 0x02 - Message Resend Logic

• 0x03 - Host Link Failure Detection Logic

• 0x04 - Active Conference IDs

• 0x06 - System Busy Warning

The data for the following Query Types is returned in the Generic Report message:

• 0x05 - Channel State

• 0x07 - Resource Threshold

• 0x09 - Resource Usage Reporting

• 0x0B - Approaching Busy Threshold for Slots

• 0x0C - Real Busy Threshold for Slots

• 0x10 - Detailed Conference Information

• 0x11 - DSP Resource Threshold

• 0x13 - Conference Speakers

• 0x14 - Conferencing Features

• 0x15 - Child Conference Information

• 0x16 - Child Conference IDs

For SwitchKit

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

Sent by

Host Application

SwitchKit Code

C Structure

typedef struct {

UBYTE AddrInfo[30];

UBYTE QueryType;

UBYTE Data;

UBYTE reserved49[221];

} XL_SystemConfigQuery;

C Structure Response

typedef struct {

unsigned short Status;

UBYTE reserved6[13];

UBYTE AddrInfo[30];

UBYTE QueryType;

UBYTE Data[220];

} XL_SystemConfigQueryAck;

C++ Class

class XLC_SystemConfigQuery : public XLC_OutboundMessage

{

public:

const UBYTE *getAddrInfo() const;

UBYTE *getAddrInfo();

void setAddrInfo(UBYTE *x);

XBYTE getStartSpan() const;

void setStartSpan(XBYTE x);

UBYTE getStartChannel() const;

void setStartChannel(UBYTE x);

XBYTE getEndSpan() const;

void setEndSpan(XBYTE x);

UBYTE getEndChannel() const;

void setEndChannel(UBYTE x);

XBYTE getConferenceID() const;

void setConferenceID(XBYTE x);

XBYTE getParentConferenceID() const;

void setParentConferenceID(XBYTE x);

XBYTE getChildConferenceID() const;

void setChildConferenceID(XBYTE x);

UBYTE getSlot() const;

void setSlot(UBYTE x)

UBYTE getQueryType() const;

void setQueryType(UBYTE x);

UBYTE *getData() const ;

void setData(UBYTE *x) ;

};

C++ Class Response

class XLC_SystemConfigQueryAck : public

XLC_AcknowledgeMessage {

public:

unsigned short getStatus() const;

void setStatus(unsigned short x);

const UBYTE *getAddrInfo() const;

UBYTE *getAddrInfo();

void setAddrInfo(UBYTE *x);

XBYTE getStartSpan() const;

void setStartSpan(XBYTE x);

UBYTE getStartChannel() const;

void setStartChannel(UBYTE x);

XBYTE getEndSpan() const;

void setEndSpan(XBYTE x);

UBYTE getEndChannel() const;

void setEndChannel(UBYTE x);

XBYTE getConferenceID() const;

void setConferenceID(XBYTE x);

XBYTE getParentConferenceID() const;

void setParentConferenceID(XBYTE x);

XBYTE getChildConferenceID() const;

void setChildConferenceID(XBYTE x);

UBYTE getSlot() const;

void setSlot(UBYTE x);

UBYTE getQueryType() const;

void setQueryType(UBYTE x);

const UBYTE *getData() const;

UBYTE *getData();

void setData(UBYTE *x);

};

EXS API Hex Format

MESSAGE (White)		RESPONSE (Gray)
Byte	Field Description	Byte	Field Description
0	Frame (0xFE)	0	Frame (0xFE)
1, 2	Length (0xNNNN)	1, 2	Length (0xNNNN)
3, 4	Message Type (0x00B4)	3, 4	Message Type (0x00B4)
5	Reserved (0x00)	5	Reserved (0x00)
6	Sequence Number	6	Same Sequence Number
7	Logical Node ID	7	Logical Node ID
7	Logical Node ID	8, 9	Status MSB, LSB
8	AIB 0x00 - Individual AEs 0x01 - Range Depending on Query Type		Data The values in the Response’s Data fields depend on the value of the Query Type field. There is no response data for the following Query Types. The data for these queries is returned in the Generic Report message. 0x05 - Channel State 0x07 - Resource Threshold 0x09 - Resource Usage Reporting 0x0B - Approaching Busy Threshold for Slots 0x0C - Real Busy Threshold for Slots 0x10 - Detailed Conference Information 0x11 - DSP Resource Threshold 0x13 - Conference Speakers 0x14 - Conferencing Features 0x15 - Child Conference Information 0x16 - Child Conference IDs (data also returned in this message)
	Number of AEs to follow
	AEs The Address Element used depends on the Query Type, as follows:
	0x02 Message Resend Logic 0x00 00 00 00 Null
	0x03 Host Link Failure Detection Logic 0x00 00 00 00 Null
	0x04 Active Conference IDs 0x00 00 00 00 Null
	0x05 Channel State 0x0D Channel (A) 0x0D Channel (B) (For one channel enter same channel in both AEs).
	0x06 System Busy Warning 0x00 00 00 00 Null
	0x07 Resource Threshold 0x00 00 00 00 Null		0x02 Message Resend Logic Data[0] Resend once 0x00 Disabled 0x01 Enabled 0x02 Enable and Generate Alarm message Data[1] Resend Until Acknowledged 0x03 Resend Alarm, Alarm Cleared, Request for Service, Request for Service with Data, and Channel Release until acknowledged by the host. 0x04 Do not resend messages in option 0x03 until acknowledged by the host (this option cancels option 0x03)
	0x09 Resource Usage Reporting 0x00 00 00 00 Null
	0x0B Approaching Busy Threshold for Slots 0x01 Slot
	0x0C Real Busy Threshold for Slots 0x01 Slot
	0x10 Detailed Conference Information 0x55 Conference ID
	0x11 DSP Resource Threshold 0x01 Slot
	0x13 Conference Speakers 0x55 Conference ID
	0x14 Conferencing Features 0x0D Channel (2 AEs with same Channel) or 0x55 Conference ID or 0x45 Child Conference ID
	0x15 Child Conference Information 0x45 Child Conference ID
	0x16 Child Conference IDs 0x55 Conference ID (Parent)
	Query Type 0x00 Reserved 0x01 Reserved 0x02 Message Resend Logic 0x03 Host Link Failure Detection Logic 0x04 Active Conference IDs 0x05 Channel State 0x06 System Busy Warning 0x07 Resource Threshold 0x09 Resource Usage Reporting 0x0B Approaching Busy Threshold for Slots 0x0C Real Busy Threshold for Slots 0x10 Detailed Conference Information 0x11 DSP Resource Threshold 0x13 Conference Speakers 0x14 Conferencing Features 0x15 Child Conference Information 0x16 Child Conference IDs		0x03 Host Link Failure Detection Logic Data[0] Feature Enabled/Disabled 0x00 Disable 0x01 Enable Data[1] Response to Host Link Failure Bit 0 Setting of spans and channels 0 All channels out of service when host link failure detected (Default) * 1 All spans and channels out of service when host link failure detected Bit 1 Setting of response 0 A response is sent 1 No response is not sent Bit 2 Setting of SCCP/TCAP OOS 0 SCCP/TCAP is not taken out-of-service 1 SCCP/TCAP is taken out-of-service Data[2, 3] Failure Detection Timer 10 ms units (cannot be less than 30,000 ms.)
:	Data Resource Threshold (0x07) Resource Type DSP Resource Threshold (0x011) Function Type For all other Query Types, the Data field does not apply.







:	Checksum

			0x04 Active Conference IDs Data[0, 1] Number of Conference IDs in use. The Conference IDs are reported in the Generic Report message. Up to 50 IDs can be reported per message. Therefore, 51-100 Conference IDs would result in two separate Generic Report messages. If no Conference IDs are in use, the Generic Report message is not sent).
			0x06 System Busy Warning Data[0] Sensitivity Level 0x00 Least Sensitive 0x01 : 0x02 : 0x03 : 0x04 Most Sensitive Data[1] System Busy Warning 0x00 Disabled 0x01 Enabled
			0x16 Child Conference IDs Data [0,1] Number of Child Conference IDs for a particular parent Conference. (The Child Conference IDs are reported in the Generic Report message. Up to 50 Child Conference IDs can be reported per message. Therefore, 51-63 Child Conference IDs would result in two separate Generic Report messages. If no Child Conference Ids are in use for particular parent conference, the Generic Report message is not sent).
		:	Checksum