Table of Contents Index NMS Glossary Previous Page Next Page Version


Appendix A

ISDN TCP Parameters


Introduction
NMS ISDN Parameter Files (NCC Service) Changing Parameter Values 183

NMS ISDN Parameter Files (ADI Service) Changing Parameter Values 190

TCP Parameters That Should Not Be Modified 193

IntroductionTop of Page

This appendix describes the parameters exposed to the user by NMS ISDN for Natural Call Control.

When you install NMS ISDN software, parameter files are installed. The parameters in these files configure the TCP.

Note: These files are useful only if you are configuring the NMS ISDN software in Channelized configuration (as documented in this manual). For more information, see Section 3.6.2, Starting a TCP on a CTA Context.

Some parameters determine the amplitude, frequency, length and pattern of the busy tone, ring tone and reorder tone. Since the tones differ from country to country, these parameters are country-specific, and should not be modified. Other parameters determine the service to request when placing an outbound call, the mode the TCP runs in, the channel direction, and the signal sending mask. These parameters can be modified to suit your application.

The parameter files relevant to your application differ depending upon whether you are using the NCC Service or the ADI Service for call control. The sections below discuss both situations.

NMS ISDN Parameter Files (NCC Service)Top of Page

Three types of parameter files are installed with each package for use with the NCC service:
File Type/Name

Description

nccxadicty.pf

nccstartcty.pf

· cty is the three character code of the target country. For example, the code for Australia is aus. Thus the versions of these files for Australia are nccxadiaus.pf and nccstartaus.pf.

Binary parameter files containing a set of country-specific values for NCC service parameters. Most of the values in these files should not be changed. Changing certain values may affect the regulatory approvals in the target country.

nccxisdn.pf

A binary parameter file containing a set of NMS ISDN parameters and default values. Changing these parameters directly affects all control messages (for example, messages associated with NCC primitives). To change them correctly, you must have knowledge of the ISDN specifications for the target country.

nccxadicty.par

nccstartcty.par

nccxisdn.par

ASCII versions of the above files.

In order for Natural Access to load the binary parameter file, both of the binary parameter files (.pf files) for the target country must be in one of the directories specified with the AGLOAD environment variable. nccxisdn.pf must also be in the directory.

When you install NMS ISDN, the installation program asks you for a default country. It creates copies of the country-specific parameter files for that country, renames them, and places them in the AGLOAD path, as follows:
These files...

Are copied to...

nccxadicty.pf
nccxadicty.par

...where cty is the code for the default country

NT: \nms\ag\cfg\nccxadi.pf
\nms\ag\cfg\nccxadi.par

UNIX: /opt/nms/ag/cfg/nccxadi.pf
/opt/nms/ag/cfg/nccxadi.par

nccstartcty.pf
nccstartcty.par

NT: \nms\ag\cfg\nccstart.pf
\nms\ag\cfg\nccstart.par

UNIX: /opt/nms/ag/cfg/nccstart.pf
/opt/nms/ag/cfg/nccstart.par

nccxisdn.pf
nccxisdn.par

NT: \nms\ag\cfg\nccxisdn.pf
\nms\ag\cfg\nccxisdn.par

UNIX: /opt/nms/ag/cfg/nccxisdn.pf
/opt/nms/ag/cfg/nccxisdn.par

The files for only one country should appear in the AGLOAD directory; otherwise, the parameters will not load.

Changing Parameter Values

To change parameter values in a .pf file:

1. Modify the value in the corresponding .par file. Your application can then load the changes as follows:

2. Initialize the Natural Access PRM service so the binary parameter file is loaded.

3. Parse the .par file.

4. Do one of the following:

- Call ctaSetParmByName for each parameter specified in the file, to set a new default value. (For an example of this, see the DemoLoadParameters function in the demonstration library supplied with Natural Access.)

or

- Use the ctdaemon program to set the parameters system-wide. See the Natural Access Developer's Reference Manual for more information.

or

- Call ctaLoadParameterFile from within your application.

Parameter modification must take place before nccStartProtocol is called to start the TCP (as described in Section 3.6.2, Starting a TCP on a CTA Context). When the function call is made, the TCP is programmed as specified by the parameters.

The following are listings of all parameters in the nccxidsn.pf parameter file. Changing these parameters directly affects call control messages (for example, messages associated with NCC primitives). To change these parameters correctly, you require knowledge of the ISDN specifications for the target country. See Section 4.10 for more information.

NCC.X.ADI_ISDN.ACCEPTCALL_EXT

Dependent Function(s): nccAcceptCall

Field Name

Default

Units

Description

uui

""

char

User-to-user information (Up to 132 characters.)

cause

0

integer

Q.931 accept cause

progressdescriptor

0

integer

Q.931 progress description in progress message.

NCC.X.ADI_ISDN.ANSWERCALL_EXT

Dependent Function(s): nccAnswerCall

Field Name

Default

Units

Description

uui

""

char

User-to-user information (Up to 132 characters.)

NCC.X.ADI_ISDN.DISCONNECTCALL_EXT

Dependent Function(s): nccDisconnectCall

Field Name

Default

Units

Description

uui

""

char

User-to-user information (Up to 132 characters.)

cause

0

integer

Q.931 disconnect cause

pad

0

integer

Pad

NCC.X.ADI_ISDN.PLACECALL_EXT

Dependent Function(s): nccPlaceCall

Field Name

Default

Units

Description

uui

""

char

User-to-user information (Up to 132 characters.)

CALLEDNUM.plan

0

integer

Q.931 numbering plan of called address.1

CALLEDNUM.type

0

integer

Q.931 numbering type of called address.1

CALLINGNUM.plan

0

integer

Q.931 numbering plan of calling address.1

CALLINGNUM.type

0

integer

Q.931 numbering type of calling address.1

CALLINGNUM.screen

0

integer

Q.931 screening indicator.1

CALLINGNUM.presentation

0

integer

Q.931 presentation indicator for calling address.1

REDIRECTINGNUM.digits

""

char

The redirecting address.1

REDIRECTINGNUM.pad

3

integer

Pad

REDIRECTINGNUM.plan

0

integer

Q.931 numbering plan of redirecting address.1

REDIRECTINGNUM.type

0

integer

Q.931 numbering type of redirecting address.1

REDIRECTINGNUM.screen

0

integer

Q.931 redirecting number screening indicator.1

REDIRECTINGNUM.presentation

0

integer

Q.931 presentation indicator for redirecting address.1

REDIRECTINGNUM.reason

0

integer

Q.931 reason for redirection.1

REDIRECTINGNUM.pad1

0

integer

Pad1

service

0

integer

Q.931 service.

nsf_present

0

integer

Network-Specific Facilities (NSF):

1 = present, 0 = not present

nsf_service_feature

0

integer

NSF service or feature:

1 = SERVICE, 0 = FEATURE

nsf_facility_coding

0

integer

NSF service or feature ID.

1 If supported. Possible values for these fields are defined in isdnval.h.

NCC.X.ADI_ISDN.REJECTCALL_EXT

Dependent Function(s): nccRejectCall

Field Name

Default

Units

Description

uui

""

char

User-to-user information (Up to 132 characters.)

cause

0

integer

Q.931 reject cause

pad

0

integer

Pad

NCC.X.ADI_ISDN.SENDDIGITS_EXT

Dependent Function(s): nccSendDigits

Field Name

Default

Units

Description

CALLEDNUM.plan

0

integer

Q.931 number plan of called address

CALLEDNUM.type

0

integer

Q.931 numbering type of called address

Note: These fields are valid only when supported. Possible values for these fields are defined in isdnval.h.

NCC.X.ADI_ISDN.START_EXT

Dependent Function(s): nccStartProtocol

Field Name

Default

Units

Description

exclusive

1

integer

Determines whether this TCP runs in Exclusive Mode or Non-Exclusive Mode. For details, see Chapter 6.

0: Non-Exclusive Mode

1: Exclusive Mode

direction

0

integer

Determines if the channel is inbound, outbound or bidirectional.
(See
Chapter 6).

0: bidirectional (default)

1: inbound

2: outbound

networkstream

0xFF

integer

Determines the stream to use for outbound calls. (See Chapter 6).

networkslot

0xFF

integer

Determines the timeslot to use for outbound calls. (See Chapter 6).

defaulttone

2

integer

Determines the tone to play when rejecting on timeout:

0: reorder

1: ringing

2: busy

startCP

1

integer

If this parameter is set to 1, the TCP starts call progress when it receives a SETUP ACKNOWLEDGED, PROCEEDING, or ALERTING message, which contains a progress descriptor field or PROGRESS message, (whichever comes first). If none of the listed messages arrive, call progress will be started when CONNECTION CONFIRMATION is received, if the application does not want to connect on signal.

If this parameter is set to 2, the TCP starts call progress on the first call establishment message (SETUP ACKNOWLEDGMENT, PROCEEDING, ALERTING, or PROGRESS) received back from the network, regardless of the progress descriptor.

If this parameter is set to 0, call progress will not be started.

flags

0x1121

mask

Flags which determine when to send PROGRESS, CALL PROCEEDING or ALERTING messages. The values can be ORed for cumulative effect:

This Bit... Causes protocol to send...

PROCEEDING_MASK PROCEEDING on incoming call

PROGRESS_MASK_ANSWER PROGRESS on nccAnswerCall

ALERTING_MASK_ANSWER ALERT on nccAnswerCall

PROCEEDING_MASK_ANSWER PROCEEDING on nccAnswerCall

PROGRESS_MASK_ACCEPT PROGRESS on nccAcceptCall

ALERTING_MASK_ACCEPT ALERT on nccAcceptCall

PROCEEDING_MASK_ACCEPT PROCEEDING on nccAcceptCall

PROGRESS_MASK_REJECT PROGRESS on nccRejectCall

ALERTING_MASK_REJECT ALERT on nccRejectCall

PROCEEDING_MASK_REJECT PROCEEDING on nccRejectCall

blockrejectmode

0

integer

How to reject calls when the channel is blocked with BLOCK_REJECTALL mode:

0 = reject immediate

1 = play busy tone

blockwaittime

3000

ms

Sets the maximum time to wait for the application to respond for an incoming call, before playing a default tone.

ISDNeventmask

0x0000

mask

ISDN informational event mask. Possible values are:

ISDN_PROGRESS Report receiving ISDN progress messages.

For more information about how parameter files are installed, see the NMS ISDN Installation Manual.

NMS ISDN Parameter Files (ADI Service)Top of Page

Two types of parameter files are installed with each package for use with the ADI service:
File Type/Name

Description

isdcty.pf

· cty is the three character code of the target country. For example, the code for Australia is aus. Thus the version of this file for Australia is isdaus.pf.

A binary parameter file containing the complete set of parameters and default values, including country-specific parameters which should not be changed.

adiisd.pf

A binary parameter file containing the parameters for the country which was chosen as the default during installation.

adiisd.par

An ASCII version of the above file.

In order for Natural Access to load the binary parameter file, the parameter file for the target country must be in one of the directories specified with the AGLOAD environment variable.

When you install NMS ISDN, the installation program asks you for a default country. It creates a copy of the country-specific parameter file for that country, renames it, and places it in the AGLOAD path, as follows:
This file...

Is copied to...

isdcty.pf

...where cty is the code for the default country

NT: \nms\ag\cfg\adiisd.pf

UNIX: opt/nms/ag/cfg/adiisd.pf

adiisd.par

NT: \nms\ag\cfg\adiisd.par

UNIX: opt/nms/ag/cfg/adiisd.par

adiisd.pf defines the parameter category ADIISD. When the TCP is initialized using adiStartProtocol, it is configured as described by the parameters.

Changing Parameter Values

Default values for modifiable NMS ISDN parameters are stored in the binary parameter files. You can safely change the values of these parameters to suit your applications, without risking violation of regulatory approvals. To change these parameters, edit the adiisd.par ASCII parameter file.

To load values specified in these files, your application must:

1. Initialize the Natural Access PRM service so the binary parameter file is loaded.

2. Parse adiisd.par.

3. Do one of the following:

- Call ctaSetParmByName for each parameter specified in the file, to set a new default value. (For an example of this, see the DemoLoadParameters function in the demonstration library supplied with Natural Access.)

or

- Use the ctdaemon program to set the parameters system-wide. See the Natural Access Developer's Reference Manual for more information.

or

- Call ctaLoadParameterFile from within your application.

Any parameter modification must take place before adiStartProtocol is called. When the TCP is initialized using adiStartProtocol, it is configured as described by the parameters.

The following is a list of the modifiable NMS ISDN parameters:
ADI.ISD

Field Name

Default

Units

Description

blockrejectmode

0

internal

Sets the rejection mode for incoming calls when the incoming side is in the blocking state. Valid modes are:

0 Reject immediate.

1 Play a busy tone.

blockwaittime

0

internal

Not used.

defaulttone

2

integer

Determines the tone to play when rejecting on timeout:

0: reorder

1: ringing

2: busy

direction

0

integer

Determines if the channel is inbound, outbound, or bidirectional. (See Chapter 6.)

0: bidirectional

1: inbound

2: outbound

exclusive

1

mask

Determines whether this TCP runs in Exclusive Mode or Non-Exclusive Mode. (See Chapter 6.)

0: Non-Exclusive Mode

1: Exclusive Mode

flags

0x1121

mask

Flags which determine when to send PROGRESS, CALL PROCEEDING, or ALERTING messages:

This Bit... Causes protocol to send...

PROCEEDING_MASK PROCEEDING on incoming call

PROGRESS_MASK_ANSWER PROGRESS on nccAnswerCall

ALERTING_MASK_ANSWER ALERT on nccAnswerCall

PROCEEDING_MASK_ANSWER PROCEEDING on nccAnswerCall

PROGRESS_MASK_ACCEPT PROGRESS on nccAcceptCall

ALERTING_MASK_ACCEPT ALERT on nccAcceptCall

PROCEEDING_MASK_ACCEPT PROCEEDING on nccAcceptCall

PROGRESS_MASK_REJECT PROGRESS on nccRejectCall

ALERTING_MASK_REJECT ALERT on nccRejectCall

PROCEEDING_MASK_REJECT PROCEEDING on nccRejectCall

Note: The settings of bits 13 and 14 are overridden when adiRejectCall is called with ADI_REJECT_FORCE_IMMEDIATE.

networkstream

0xFF

integer

Determines the stream to use for outbound calls. For details, see Chapter 6.

networkslot

0xFF

integer

Determines the timeslot to use for outbound calls. For details, see Chapter 6.

startCP

1

integer

If this parameter is set to 1, the TCP starts call progress when it receives a SETUP ACKNOWLEDGED, PROCEEDING, or ALERTING message, which contains a progress descriptor field or PROGRESS message (whichever comes first). If none of the listed messages arrive, call progress will be started when CONNECTION CONFIRMATION is received, if the application does not want to connect on signal.

If this parameter is set to 2, the TCP starts call progress on the first call establishment message (SETUP ACKNOWLEDGMENT, PROCEEDING, ALERTING, or PROGRESS), received back from the network, regardless of the progress descriptor.

If this parameter is set to 0, call progress will not be started.

waitforPCtime

10000

ms

Sets the maximum time to wait for an application to respond to an incoming call, before playing a default tone.

TCP Parameters That Should Not Be Modified
WARNING:
appaa.gif

Changing the values of most of the parameters in the country-specific .pf files may affect the regulatory approvals in the target country.

The following country-specific TCP parameters should not be modified.

The default values listed in this table are overwritten by values in the country-specific parameter file you select.
ADI.ISD

Field Name

Default

Units

Description

busyampl

45

internal

Determines the amplitude of the busy tone.

busytimeoff

500

ms

Sets the length of the quiet period of the busy tone.

busytimeon

500

ms

Sets the length of the on period in the busy tone, when playing busy.

freqbusyhigh

620

Hz

Sets the high frequency of the busy tone.

freqbusylow

480

Hz

Sets the low frequency of the busy tone.

freqreorderhigh

620

Hz

Sets the high frequency of the reorder tone.

freqreorderlow

480

Hz

Sets the low frequency of the reorder tone.

freqringhigh

480

Hz

Sets the high frequency for the ring when playing ring back.

freqringlow

440

Hz

Sets the low frequency for the ring when playing ring back.

reordertimeoff

250

ms

Sets the length of the off period when playing a reorder tone.

reordertimeon

250

ms

Sets the length of the on period when playing a reorder tone.

ringampl

79

internal

Sets the amplitude of the ring tone.

ringofftime1

3000

ms

Determines the length of the first quiet period in the ring back.

ringofftime2

0

ms

Determines the length of the second quiet period in the ring back.

ringontime

1000

ms

Sets the time for the ring in the ring cycle, when playing ring back.



Table of Contents Index NMS Glossary Previous Page Next Page Version


Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com
Copyright © 2001, Natural MicroSystems, Inc. All rights reserved.