SS7 TUP Message Format Configure 0x008F

You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > SS7 TUP Message Format Configure 0x008F

SwitchKit Name

SS7TUPMessageFormatConfig

Type

EXS API and SwitchKit API message

Description

This message allows the host to modify the format of a TUP message in the TUP Message Configuration template. The template of each message is used to format outgoing messages and to interpret incoming messages.

You can use up to a maximum of eight mandatory fields and 12 optional fields per message. You can use a maximum of eight subfields per field.

Use the SS7 TUP Message Query message to retrieve the currently configured format of a TUP message.

Sent by

Host

SwitchKit Code

Configuration

SS7TUPMessageFormatConfig (

Node = integer,

StackID = integer,

TUPMessageIndex = integer,

MCTEntry = integer,

H0Length = integer,

H0Value = integer,

H1Length = integer,

H1Value = integer,

MsgAttributes = integer,

Data = byte array);

C Structure

typedef struct {

UBYTE StackID;

UBYTE TUPMessageIndex;

UBYTE MCTEntry;

UBYTE H0Length;

UBYTE H0Value;

UBYTE H1Length;

UBYTE H1Value;

unsigned short MsgAttributes;

UBYTE Data[215];

} XL_SS7TUPMessageFormatConfig;

C++ Class

class XLC_SS7TUPMessageFormatConfig : public XLC_OutboundMessage {

public:

UBYTE getStackID() const;

void setStackID(UBYTE x);

UBYTE getTUPMessageIndex() const;

void setTUPMessageIndex(UBYTE x);

UBYTE getMCTEntry() const;

void setMCTEntry(UBYTE x);

UBYTE getH0Length() const;

void setH0Length(UBYTE x);

UBYTE getH0Value() const;

void setH0Value(UBYTE x);

UBYTE getH1Length() const;

void setH1Length(UBYTE x);

UBYTE getH1Value() const;

void setH1Value(UBYTE x);

unsigned short getMsgAttributes() const;

void setMsgAttributes(unsigned short x);

const UBYTE *getData() const;

UBYTE *getData();

void setData(UBYTE *x);

};

EXS API Hex Format

NOTE: Modifying the format of a TUP message may also require modifying its Field[m] – ID through Subfield[s] – Maximum Length, LSB are repeated for each mandatory field. Likewise, Field[o] – ID through Subfield[s] – Maximum Length, LSB) are repeated for each optional field.
Each mandatory and optional field can have a variable number of subfields. For example, Mandatory Field[0] can have 3 subfields, Mandatory Field[1] can have two subfields, and Optional Field[0] can have 4 subfields.

MESSAGE (White)		RESPONSE (Gray)
Byte	Field Description	Byte	Field Description
0	Frame (0xFE)	0	Frame (0xFE)
1, 2	Length (0xNNNN)	1, 2	Length (0x0007)
3, 4	Message Type (0x008F)	3, 4	Message Type (0x008F)
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, 9	Status MSB, LSB
		10	Checksum
	Number of AEs to follow
	AEs 0x08 SS7 Stack
:	TUP Message Index
:	MCT Entry Indicates whether the entry in the Message Configuration Table is valid or invalid. 0x00 Invalid (will be ignored) 0x01 Valid (will be handled by TUP)
:	H0 Length
:	H0 Value
:	H1 Length
:	H1 Value
:	Message Attributes MSB, LSB This field is a bit mask. The meaning of each bit is described below. Bit 0 Group Message Flag 0 Not Group Message 1 Group Message Bits 1–15 Reserved, must be 0x00
:	Number of Mandatory Fields (M)
:	Field[m] – ID
:	Field[m] – Attributes MSB, LSB This field is a bit mask. The meaning of each bit is described below. Bit 0 Range and Status Field Flag 0 Field is not Range and Status Field 1 Field is Range and Status Field Bit 1 Filler Field Flag 0 Field is not Filler Field 1 Field is Filler Field (not reported to or required from the host) Bit 2 Status Subfield Variant 0 Field is not a Range and Status field or is a Range and Status field and the status bits are used to inform TUP as to which CICs are being operated (such as the group blocking messages) 1 Field is a Range and Status field and all CICs in the range are being operated, independent of the status value (such as, the GRA message) Bit 3 Zero length subfield allowed 0 If present in the SSUTR2 field, access field with 0 length will not be automatically inserted into the message. 1 If present in the SSUTR2 field, access field with 0 length will be automatically inserted into the message.
	Bit 4 Indicator Field Flag 0 Indicator will not be inserted. 1 If present in the SSUTR2 field, an indicator will be automatically inserted. If this indicator bit is set for optional field, all the optional parameters followed by the indicator will belong to this indicator. If this indicator is set for mandatory field, all the fields with an extension field indicator will belong to the indicator. Bits 5-12 Reserved Bit Mask. Bit Mask is used to set bits in the indicator field. This allows the field location to be anywhere in the indicator. They need not be in order. Bit 13 Common Field Flag 0 Not a common field 1 This field is a common optional field. Its presence is dependent on certain other fields following it. Its presence does not cause a bit to be set in the indicator field. Bit 14 Extension Field Flag 0 Not an extension field 1 This field is an extension field of the previous field and will cause a bit to be set in the indicator. Bit 15 Reserved; must be 0x00
:	Field[m] – Number of Subfields [S]
:	Subfield[s] – ID
:	Subfield[s] – Attributes MSB, LSB This field is a bit mask. The meaning of each bit is described below. Bits 0–2 Number of Units to Add to Subfield if Length Subfield (0–7) Bits 3–4 Subfield Length Type if Length Subfield 0 Bits 1 Half-Octets 2 Octets Bit 5 Subfield Type Flag 0 Data Subfield (Bits 0–4 are ignored) 1 Length Subfield (The value of the Subfield indicates the length of the next Data Subfield) Bit 6 Use Filler (Pad subfield to the next octet) Bit 7 Is Filler (Subfield is a filler/does not contain useful data) Bits 8–15 Reserved, must be 0x00
:	Subfield[s] – Min. Length MSB, LSB
:	Subfield[s] – Max. Length MSB, LSB
:	Optional Part – Attributes MSB, LSB This field is a bit mask. The meaning of each bit is described below. Bit 0 Optional Field Use Filler Flag 0 If present in the TUP message, the Optional Field Indicator bitfield will not be octet-padded. 1 If present in the TUP message, the Optional Field Indicator bitfield will be octet-padded. Bits 1–8 Bit Mask is used to set bits in the indicator field. This allows the optional field location anywhere in the indicator. They need not be in order. Bits 9-12 Length of optional indicator to be inserted Bits 13-15 Reserved; must be 0x00
:	Number of Optional Fields (0)
:	Field[0] – ID
:	Field[0] – Attributes MSB, LSB
:	Field[0] – Number of Subfields [S]
:	Subfield[s] – ID
:	Subfield[s] – Attributes MSB, LSB
:	Subfield[s] – Min. Length MSB, LSB
:	Subfield[s] – Max. Length MSB, LSB
:	Checksum

TUP Message Index

This field indicates the index into the TUP Message Format table for the specified TUP message. For more information on the TUP Message Format table, refer to the API Developer’s Guide: Common Channel Signaling.

Index	Message	Index	Message	Index	Message
0x00	IAM	0x12	ACC	0x24	BLO
0x01	IAI	0x13	ADI	0x25	BLA
0x02	SAM	0x14	CGC	0x26	UBL
0x03	SAO	0x15	DPN	0x27	UBA
0x04	ACM	0x16	LOS	0x28	MGB
0x05	ANC	0x17	NNC	0x29	MBA
0x06	ANN	0x18	SEC	0x2A	MGU
0x07	ANU	0x19	SSB	0x2B	MUA
0x08	CBK	0x1A	SST	0x2C	HGB
0x09	CLF	0x1B	MPR	0x2D	HBA
0x0A	RLG	0x1C	EUM	0x2E	HGU
0x0B	GRQ	0x1D	UNN	0x2F	HUA
0x0C	GSM	0x1E	CCR	0x30	SGB
0x0D	RAN	0x1F	COT	0x31	SBA
0x0E	FOT	0x20	CCF	0x32	SGU
0x0F	CCL	0x21	GRS	0x33	SUA
0x10	CFL	0x22	GRA	0x34–0x43	Reserved for future use
0x11	ACB	0x23	RSC	0x44–0x5B	User-defined Messages

SSUTR2 Message Index

This field indicates the index into the SSUTR2 Message Format table for the specified SSUTR2 message. For more information on the SSUTR2 Message Format table, refer to the API Developer’s Guide: Common Channel Signaling.

0x00 MIF		0x02 MSA
0x03 MSS		0x04 ACF
0x05 RIU		0x08 RAU
0x09 FIU		0x0A LIG
0x0B DEG		0x0C IFG
0x0D NRP		0x10 ECH
0x11 ACI		0x14 EFC
0x16 LHS		0x17 ERN
0x18 EEC		0x19 OCC
0x1A TSI		0x1B INU
0x1D NNU		0x1E CCD
0x1F CCP		0x20 CCN
0x21 GRS		0x22 GRA
0x23 RZC		0x24 BLO
0x25 BLA		0x26 UBL
0x27 UBA		0x34 CHT
0x35 ITX		0x36 TXA
0x37 TAX		0x38 SND
0x39 EAR		0x3A MCE
0x3B MUU

H0/H1 Length

The system uses the H0 and H1 fields as x, y coordinates for the Heading Code Allocations table found in the Q.723 specification.

This field indicates whether length of the H0 Value and H1 Value fields are defined as half-octets or octets (groups of 4 bits or 8 bits, respectively). Valid entries for this field are as follows:

0x01 Half-octets

0x02 Octets

H0/H1 Value

The system uses the H0 and H1 fields as x, y coordinates for the Heading Code Allocations table found in the Q.723 specification.

TUP

This field represents the value of the H0 or H1 parameter in the Heading Code Allocations table. To represent the appropriate Heading Code, use the following H0 and H1 values:

Heading	H0	H1
IAM	0x01	0x01
IAI	0x01	0x02
SAM	0x01	0x03
SAO	0x01	0x04
GSM	0x02	0x01
COT	0x02	0x03
CCF	0x02	0x04
GRQ	0x03	0x01
ACM	0x04	0x01
CHG	0x04	0x02
SEC	0x05	0x01
CGC	0x05	0x02
NNC	0x05	0x03
ADI	0x05	0x04
CFL	0x05	0x05
SSB	0x05	0x06
UNN	0x05	0x07
LOS	0x05	0x08
SST	0x05	0x09
ACB	0x05	0x0A
DPN	0x05	0x0B
MPR	0x05	0x0C
EUM	0x05	0x0F
ANU	0x06	0x00
ANC	0x06	0x01
ANN	0x06	0x02
CBK	0x06	0x03
CLF	0x06	0x04
RAN	0x06	0x05
FOT	0x06	0x06
CCL	0x06	0x07
RLG	0x07	0x01
BLO	0x07	0x02
BLA	0x07	0x03
UBL	0x07	0x04
UBA	0x07	0x05
CCR	0x07	0x06
RSC	0x07	0x07
MGB	0x08	0x01
MBA	0x08	0x02
MGU	0x08	0x03
MUA	0x08	0x04
HGB	0x08	0x05
HBA	0x08	0x06
HGU	0x08	0x07
HUA	0x08	0x08
GRS	0x08	0x09
GRA	0x08	0x0A
SGB	0x08	0x0B
SBA	0x08	0x0C
SGU	0x08	0x0D
SUA	0x08	0x0E
ACC	0x0A	0x01

SSUTR2

This field represents the value of the H0 or H1 parameter in the Heading Code Allocations table. To represent the appropriate Heading Code, use the following H0 and H1 values:

Heading	H0	H1
CHT	0x00	0x03
ITX	0x00	0x04
TXA	0x00	0x08
MSA	0x01	0x03
MSS	0x01	0x04
IFG	0x02	0x02
CCP	0x02	0x03
CCN	0x02	0x04
DEG	0x03	0x01
TAX	0x04	0x02
EEC	0x05	0x01
EFC	0x05	0x02
ERN	0x05	0x03
ECH	0x05	0x05
OCC	0x05	0x06
NNU	0x05	0x07
LHS	0x05	0x08
TSI	0x05	0x09
ACI	0x05	0x0A
INU	0x05	0x0C
NRP	0x06	0x05
LIG	0x07	0x01
BLO	0x07	0x02
BLA	0x07	0x03
UBL	0x07	0x04
UBA	0x07	0x05
CCD	0x07	0x06
RZC	0x07	0x07
GRS	0x08	0x09
GRA	0x08	0x0A
MUU	0x0B	0x01
MCE	0x0B	0x02
ACF	0x0C	0x02
MIF	0x0D	0x02
SND	0x0E	0x01
EAR	0x0E	0x02
RIU	0x0F	0x01
RAU	0x0F	0x02
FIU	0x0F	0x03

SSUTR2 Heading Allocation Table

The actual SSUTR2 Heading Allocations Table is provided here for reference:

H0 / H1	0000	0001	0010	0011	0100	0101	0110	0111
0000				CHT	ITX
0001				MSA	MSS
0010			IFG	CCP	CCN
0011		DEG
0100			TAX
0101		EEC	EFC	ERN		ECH	OCC	NNU
0110						NRP
0111		LIG	BLO	BLA	UBL	UBA	CCD	RZC
1000
1001	Resv.
1010	Resv.
1011		MUU	MCE
1100			ACF
1101			MIF
1110		SND	EAR
1111		RIU	RAU	FIU

H0 / H1	1000	1001	1010	1100
0000	TXA
0001
0010
0011
0100
0101	LHS	TSI	ACI	INU
0110
0111
1000		GRS	GRA
1001	Resv.
1010
1011
1100
1101
1110
1111

Field ID

The table below shows the Field ID for supported fields.

Field ID	Field Name	TUP Messages Containing Field
0x01	Calling Party Category	IAM, IAI, GSM
0x02	Call Setup Message Indicators	IAM, IAI
0x03	Called Party Address Data	IAM, IAI, SAM
0x04	IAI National Use Field	IAI
0x05	Closed User Group Information	IAI
0x06	Additional Calling Party Information	IAI
0x07	Additional Routing Information	IAI
0x08	Calling Line ID	IAI, GSM
0x09	Original Called Address	IAI, GSM
0x0A	Charging Information	IAI
0x0B	Called Party Address Digit	SAO
0x0C	ACM Message Indicator	ACM
0x0D	Request Type Indicator	GRQ
0x0E	RESERVED	RESERVED
0x0F	Incoming Trunk and Transit Identity	GSM
0x10	Echo Suppressor Indicator *	GSM
0x11	Malicious Call Identification *	GSM
0x12	Hold Indicator *	GSM
0x13	ACC Message Indicator	ACC
0x14	EUM Octet Indicator	EUM
0x15	Signaling Point Code	EUM
0x16	Range and Status Field	GRA, MGB, MBA, MGU, MUA, HGB, HBA, HGU, HUA, SGB, SBA, SGU, SUA
0x17	Range Field (w/ no status)	GRS

* These are only flags in the Indicator field and contain no data
(Data Length = 0)

SSUTR2

Field ID	Field Name	SSUTR2 Messages containing Field
0x01	Calling Party Category	MIF, IFG
0x02	Call Setup Message Indicators	MIF
0x03	Called Party Address Data	MIF, MSA
0x04-0x05	--------	---------
0x06	Additional Calling Party Information	MIF
0x07	Additional Routing Information	MIF
0x08	Calling Line ID	MIF, IFG
0x09-0x0A	--------	--------
0x0B	Called Party Address Digit	MSS
0x0C	ACF Message Indicator	ACF
0x0D	Request Type Indicator	DEG
0x0E-0x17	---------	--------
0x18	Type of Access Requested	ACF
0x19	Indicator of presence of data	ACF
0x1A	Amount of Price and number of call charge units A	TAX
0x1B	Causes	EAR, SND
0x1C	Access Information Field w zero length allowed	EAR, RAN, CLB, CLF, ACF,RIU
0x1D	Access Information Field	MUU, MCE, MIF
0x1E	Pricing factor	CHT, TAX
0x1F	Time Indicator	CHT, TAX
0x20	Price Allocation Domain	ITX
0x21	Message Number	ITX
0x22	Price Indicator	CHT
0x23	Amount of Price and number of call charge units B	TAX
0x24	Identity of first called party	MIF
0x25	Pricing factor B	TAX