# Using ThroughPacket OAM board keywords

To use TPKT endpoints on a particular CG board, you must specify appropriate parameters in the board's OAM API keyword file. These parameters specify the following:

- TPKT DLM file to load to the CG board.

- Data transmission parameters for TPKT endpoints created on the board.

After setting the TPKT and DLM file keywords, boot the board with an OAM utility such as oamsys for the parameters to take effect. For more information about oamsys, refer to the Dialogic® NaturalAccess™ OAM System Developer’s Manual.

This topic describes TPKT keywords and provides an example of ThroughPacket keywords implemented in an OAM API board keyword file.

## ThroughPacket resource (DLM) file

CG boards that support TPKT endpoints need to include a downloadable module (DLM) file for performing ThroughPacket processing. Load the TPKT DLM file (cg6ktpkt.dlm) by referencing the TPKT DLM in the CG board's keyword file.

The following three files must be referenced (in a DLMFile string) in the CG board keyword file for boards that use ThroughPacket:

################################################################
# DOWNLOADABLE RUNTIME MODULES
DLMFile[0] = cg6krun
DLMFile[1] = cg6kFusion
DLMFile[2] = cg6ktpkt
################################################################

## TPKT data transmission parameters

In addition to a TPKT DLM file reference, boards that support TPKT endpoints must include TPKT data transmission parameters in their board keyword files. The following TPKT keywords define the way the CG board transfers data from TPKT endpoints:

Keyword | Minimum | Maximum | Description
TPKT.Enable | NA | NA | Enables (value = 1) or disables (value = 0) ThroughPacket support.
TPKT.SimpleRxPort | 1024 | 65535 | UDP port number to receive simple packets.
TPKT.SimpleTxPort | 1024 | 65535 | UDP port number to transmit simple packets.
TPKT.ComplexRxPort | 1024 | 65535 | UDP Port to receive complex packets.
TPKT.ComplexTxPort | 1024 | 65535 | UDP Port to transmit complex packets.
TPKT.NumberOfComplexForwardConditions | 1 | 8 | Number of conditions set for ThroughPacket transmission.
TPKT.ComplexForward.Count | 8 | 8 | Number of ThroughPacket transmission conditions defined for the system. Always set this keyword to 8 (that is, you must always define eight conditions, although some conditions can be set to NULL).
TPKT.ComplexForward[0].LifeTimeTicks | 0 | 99 | Number of timer ticks (in 10 ms increments) before a ThroughPacket packet can be sent out.
TPKT.ComplexForward[0].DestinationPacketSize | 1 | 1440 | Threshold value indicating the number of bytes that must be accumulated in the packet payload before the packet can be sent out.

For more information about OAM ThroughPacket keywords, refer to the CG board manual.

## Example

The following example shows keywords used to configure TPKT endpoint data transmission parameters for a CG board used by a Fusion gateway:

TPKT.Enable = 1
TPKT.SimplexRxPort = 49152
TPKT.SimplexTxPort = 49152
TPKT.ComplexRxPort = 49153
TPKT.ComplexTxPort = 49153
TPKT.NumberOfComplexForwardConditions = 4
TPKT.ComplexForward.Count = 8
TPKT.ComplexForward[0].LifeTimeTicks = 0
TPKT.ComplexForward[0].DestinationPacketSize = 1440
TPKT.ComplexForward[1].LifeTimeTicks = 1
TPKT.ComplexForward[1].DestinationPacketSize = 980
TPKT.ComplexForward[2].LifeTimeTicks = 2
TPKT.ComplexForward[2].DestinationPacketSize = 700
TPKT.ComplexForward[3].LifeTimeTicks = 3
TPKT.ComplexForward[3].DestinationPacketSize = 1
TPKT.ComplexForward[4].LifeTimeTicks = 0
TPKT.ComplexForward[4].DestinationPacketSize = 0
TPKT.ComplexForward[5].LifeTimeTicks = 0
TPKT.ComplexForward[5].DestinationPacketSize = 0
TPKT.ComplexForward[6].LifeTimeTicks = 0
TPKT.ComplexForward[6].DestinationPacketSize = 0
TPKT.ComplexForward[7].LifeTimeTicks = 0
TPKT.ComplexForward[7].DestinationPacketSize = 0

If none of the TPKT.ComplexForward.LifeTimeTicks keywords is set to 0, the default maximum payload size is automatically set to 1440.