(Page 1 of 1 in this chapter) Version

Appendix D

Parameters

Introduction
Parameter Groups
Parameter Files
Parameter Names
Loading Parameters
Changing Parameter Values
NCC Service Global Parameters
eventmask Bits

Introduction

The behavior of most NCC functions, and of the operating protocol itself, can be controlled using parameters. This appendix describes how parameters are supplied, how to load them, and how to change their values if necessary. It also lists NCC service implementation-independent, protocol-independent parameters.

Parameter Groups

NCC parameters come in three groups, depending upon whether they are implementation- or protocol-dependent:

Parameter Files

NCC parameters are stored in binary parameter files. ASCII versions of these files are also available. These parameter files have country- or protocol-specific values that are used for the target country for your application. Natural Microsystems uses the following naming convention for its NCC service-related parameter files:
Name

 Contents

nccstart.pf

 Implementation-independent, protocol-independent NCC parameters. Since these go into effect when a protocol is started with nccStartProtocol, the word "start" appears in the name.

nccximp.pf

 Implementation-dependent, protocol-independent NCC parameters. imp represents the implementation. For example, for the ADI implementation, the filename is nccxadi.pf.

nccxprt.pf

 Implementation-dependent, protocol-dependent NCC parameters. prt represents the protocol or protocol family that the file is for. For example, the AG CAS (Channel-Associated Signaling) protocols have filenames such as nccxcas.pf and nccxlps.pf.

Parameter Names

NCC service parameters are named according to the following syntax:

SvcName.[X.][implementation_]category.[subStructure.]fieldName

... where:
Name

 Description

SvcName

 The service to which the parameter belongs. For NCC service parameters, this is NCC.

X

 (optional) This indicator appears in the parameter name unless the parameter is supported by all implementations.

implementation

 (optional) The implementation that the parameter is for. Empty if the parameter is for all implementations.

category

 The parameter category (usually represents the function or protocol that the parameter concerns).

subStructure

 (optional) Allows multiple, logically related fieldNames to be nested under a category.

fieldName

 The actual parameter.

The following are some sample parameter names:
Parameter Name

 Description

NCC.START.xxx

 NCC service implementation-independent, protocol-independent parameters. These go into effect when nccStartProtocol is invoked.

NCC.X.ADI_START.xxx

 Protocol-independent parameters for the ADI implementation of the NCC service. These go into effect when nccStartProtocol is invoked.

NCC.X.ADI_PLACECALL.xxx

 Protocol-independent parameters for the ADI implementation of the NCC service. These go into effect when nccPlaceCall is invoked.

NCC.X.ADI_ISDN.ACCEPTCALL.xxx

 AG ISDN parameters for the ADI implementation of the NCC service. These go into effect when nccAcceptCall is invoked.

Loading Parameters

In order for CT Access to load a parameter file, it must be in one of the directories specified with the AGLOAD environment variable. When the function associated with the parameter type is invoked, the parameters go into effect.

Changing Parameter Values

Each parameter structure has a set of default values that is sufficient for many configurations. The parameters can, however, be modified to:

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. Parse the .par file.
    

    

  3. Do one of the following:
    

      

    • Invoke 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 CT Access.)

      

      
OR
      

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

      

      
OR
      

    • Invoke ctaLoadParameterFile from within your application.

      

    


    Parameter modification must take place before nccStartProtocol is invoked to start the protocol (as described in Section 3.3.1). When the function is invoked, the TCP is programmed as specified by the parameters.
    

    

    

     NCC Service Global Parameters
    

    


    This appendix describes NCC implementation-independent, protocol-independent parameters. These parameters are defined in nccstart.pf. The parameters are alphabetized by category and subcategories. Within each category, fields are listed alphabetically.
    


    For information on implementation-dependent or protocol-dependent parameters, see your protocol-specific documentation.
    

    


     

    


    


     NCC.START

    


    
 Dependent Function(s):  nccStartProtocol
    


    
 Field Name
    

    		
 Type
    

    		
 Default
    

    		
 Units
    

    		
 Description
    


    
 eventmask
    

    		
 DWORD
    

    		
 0x0000
    

    		
 mask
    

    		
 Determines whether or not certain events will be sent to the application. For details, see below.
    


    
 debugflag
    

    		
 WORD
    

    		
 0
    

    		
 integer
    

    		
 Off (0) or on (non-zero). Used to report low-level debug events to the application. 
    


    
 waitforPCtime
    

    		
 WORD
    

    		
 10000
    

    		
 ms
    

    		
 Time to wait for the application to respond after an NCCEVN_INCOMING_CALL. If a response is not received within the timeout, the incoming call is rejected.
    


    
 overlappedreceiving
    

    		
 WORD
    

    		
 0
    

    		
 integer
    

    		
 Determines if the protocol will receive digits in overlapped receiving mode.
    



    


    

    

    

    

    
 

    


    


     NCC.START.callproggenerate

    


    
 Dependent Function(s):  nccStartProtocol
    


    
 Field Name
    

    		
 Type
    

    		
 Default
    

    		
 Units
    

    		
 Description
    


    
 dialtonefreq1
    

    		
 WORD
    

    		
 350
    

    		
 Hz
    

    		
 First frequency of dialtone
    


    
 dialtonefreq2
    

    		
 WORD
    

    		
 440
    

    		
 Hz
    

    		
 Second frequency of dialtone
    


    
 dialtoneontime1
    

    		
 WORD
    

    		
 -1
    

    		
 ms
    

    		
 Cadenced dialtone: first ON time
    


    
 dialtoneontime2
    

    		
 WORD
    

    		
 0
    

    		
 ms
    

    		
 Cadenced dialtone: second ON time
    


    
 dialtoneofftime1
    

    		
 WORD
    

    		
 0
    

    		
 ms
    

    		
 Cadenced dialtone: first OFF time
    


    
 dialtoneofftime2
    

    		
 WORD
    

    		
 0
    

    		
 ms
    

    		
 Cadenced dialtone: second OFF time
    


    
 dialtonelevel
    

    		
 WORD
    

    		
 150
    

    		
 IDU
    

    		
 Dialtone amplitude
    


    
 ringfreq1
    

    		
 WORD
    

    		
 440
    

    		
 Hz
    

    		
 First frequency of ringback tone
    


    
 ringfreq2
    

    		
 WORD
    

    		
 480
    

    		
 Hz
    

    		
 Second frequency of ringback tone
    


    
 ringontime
    

    		
 WORD
    

    		
 1000
    

    		
 ms
    

    		
 Ringback tone ON time
    


    
 ringofftime1
    

    		
 WORD
    

    		
 3000
    

    		
 ms
    

    		
 Ringback tone first (or only) OFF time
    


    
 ringofftime2
    

    		
 WORD
    

    		
 0
    

    		
 ms
    

    		
 Ringback tone second OFF time
    


    
 ringtonelevel
    

    		
 WORD
    

    		
 112
    

    		
 IDU
    

    		
 Ringback tone amplitude
    


    
 busyfreq1
    

    		
 WORD
    

    		
 480
    

    		
 Hz
    

    		
 First frequency of busy tone
    


    
 busyfreq2
    

    		
 WORD
    

    		
 620
    

    		
 Hz
    

    		
 Second frequency of busy tone
    


    
 busyontime
    

    		
 WORD
    

    		
 500
    

    		
 ms
    

    		
 Busy tone ON time
    


    
 busyofftime
    

    		
 WORD
    

    		
 500
    

    		
 ms
    

    		
 Busy tone OFF time
    


    
 busytonelevel
    

    		
 WORD
    

    		
 63
    

    		
 Hz
    

    		
 Busy tone amplitude
    


    
 fastbusyfreq1
    

    		
 WORD
    

    		
 480
    

    		
 Hz
    

    		
 First frequency of fast busy (reorder) tone
    


    
 fastbusyfreq2
    

    		
 WORD
    

    		
 620
    

    		
 Hz
    

    		
 Second frequency of fast busy (reorder) tone
    


    
 fastbusyontime
    

    		
 WORD
    

    		
 250
    

    		
 ms
    

    		
 Fast busy tone ON time
    


    
 fastbusyofftime
    

    		
 WORD
    

    		
 250
    

    		
 ms
    

    		
 Fast busy tone OFF time
    


    
 fastbusytonelevel
    

    		
 WORD
    

    		
 63
    

    		
 IDU
    

    		
 Fast busy tone amplitude
    



    


    

    

    

    


    

    

    

     eventmask Bits
    

    


    The NCC.START.eventmask parameter controls whether certain events are returned to the application. The following is a list of eventmask bits, and the events they control: 

    


    
 Value
    

    		
 Bit Name
    

    		
 Event Reported
    


    
 0x4
    

    		
 NCC_REPORT_ALERTING
    

    		
 NCCEVN_REMOTE_ALERTING
    


    
 0x8
    

    		
 NCC_REPORT_ANSWERED
    

    		
 NCCEVN_REMOTE_ANSWERED
    


    
 0x20
    

    		
 NCC_REPORT_BILLING
    

    		
 NCCEVN_BILLING_INDICATION
    


    
 0x40
    

    		
 NCC_REPORT_STATUSINFO
    

    		
 NCCEVN_CALL_STATUS_UPDATE, 
    

 NCCEVN_EXTENDED_CALL_STATUS_UPDATE
    



    


    

    

    

    


    

    

    


    
 
    (Page 1 of 1 in this chapter)  Version
    


    
 



    
tech_support@nmss.com

    

Copyright © 1999, Natural MicroSystems, Inc.   All rights
reserved.