This topic provides an overview of the ISDN Software parameter files for the NCC API as well as information about Changing parameter values.
The following table describes the three types of parameter files that are installed for use with the NCC API:
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. 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 API parameters. Do not change the values in these files. Changing certain values can affect the regulatory approvals in the target country. |
nccxisdn.pf |
A binary parameter file containing a set of ISDN Software parameters and default values. Changing these parameters directly affects all control messages (for example, messages associated with NCC API functions). 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 nccxadicty.pf, nccstartcty.pf, and nccxisdn.pf. |
For NaturalAccess 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.
The NaturalAccess 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... |
In this operating system... |
Are copied to... |
---|---|---|
nccxadicty.pf nccxadicty.par where cty is the code for the default country |
Windows |
\nms\ag\cfg\nccxadi.pf \nms\ag\cfg\nccxadi.par |
nccxadicty.pf nccxadicty.par where cty is the code for the default country |
UNIX |
/opt/nms/ag/cfg/nccxadi.pf /opt/nms/ag/cfg/nccxadi.par |
nccstartcty.pf nccstartcty.par where cty is the code for the default country |
Windows |
\nms\ag\cfg\nccstart.pf \nms\ag\cfg\nccstart.par |
nccstartcty.pf nccstartcty.par where cty is the code for the default country |
UNIX |
/opt/nms/ag/cfg/nccstart.pf /opt/nms/ag/cfg/nccstart.par |
nccxisdn.pf nccxisdn.par |
Windows |
\nms\ag\cfg\nccxisdn.pf \nms\ag\cfg\nccxisdn.par |
nccxisdn.pf nccxisdn.par |
UNIX |
/opt/nms/ag/cfg/nccxisdn.pf /opt/nms/ag/cfg/nccxisdn.par |
The files for only one country must appear in the AGLOAD directory. Otherwise, the parameters will not load.
Complete the following steps to change parameter values in a .pf file:
Step |
Action |
1 |
Modify the value in the corresponding .par file. |
2 |
Initialize the NaturalAccess PRM service so the binary parameter file is loaded. |
3 |
Parse the .par file. |
4 |
Do one of the following:
|
Parameter modification must take place before nccStartProtocol is called to start the TCP (as described in Starting a TCP on a context). When the function call is made, the TCP is programmed as specified by the parameters.
The following tables list all of the parameters in the nccxidsn.pf parameter file. Changing these parameters directly affects call control messages (for example, messages associated with NCC API functions). To change these parameters correctly, you must have knowledge of the ISDN specifications for the target country. See Using extended parameters for more information.
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. |
nccAnswerCall
Field name |
Default |
Units |
Description |
---|---|---|---|
uui |
"" |
char |
User-to-user information (up to 132 characters). |
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. |
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. (If supported. Possible values for this field are defined in isdnval.h.) |
CALLEDNUM.type |
0 |
integer |
Q.931 numbering type of called address. (If supported. Possible values for this field are defined in isdnval.h.) |
CALLINGNUM.plan |
0 |
integer |
Q.931 numbering plan of calling address. (If supported. Possible values for this field are defined in isdnval.h.) |
CALLINGNUM.type |
0 |
integer |
Q.931 numbering type of calling address. (If supported. Possible values for this field are defined in isdnval.h.) |
CALLINGNUM.screen |
0 |
integer |
Q.931 screening indicator. (If supported. Possible values for this field are defined in isdnval.h.) |
CALLINGNUM.presentation |
0 |
integer |
Q.931 presentation indicator for calling address. (If supported. Possible values for this field are defined in isdnval.h.) |
getcallid |
0 |
integer |
Set to 1 to request callid on call setup. |
REDIRECTINGNUM.digits |
"" |
char |
The redirecting address. (If supported. Possible values for this field are defined in isdnval.h.) |
REDIRECTINGNUM.pad |
3 |
integer |
Pad |
REDIRECTINGNUM.plan |
0 |
integer |
Q.931 numbering plan of redirecting address. (If supported. Possible values for this field are defined in isdnval.h.) |
REDIRECTINGNUM.type |
0 |
integer |
Q.931 numbering type of redirecting address. (If supported. Possible values for this field are defined in isdnval.h.) |
REDIRECTINGNUM.screen |
0 |
integer |
Q.931 redirecting number screening indicator. (If supported. Possible values for this field are defined in isdnval.h.) |
REDIRECTINGNUM.presentation |
0 |
integer |
Q.931 presentation indicator for redirecting address. (If supported. Possible values for this field are defined in isdnval.h.) |
REDIRECTINGNUM.reason |
0 |
integer |
Q.931 reason for redirection. (If supported. Possible values for this field are defined in isdnval.h.) |
REDIRECTINGNUM.pad1 |
0 |
integer |
Pad1 |
service |
0 |
integer |
Q.931 service. |
nsf_present |
0 |
integer |
Network-specific facilities (NSF): 1 = present |
nsf_service_feature |
0 |
integer |
NSF service or feature: 1 = SERVICE |
nsf_facility_coding |
0 |
integer |
NSF service or feature ID. |
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 |
nccSendDigits
Field fame |
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 |
Possible values for these fields are defined in isdnval.h.
nccStartProtocol
Field name |
Default |
Units |
Description |
---|---|---|---|
exclusive |
1 |
integer |
Determines if this TCP runs in exclusive mode or non-exclusive mode. For details, see B channel assignment overview. 0 - Non-exclusive mode |
direction |
0 |
integer |
Determines if the channel is inbound, outbound, or bidirectional. See B channel assignment overview. 0 - bidirectional (default) |
networkstream |
0xFFFF |
integer |
Determines the stream to use for outbound calls. See B channel assignment overview. |
networkslot |
0xFFFF |
integer |
Determines the timeslot to use for outbound calls. See B channel assignment overview. |
defaulttone |
2 |
integer |
Determines the tone to play when rejecting on timeout: 0 - reorder |
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 is 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 is not started. |
flags |
0x1121 |
mask |
Flags (defined in nccxisdn.h) that determine when to send PROGRESS, CALL PROCEEDING, or ALERTING messages. The values can be ORed for cumulative effect. See Flags field bit settings. |
blockrejectmode |
0 |
integer |
How to reject calls when the channel is blocked with BLOCK_REJECTALL mode: 0 - reject immediate |
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 (defined in nccxisdn.h). ISDN_REPORT_PROGRESS indicates that ISDN progress messages are being received. |
For more information about how parameter files are installed, see the Dialogic® NaturalAccess™ ISDN Software Installation Manual.
Flags defined in nccxisdn.h 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 |