(Page 1 of 1 in this chapter)

Chapter 17

System R1.5 Protocol

17.1 Introduction

: 17.1.1 Signaling Overview

17.2 Parameters

: 17.2.1 Editable Parameters
: 17.2.2 Non-editable Parameters

17.3 Special TCP Behavior

: 17.3.1 Inbound Calls: Retrieving Digits All at Once
: 17.3.2 Inbound Calls: Retrieving Digits One at a Time
: 17.3.3 Outbound Calls: Digit Format

17.1 Introduction

This chapter briefly discusses the signaling performed by the System R1.5 protocol, and implemented by the R15 TCPs. The chapter also describes the R15 TCPs parameters, and all operations that are specific to the R15 TCPs within the framework of Natural Call Control.
The R15 TCPs implement a number of different protocols that are in use in the Russian telephone network. The protocols run on E1 trunks. Two separate TCPs are used for inbound and outbound calls, since the protocols structure exclude the possibility of two-way trunks. They are named r150.tcp and r151.tcp. Separate call setup schemes are used for local and long distance calls as well; both TCPs support both schemes.

17.1.1 Signaling Overview

The R1.5 protocols use two signaling bits per direction to control the state of calls. The bits used are the A and B bits. Line signaling is a combination of signaling bits variation and in-band tones.
Register signaling is usually performed by acknowledged MF tones. This means that the outbound equipment plays a forward tone (representing one of the address digits), and the inbound equipment requests the next tone by playing a backward MF tone. Both tones are timed, not compelled.
However, it is possible for the outbound to be requested to switch to decadic pulse dialing during setup of a call, since not all switches in the Russian networks are equipped with MF tones detectors.

17.2 Parameters

The R15 inbound and outbound TCPs have common parameters structures. They are programmed by the parameters described below. Caution: Most of the parameters that follow are signaling-specific: changing their value would not only invalidate any approval certificate for the used board, but would also most likely cause the board to malfunction. These parameters are described here for reference purposes only.
Other parameters program the interaction the TCP has with the host, or act on features not regulated or that can change from switch to switch within the same network. These are changeable, and indeed, the application developer is often asked to do so. These parameters are in the first table below.

Caution:	Most of the parameters that follow are signaling-specific: changing their value would not only invalidate any approval certificate for the used board, but would also most likely cause the board to malfunction. These parameters are described here for reference purposes only.

17.2.1 Editable Parameters

Users can modify the following ADI.R15 parameters: Field Name Type/Unit Default Description DIDnumber number 7 Inbound. Specifies the number of incoming DID digits to expect. ANInumber number 8 Inbound. Number of ANI digits to expect. If this parameter is set to 0, then the inbound protocol would not attempt to request the ANIs. If this parameter is set to any other number, the inbound protocol will request the ANIs, and will receive as many as the outbound side will provide. optionflags mask 0x10 inbound and outbound. Flags controlling optional TCP behavior: (MF-Pulse Shuttle protocol is the default register signaling for both inbound and outbound protocols and can be combined or replaced with some other types of register signaling). · bit 0 (& 0x1): Set this bit to do Decadic dialing (for both inbound and outbound protocols). · bit 1 (& 0x2): Set this bit for long distance inbound protocol. · bit 2 (& 0x4): Set this bit to make the transmission of ANIs mandatory (relevant to the outbound protocol). · bit 3 (& 0x8): Set this bit to make the reception of ANIs mandatory (relevant to the inbound protocol). · bit 4 (& 0x10): (default) Play busy on timeout. · bit 5 (& 0x20): Play fast busy on timeout. · bit 6 (& 0x40): Play silence on timeout. · bit 7 (& 0x80): Enable the detection of ANIs one at a time. These values can be ORed for cumulative effect. debugmask mask 0x0 Specifies what trace messages are generated (run agtrace 1000 or higher to see them): · 0x01: Show all states as they are entered · 0x02: Show sent and received digits · 0x04: Show signaling bits · 0x08: Print a description of timeout- related errors These values can be Ored for cumulative effect. firstcommand number 1 inbound. First command for inbound protocol. Acceptable values: 1, 2, 3 If the value is set to 2 or 3, make sure that the DIDnumber is set to a correct value. 1 = Send first digit. 2 = Send next digit. 3 = Send previous digit. anirequestattempts number 1 inbound. The parameter specifies the number of attempts to obtain ANIs. If the parameter is set to 0, no attempts will be made. When the reception of ANIs is mandatory (bit 0x8 in optionflags is set) and no ANIs are received after the first attempt, this parameter can be used to perform additional ANI requests before clearing back. dialstartposition number 4 outbound. The value of this parameter is used to define the starting position within a dial string; i.e. when the first request from the inbound, defined by ADI.R15.firstcommand, is B2 (send next digit) or B3 (send the previous digit) the first DID that is presented by the outbound side is located in the ADI.R15.dialstartposition position.

Field Name	Type/Unit	Default	Description
`DIDnumber`	number	`7`	Inbound. Specifies the number of incoming DID digits to expect.
`ANInumber`	number	`8`	Inbound. Number of ANI digits to expect. If this parameter is set to 0, then the inbound protocol would not attempt to request the ANIs. If this parameter is set to any other number, the inbound protocol will request the ANIs, and will receive as many as the outbound side will provide.
`optionflags`	mask	`0x10`	inbound and outbound. Flags controlling optional TCP behavior: (MF-Pulse Shuttle protocol is the default register signaling for both inbound and outbound protocols and can be combined or replaced with some other types of register signaling). · bit 0 (& `0x1): Set this bit to do Decadic dialing (for both inbound and outbound protocols).` · bit 1 (& `0x2): Set this bit for long distance inbound protocol.` · bit 2 (& `0x4): Set this bit to make the transmission of ANIs mandatory (relevant to the outbound protocol).` · bit 3 (& `0x8): Set this bit to make the reception of ANIs mandatory (relevant to the inbound protocol).` · bit 4 (& `0x10): (default) Play busy on timeout.` · bit 5 (& `0x20): Play fast busy on timeout.` · bit 6 (& `0x40): Play silence on timeout.` · bit 7 (& `0x80): Enable the detection of ANIs one at a time.` These values can be ORed for cumulative effect.
`debugmask`	mask	`0x0`	Specifies what trace messages are generated (run `agtrace 1000 or higher to see them):` · `0x01: Show all states as they are entered` · `0x02: Show sent and received digits` · `0x04: Show signaling bits` · `0x08: Print a description of timeout- related errors` These values can be Ored for cumulative effect.
`firstcommand`	number	`1`	inbound. First command for inbound protocol. Acceptable values: 1, 2, 3 If the value is set to 2 or 3, make sure that the `DIDnumber` is set to a correct value. `1` = Send first digit. `2` = Send next digit. `3` = Send previous digit.
`anirequestattempts`	number	`1`	inbound. The parameter specifies the number of attempts to obtain ANIs. If the parameter is set to 0, no attempts will be made. When the reception of ANIs is mandatory (bit 0x8 in optionflags is set) and no ANIs are received after the first attempt, this parameter can be used to perform additional ANI requests before clearing back.
`dialstartposition`	number	`4`	outbound. The value of this parameter is used to define the starting position within a dial string; i.e. when the first request from the inbound, defined by `ADI.R15.firstcommand`, is B2 (send next digit) or B3 (send the previous digit) the first DID that is presented by the outbound side is located in the `ADI.R15.dialstartposition` position.

17.2.2 Non-editable Parameters

The following ADI.R15 parameters are country- or network-specific, and cannot be modified. Field Name Type/Unit Example Description qualtime ms 20 Specifies the qualification time for bit changes. waitbegintime ms 60 Specifies the delay before starting to play the forward and backward tones. Outbound Timers seizetime ms 400 Specifies the maximum time to receive the seizure acknowledge. waitbacksignaltime ms 4000 Specifies the maximum time to receive a backward request. pausefrstdigittime ms 300 Specifies the initial wait before dialing the first decadic pulse. interdigittime ms 750 Specifies the time between two trains of pulses while dialing with decadic pulses. confirmanswertime ms 275 Specifies the timeout for differentiating answer vs. ANI request which is the same line code but accompanied by a 500 Hz tone. Inbound Timers waitfrwdsignaltime ms 350 Specifies the maximum time to receive a forward signal. waitfrwddeksignaltime ms 4000 Specifies the maximum time to receive a decadic digit. inbinterdigittime ms 200 Specifies the time to wait before deciding that a train of decadic pulses is over. waitforPCtime ms 10000 Specifies the time for the TCP to wait for the host to answer or reject the call. Inbound ANI Detector Timers anitonetimeout ms 100 Specifies the time to wait before deciding that the transmission of ANIs is over. anirequesttimeout ms 1000 Specifies the timeout to get the first ANI. answersignalontime ms 500 Specifies the duration of line signal AB-10 (answer) when requesting ANIs. requestdelaytime ms 2000 Specifies the delay between A-12 and the ANI request line signal AB-10. tonedelaytime ms 230 Specifies the delay between signaling answer during the ANI request and sending the 500 Hz tone. Note: This value has been optimized for use within the Russian network. It should be decreased for back-to-back testing. anirequestontime ms 110 Specifies the duration of 500 Hz tone during an ANI request. Dialing Control toneontime ms 45 Specifies the duration of the MF tone used to convey DID information (backward and forward). toneofftime ms 45 Specifies the silence between the MF tones used to convey DID information (backward and forward) - also used for echo cancellation. pulseontime ms 50 Relevant to the outbound protocol. Specifies the time a pulse should be ON while dialing with decadic pulses. pulseofftime ms 50 Relevant to the outbound protocols. Specifies the time a pulse should be OFF while dialing with decadic pulses. anitoneontime ms 40 Relevant to outbound protocols. Specifies the duration of the MF tone used to convey ANI information. toneslevel IDU 315 Specifies the amplitude of MF (call setup) tones (forward and backward). Ring/Busy Control ringfreq Hz 425 Relevant to inbound protocols. Specifies the ring tone frequency. ringontime ms 1000 Relevant to inbound protocols. Specifies the time the ring tone is on in a ring cycle. ringofftime ms 3000 Relevant to inbound protocols. Specifies the time the ring tone is off in a ring cycle. busyfreq Hz 425 Relevant to inbound protocols. Specifies the busy tone frequency. busyontime ms 300 Relevant to inbound protocols. Specifies the time the busy tone is on in a busy cycle. busyofftime ms 300 Relevant to inbound protocols. Specifies the time the busy tone is off in a busy cycle. fastbusyontime ms 150 Relevant to inbound protocols. Specifies the time the congestion tone is on. fastbusyofftime ms 150 Relevant to inbound protocols. Specifies the duration of the first period of time the congestion tone is off. Cptoneslevel IDU 315 Specifies the amplitude of call progress tones. Miscellaneous resourcerequesttime mask 0x0a0f Specifies the time to wait for resources.

Field Name	Type/Unit	Example	Description
`qualtime`	ms	`20`	Specifies the qualification time for bit changes.
`waitbegintime`	ms	`60`	Specifies the delay before starting to play the forward and backward tones.
Outbound Timers
`seizetime`	ms	`400`	Specifies the maximum time to receive the seizure acknowledge.
`waitbacksignaltime`	ms	`4000`	Specifies the maximum time to receive a backward request.
`pausefrstdigittime`	ms	`300`	Specifies the initial wait before dialing the first decadic pulse.
`interdigittime`	ms	`750`	Specifies the time between two trains of pulses while dialing with decadic pulses.
`confirmanswertime`	ms	`275`	Specifies the timeout for differentiating answer vs. ANI request which is the same line code but accompanied by a 500 Hz tone.
Inbound Timers
`waitfrwdsignaltime`	ms	`350`	Specifies the maximum time to receive a forward signal.
`waitfrwddeksignaltime`	ms	`4000`	Specifies the maximum time to receive a decadic digit.
`inbinterdigittime`	ms	`200`	Specifies the time to wait before deciding that a train of decadic pulses is over.
`waitforPCtime`	ms	`10000`	Specifies the time for the TCP to wait for the host to answer or reject the call.
Inbound ANI Detector Timers
`anitonetimeout`	ms	`100`	Specifies the time to wait before deciding that the transmission of ANIs is over.
`anirequesttimeout`	ms	`1000`	Specifies the timeout to get the first ANI.
`answersignalontime`	ms	`500`	Specifies the duration of line signal AB-10 (answer) when requesting ANIs.
`requestdelaytime`	ms	`2000`	Specifies the delay between A-12 and the ANI request line signal AB-10.
`tonedelaytime`	ms	`230`	Specifies the delay between signaling answer during the ANI request and sending the 500 Hz tone. Note: This value has been optimized for use within the Russian network. It should be decreased for back-to-back testing.
`anirequestontime`	ms	`110`	Specifies the duration of 500 Hz tone during an ANI request.
Dialing Control
`toneontime`	ms	`45`	Specifies the duration of the MF tone used to convey DID information (backward and forward).
`toneofftime`	ms	`45`	Specifies the silence between the MF tones used to convey DID information (backward and forward) - also used for echo cancellation.
`pulseontime`	ms	`50`	Relevant to the outbound protocol. Specifies the time a pulse should be ON while dialing with decadic pulses.
`pulseofftime`	ms	`50`	Relevant to the outbound protocols. Specifies the time a pulse should be OFF while dialing with decadic pulses.
`anitoneontime`	ms	`40`	Relevant to outbound protocols. Specifies the duration of the MF tone used to convey ANI information.
`toneslevel`	IDU	`315`	Specifies the amplitude of MF (call setup) tones (forward and backward).
Ring/Busy Control
`ringfreq`	Hz	`425`	Relevant to inbound protocols. Specifies the ring tone frequency.
`ringontime`	ms	`1000`	Relevant to inbound protocols. Specifies the time the ring tone is on in a ring cycle.
`ringofftime`	ms	`3000`	Relevant to inbound protocols. Specifies the time the ring tone is off in a ring cycle.
`busyfreq`	Hz	`425`	Relevant to inbound protocols. Specifies the busy tone frequency.
`busyontime`	ms	`300`	Relevant to inbound protocols. Specifies the time the busy tone is on in a busy cycle.
`busyofftime`	ms	`300`	Relevant to inbound protocols. Specifies the time the busy tone is off in a busy cycle.
`fastbusyontime`	ms	`150`	Relevant to inbound protocols. Specifies the time the congestion tone is on.
`fastbusyofftime`	ms	`150`	Relevant to inbound protocols. Specifies the duration of the first period of time the congestion tone is off.
`Cptoneslevel`	IDU	`315`	Specifies the amplitude of call progress tones.
Miscellaneous
`resourcerequesttime`	mask	`0x0a0f`	Specifies the time to wait for resources.

17.3 Special TCP Behavior

The following sections describe operations that are specific to the R15 TCPs within the framework of Natural Call Control.

17.3.1 Inbound Calls: Retrieving Digits All at Once

When the application receives the ADIEVN_INCOMING_CALL event, not all information regarding the inbound call is available. For local calls, the missing information is the caller's category and ANI digits. This is because the R1.5 local outbound protocol sends the category and ANI digits only after the call has been accepted by the inbound party. So the ADI_CALL_STATUS has only one relevant field that is filled if the application calls adiGetCallStatus after an ADIEVN_INCOMING_CALL event:

Field

Description

calledaddr

The called number. Also referred to as the Direct Inward Dial (DID) number.
If the application accepts the call, the TCP collects the caller's category and ANI digits. Once they are available, the application can receive a ADIEVN_STATUSINFO_UPDATE, with a value of CALL_STATUS_CALLINGADDR (1). Note: The reception of this event must be explicitly enabled before starting the protocol, by setting the ADI_CC_REPTSTATUSINFO bit in the ADI.START.callctl.eventmask parameter.
A subsequent call to adiGetCallStatus yields the following new fields:

Field

Description

callingaddr

The calling number (if available). Also referred to as the Automatic Number Identification (ANI) number.

usercategory

The calling party category, e.g. normal subscriber, operator, maintenance equipment.
Two ADI.R15 parameters affect the way the R15 TCPs accept and process digits: Parameter Description DIDnumber This parameter determines the number of Direct Inward Dial (DID) digits the TCP should expect from the calling party. Default is 7. ANInumber This parameter determines the number of ANI and category digits the TCP should expect from the calling party. For local inbound calls, if the parameter is set to 0, the ANI request will not be attempted; otherwise the TCP retrieves all the digits the calling party will send. This parameter is not relevant for long distance inbound calls.

Field	Description
`calledaddr`	The called number. Also referred to as the Direct Inward Dial (DID) number.

Field	Description
`callingaddr`	The calling number (if available). Also referred to as the Automatic Number Identification (ANI) number.
`usercategory`	The calling party category, e.g. normal subscriber, operator, maintenance equipment.

Parameter	Description
`DIDnumber`	This parameter determines the number of Direct Inward Dial (DID) digits the TCP should expect from the calling party. Default is 7.
`ANInumber`	This parameter determines the number of ANI and category digits the TCP should expect from the calling party. For local inbound calls, if the parameter is set to 0, the ANI request will not be attempted; otherwise the TCP retrieves all the digits the calling party will send. This parameter is not relevant for long distance inbound calls.

17.3.2 Inbound Calls: Retrieving Digits One at a Time

The R15 TCP sends the incoming DID digits to the application one at a time in the following sequence:
d1 dn
where n is determined by the adi.r15.DIDnumber parameter.
If the application sets bit 7 (& 0x80) of the parameter ADI.R15.optionflags, the TCP also provides the ANI digits and the caller category as they arrive. This happens after the call is accepted by the application. Due to the working of the protocol, ANI digits may be: Reversed (last digit of the calling number first in sequence) Presented more than once, since the switch sends the category and ANI digits in a fast spill which can be repeated several times

17.3.3 Outbound Calls: Digit Format

R15 TCPs expect the digit string to be formatted as follows:
# c a1 . am # d1 dn
where: c User category of the calling party. a1 am ANI digits (the address of the calling party). d1dn DID digits (the address of the called party). # NMS separator symbol.
User category and ANIs can be omitted if the connection does not require them to be present. If these are omitted, the digit string should be formatted as follows:
d1 dn

c	User category of the calling party.
a1 am	ANI digits (the address of the calling party).
d1dn	DID digits (the address of the called party).
#	NMS separator symbol.

(Page 1 of 1 in this chapter)

tech_support@nmss.com