PPL Table Download 0x00D6

SwitchKit Name

PPLTableDownload

Type

EXS API and SwitchKit API message

Description

Use this message to download PPL tables that are subsequently used to create a PPL protocol.

Before using this message, the host must first establish the table to be downloaded using the PPL Table Initiate Download message. The PPL Table Download message is then used to pass the table data to the Excel platform.

If the table data exceeds the maximum length allowed for one message, you will have to use more than one of these messages. You must send them sequentially because the Excel platform maintains the offset into the table on successive commands.

Sent by

Host

SwitchKit Code

C Structure

typedef struct {

unsigned short ComponentID;

UBYTE TableType;

UBYTE TableID;

UBYTE Data[249];

} XL_PPLTableDownload;

C Structure Response

typedef struct {

unsigned short Status;

UBYTE DataSize;

UBYTE ErrorType;

UBYTE Data[250];

} XL_PPLTableDownloadAck;

C++ Class

class XLC_PPLTableDownload : public XLC_OutboundMessage {

public:

unsigned short getComponentID() const;

void setComponentID(unsigned short x);

UBYTE getTableType() const;

void setTableType(UBYTE x);

UBYTE getTableID() const;

void setTableID(UBYTE x);

const UBYTE *getData() const;

UBYTE *getData();

void setData(UBYTE *x);

};

C++ Class Response

class XLC_PPLTableDownloadAck : public XLC_AcknowledgeMessage {

public:

unsigned short getStatus() const;

void setStatus(unsigned short x);

UBYTE getDataSize() const;

void setDataSize(UBYTE x);

UBYTE getErrorType() const ;

void setErrorType(UBYTE x);

const UBYTE *getData() const;

UBYTE *getData();

void setData(UBYTE *x);

};

EXS API Hex Format

Primitive Table Format (0x01)

A Primitive Table is a set of primitives used in conjunction with a State/Event Table to create a PPL protocol. Each Primitive Table can contain up to 400 primitives. The Primitive Table is assigned to the protocol when the protocol is created with the PPL Create message.

The Primitive Table format is shown in the table below.

Basic State/Event Table Format (0x02)

A Basic State/Event table is a group of valid events that pertain to a given state, the primitives that get invoked upon the occurrence the event, and the next state to transition into in response to the event(s). State/event tables allow for up to 100 states and up to 20 events per state. The Primitive Table is assigned to the protocol when the protocol is created with the PPL Create message.

The Basic State/Event Table format is shown in the table below.

Route Table (0x03)

The Route Table format is shown in the table below.

Route Criteria Type entries

0x0007 Incoming Span/Channel, Single/Range

0x0009 Terminating Span/Channel, Single/Range

0x0010 Incoming Resource Group, Single/Range

0x0015 Terminating Resource Group, Single/Range

0x0065 Physical VoIP Channel

0x0071 Virtual VoIP Channel

0x03E9 User-defined

NOTE: See Notes 1, 2 and 3 below to configure the following Route Criteria Type entries.

0x2710 Universal Protocol Data, Single/Range

0x2717 Called Party Number, Single/Range

0x2718 Calling Party Number, Single/Range

0x2792 Source IP Address, Single/Range

0x2794 Destination IP Address, Single/Range

0x27B0 RTP Payload Type, Single/Range

0x27B4 IP Address Criteria, Single/Range

0x2919 NPDI SIP to Username, Single/Range

0x291A NPDI SIP to Hostname, Single/Range

0x2919 NPDI SIP from Username, Single/Range

0x291A NPDI SIP from Hostname, Single/Range

0x2A0E Media Connection Address, Single/Range

Notes

1. The second data format field that occurs after the length can have the following values:

• 0x01 - Data in Raw Hex Bytes

• 0x02 - ASCII Characters

• 0x03 - BCD (all digit-based routes are BCD)

• 0x04 - Decimal

2. The length of the this field is variable. It is equal to the Criteria Length minus the length of the Criteria Header information (for example, all fields after the length and not including the digits and mask fields) divided by the number of digits and mask fields included.

Below is an example of how the Single bit in the Route Property Mask is set (see field 15 in Route Table (0x03) above).

To compute the Length of Field which is equal to 7, do the following:

Criteria Length (20) subtract (-) Length of Criteria Header (6) and divide (/) by number of Digit and Mask fields (2)

2a 0e \ ' Media Connection Criteria Type

03 \' Criteria Data Format: BCD

00 14 \ ' Length

03 \ 'Criteria Data Format: BCD

63 \ ' Offset

00 00 00 00 \ ' Reserved - set to 0x00 0x00 0x00 0x00

04 05 05 06 06 07 08 \ ' Digits string

0f 0f 0f 0f 0f 0f 0f \ ' Mask

Below is an example of how the Range bit in the Route Property Mask is set (see field 15 in Route Table (0x03) above).

To compute the Length of Field which is equal to 1, do the following:

Criteria Length (9) subtract (-) Length of Criteria Header (6) and divide (/) by number of Digit and Mask fields (3)

2a 0e \ ' Media Connection Criteria Type

01 \ ' Criteria Data Format

00 09 \ ' Length

04 \ ' Criteria Data Format: Decimal

2c \ ' Offset

00 00 00 00 \ ' Reserved

0a \ ' From digits

cd \ ' To digits

ff \ ' Mask

3. The Offset field represents the number of channels to offset outgoing channel from incoming channel.

Route Entry TLV Type entries

0x0009 Address Element Blocks

0x0015 Resource Group ID

0x0062 Resource Group Reorder Method

0x0063 Route Number

0x001B Resource Table ID

0x001C Route Table ID

0x0161 PAD Values

0x03E9 User-defined

Resource Group Table (0x04)

The format of the Resource Group Table is shown in the table below.

Extended State/Event Table Format (0x07)

An Extended State/Event table is a group of valid events that pertain to a given state, the primitives that get invoked upon the occurrence the event, and the next state to transition into in response to the event(s). State/event tables allow for up to 100 states and up to 20 events per state. The Primitive Table is assigned to the protocol when the protocol is created with the PPL Create message.

The Extended State/Event Table format is shown in the table below.