SS7 Signaling Route Configure 0x005F

You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > SS7 Signaling Route Configure 0x005F

SwitchKit Name

SS7SignalingRouteConfig

Type

EXS API and SwitchKit API message

Description

This message allows the host to assign or to deconfigure a signaling route to reach a specific DPC. Each assigned route to a DPC is given an associated priority route selection in the presence of multiple available routes for a DPC.

Sent by

Host

SwitchKit Code

Configuration

SS7SignalingRouteConfig (

Node = integer,

StackID = integer,

Destination = integer,

RouteID = integer,

DPC = integer,

LinkSetID = integer,

Priority = integer,

CombinedLinkSetRef = integer);

C Structure

typedef struct {

UBYTE StackID;

unsigned short Destination;

unsigned short RouteID;

int DPC;

UBYTE LinkSetID;

UBYTE Priority;

unsigned short CombinedLinkSetRef;

} XL_SS7SignalingRouteConfig;

C++ Class

class XLC_SS7SignalingRouteConfig : public XLC_OutboundMessage {

public:

UBYTE getStackID() const;

void setStackID(UBYTE x);

unsigned short getDestination() const;

void setDestination(unsigned short x);

unsigned short getRouteID() const;

void setRouteID(unsigned short x);

int getDPC() const;

void setDPC(int x);

UBYTE getLinkSetID() const;

void setLinkSetID(UBYTE x);

UBYTE getPriority() const;

void setPriority(UBYTE x);

unsigned short getCombinedLinkSetRef() const;

void setCombinedLinkSetRef(unsigned short x);

EXS API Hex Format

MESSAGE (White)		RESPONSE (Gray)
Byte	Field Description	Byte	Field Description
0	Frame (0xFE)	0	Frame (0xFE)
1, 2	Length (0x00NN)	1, 2	Length (0x0007)
3, 4	Message Type (0x005F)	3, 4	Message Type (0x005F)
5	Reserved (0x00)	5	Reserved (0x00)
6	Sequence Number	6	Same Sequence Number
7	Logical Node ID	7	Logical Node ID
8	AIB Address Method 0x00 - Individual AEs	8	Status (MSB, LSB) The meaning of these fields depends upon the value of the Entity field in the message. If the MSB of the Status field is 0x01 (NACK), the LSB indicates the NACK reason. 0x01 SS7 invalid combined linkset reference. The Route ID given as the reference is not configured.
	AIB Address Method 0x00 - Individual AEs	9	Checksum
	Number of AEs to follow
	AEs 0x20 SS7 Destination/Route Note: After you issue the first SS7 Signaling Route Configure message for a DPC, all subsequent SS7 Signaling Route Configure messages must use the same Destination ID within the AE for additional routes to the same DPC. (There is a unique association between DPC and an assigned Destination ID.)
:	DPC (four bytes) Every point code in the API messages will always be 4 bytes long with the first byte (MSB) as zero. See the SS7 section of the API Developer's Guide: CCS for an explanation of how to convert the 4 bytes into ITU and ANSI point codes. 0x00000000–0x00FFFFFF The DPC must be in this range for signaling stacks using 24-bit point codes (for example, ANSI). 0x0000000–0x00003FFF The DPC must be in this range for signaling stacks using 14-bit point codes (for example, ITU). 0xFFFFFFFF Indicates de-assignment of the specified destination and all routes to the specified destination. This is the only method that can be used to de-assign a destination. If using the BT IUP protocol, the maximum range for a DPC is 14 bits.
:	Link Set ID The Link Set that carries traffic for this route (0x00 – 0x1F). If the DPC field is not 0xFFFFFFFF, a value of 0xFF in this field indicates de-configuration of the specified route.
:	Priority Signaling traffic is routed over available link sets according to the priority established by the host (0x00 is the lowest priority and 0x23 is the highest priority). Link sets with the same priority to a destination load share traffic as a combination link set.
:	Combined Linkset Reference Indicates that the route being configured and the route given in the reference are both part of a combined linkset. Data [0-1] Route ID is given as "Combined LinkSet Reference". Note: The route that has already been configured becomes the Combined LinkSet Reference. Also, if there are n routes already configured as a combined linkset to a destination, then the route for the same combined linkset can be configured by giving any of the n-route IDs as a Combined Linkset Reference.
:	Checksum