TOC PREV NEXT INDEX

Wireless Data Server 2.1

Administrator's Guide

View in pdf format
Go to User's Guide



Configuration


This chapter describes in detail the configurable parameters controlling the operation of Wireless Data Server.

Server configuration

The administrator can control and define server behaviour using configurable parameters located in the /etc/config/wds.ini file. These parameters should be reviewed and tuned on a per installation basis. In addition, certain parameters in the /users/unison/misc/unison.ini must be modified. Consult the product Readme file for details.

The stated default values are not necessarily the optimal settings for your installation. It is strongly recommended that for reference purposes you keep a copy, in either printed or electronic format, of this file before modification.

NOTE:

When a parameter is not supplied, the default value is automatically assumed.

Configuration parameters

The following table lists all parameters by section. The sections, as well as the individual parameters within each section, are listed in alphabetical order. Use this table to look up a parameter, get a brief description of what it does, and determine what page it is on.

Table 2.1 · Server configuration parameters
Section Parameter Description Page
[<DCE>] debug Debug mode 22

errlog Error logging 23

logfile Log file name 23

msisdn Wireless Data Server's MSISDN number 24

port DCE serial port 23

smscmsisdn SMSC MSISDN 24

smsmode DCE SMS mode 24

speed DCE connection data rate 25

stats Stats mode 25

trace Trace mode 25
[LIC] license Product license 14
[<SMPP>] enquirelink ENQUIRE_LINK operation 26

enquirelink_timeinterval Interval between ENQUIRE_LINK operations 26

host SMSC IP address 26

msisdn Wireless Data Server's MSISDN number 27

msisdnnpi MSISDN numbering plan indicator 27

msisdnton MSISDN number type 27

passwd Password 27

port SMSC port number 28

systemid System ID 28

systemtype System type 28

throttle_smsmsgburst Committed burst size 29

throttle_smsmsgrate Committed information rate 29

throttle_timeinterval Committed rate measurement interval 30
[<SONERA-CGW>] debug Logging internal CGWAPI messages 30

debuglogfile Filename for CGWAPI log messages 31

keepalive Keepalive packets 31

providerhost Host address 32

servicename Service name 32

serviceport Port for incoming messages 32
[<UCP>] confile Location of UCP configuration file 31

dcs Wireless Data Server data coding scheme 32

host SMSC address 30

localhost Local WDS host address 31

msisdn Wireless Data Server MSISDN 31

msisdntoa Wireless Data Server's type of address 32

port SMSC port number 30

throttle_smsmsgburst Committed burst size 32

throttle_smsmsgrate Committed information rate 33

throttle_timeinterval Committed rate measurement interval 33
[<UNISON>] host Calendar server host name 21

node Calendar server node-ID 21

passwd Calendar server SysOp password 22
[WDS] blockedmsisdns Blocked MSISDN numbers 14

buffertranslog Transaction log buffering 16

confirmcalevents Accept and decline new meetings 21

debug Debug mode 15

msgrefnum Message reference number 15

nbsrefnum Narrowband Socket datagram reference number 16

port Wireless Data Server port 17

smsccharset Character set used by the SMSC connection 17

smscconnections Section name(s) of all SMSC connections 17

smscplugin SMSC plug-in 18

smtpmsgdir SMTP message storage directory 18

summaryminsize Minimum vCalendar summary size 18

trace Trace mode 19

transid Transaction reference number 16

translogbuffersize Transaction log buffer size 17

unisoncachesize Cache size 19

unisonconnections Section name(s) of all calendar server connections 19

userepeatsymbol Repeat symbol 20

wreqmsgdir Incoming request storage directory 20

wreqvalidityperiod Expiry time limit 20

The following parameter descriptions are divided into common and installation-specific sections.

NOTE:

A word about section names

All section names enclosed in angle-brackets are variables. They should be changed according to the setup of your system. For example, the section referred to throughout this text as [<UNISON>] could have any name. Similarly, the [<DCE>] or [<SMPP>] sections should be renamed according to your preference.

For each section, choose a name descriptive of the connection it configures. For example, to set up connections to node 144 and 145 of a calendar server named "Scribe", you would have two [<UNISON>] sections, perhaps titled [SCRIBE_144] and [SCRIBE_145] respectively. Whatever names you choose, however, be sure to specify them using the [WDS] smscconnection and unisonconnections parameters.



Common Parameters

The following parameters, in the [LIC], [WDS] and [<UNISON>] sections, apply to all installations of Wireless Data Server, regardless of the plug-in used to connect to the wireless network.


Product license

Section

[LIC]

Parameter

license

Description

Your confidential license key, provided by your Steltor representative. Do not change the value of this parameter without explicit instructions from technical support personnel.

Accepted values

N/A

Default value

None


Blocked MSISDN numbers

Section

[WDS]

Parameter

blockedmsisdns

Description

A list of MSISDN numbers to which Wireless Data Server will not send SMS messages.

Accepted values

A list of valid MSISDN numbers, separated by commas and enclosed in {}. For example:

{+15145551234, +15145556789}

Please note: this list should always contain the MSISDN numbers of all Wireless Data Server gateways to avoid the possibility of a circular loop.

Default value

{ }


Debug mode

Section

[WDS]

Parameter

debug

Description

Logs input/output data in wds.log.

Accepted values

TRUE (Debug mode on)

FALSE (Debug mode off)

Default value

FALSE


Message reference number

Section

[WDS]

Parameter

msgrefnum

Description

A reference number for the transmission of request, notification and system messages. Wireless Data Server increments this value automatically. Do not change the value of this parameter without explicit instructions from technical support personnel.

Accepted values

A positive integer.

Default value

0


Narrowband Socket datagram reference number

Section

[WDS]

Parameter

nbsrefnum

Description

A reference number for the transmission of Narrowband Socket datagrams. Wireless Data Server increments this value automatically. Do not change the value of this parameter without explicit instructions from technical support personnel.

Accepted values

A positive integer.

Default value

0


Transaction reference number

Section

[WDS]

Parameter

transid

Description

A reference number for Wireless Data Server transactions. Wireless Data Server increments this value automatically. Do not change the value of this parameter without explicit instructions from technical support personnel.

Accepted values

A positive integer.

Default value

1


Transaction log buffering

Section

[WDS]

Parameter

buffertranslog

Description

Determines whether or not to buffer transactions in memory before writing them to the transaction log in order to improve performance. See also [WDS] translogbuffersize.

Accepted values

TRUE (buffer transactions)

FALSE (write transactions directly to the log)

Default value

FALSE


Transaction log buffer size

Section

[WDS]

Parameter

translogbuffersize

Description

Determines the number of transactions Wireless Data Server will buffer before recording them in the transaction log. See also [WDS] translogbuffersize.

Accepted values

A positive integer

Default value

10


Wireless Data Server port

Section

[WDS]

Parameter

port

Description

Specifies the port used by Wireless Data Server.

Accepted values

Any valid port number.

Default value

4573


Character set used by the SMSC connection

Section

[WDS]

Parameter

smsccharset

Description

Specifies the character set used by the SMSC connection. Please see the readme file provided with your installation for instructions on setting this parameter.

Accepted values

Any valid character set.

Default value

None


Section name(s) of all SMSC connections

Section

[WDS]

Parameter

smscconnections

Description

A list of section names for all SMSC connections configured in wds.ini.

Accepted values

A list of strings, enclosed in curly braces and separated by commas. For example:

{ CONNECT1, CONNECT2 }

Default value

{ }


SMSC plug-in

Section

[WDS]

Parameter

smscplugin

Description

Specifies the plug-in for Wireless Data Server to use to connect to the SMS Centre. Set this parameter according to your installation type, as instructed in the Readme.

Accepted values

/wds/bin/smscdce.dll (for DCE connections only)

/wds/bin/smsccgw.dll (for SONERA-CGW connections only)

/wds/bin/smscsmpp.dll (for SMPP connections only)

/wds/bin/smscucp.dll (for UCP connections only)

Default value

None


SMTP message storage directory

Section

[WDS]

Parameter

smtpmsgdir

Description

The subdirectory in which Wireless Data Server stores incoming SMTP messages. The specified directory will be created within Wireless Data Server's db directory (e.g. /wds/db).

Accepted values

Any valid directory name.

Default value

. (db directory itself, e.g. /wds/db)


Minimum vCalendar summary size

Section

[WDS]

Parameter

summaryminsize

Description

Specifies the minimum size for the vCalendar SUMMARY property (Nokia 61xx only). Do not change the value of this parameter without explicit instructions from technical support personnel.

Accepted values

A positive integer.

Default value

15


Trace mode

Section

[WDS]

Parameter

trace

Description

Prints every function call Wireless Data Server makes to wds.log.

Accepted values

TRUE (Trace mode on)

FALSE (Trace mode off)

Default value

FALSE


Cache size

Section

[WDS]

Parameter

unisoncachesize

Description

Specifies the maximum number of users for whom to store information in memory.

Accepted values

A positive integer.

Default value

100


Section name(s) of all calendar server connections

Section

[WDS]

Parameter

unisonconnections

Description

A list of section names for all calendar server connections configured in wds.ini.

Accepted values

A list of strings, enclosed in curly braces and separated by commas. For example:

{ SCRIBE, CLIO }

Default value

{ }


Repeat symbol

Section

[WDS]

Parameter

userepeatsymbol

Description

Allows the use of the repeat symbol ("R") to designate repeating events, instead of sending multiple SMS messages. The value of this parameter only affects phones set to receive events as vCalendar objects. Text messages will always use the repeat symbol.

Accepted values

TRUE (Repeat symbol enabled)

FALSE (Repeat symbol disabled)

Default value

TRUE


Incoming request storage directory

Section

[WDS]

Parameter

wreqmsgdir

Description

The subdirectory in which Wireless Data Server stores incoming messages from the SMS Centre. The specified directory will be created within Wireless Data Server's db directory (e.g. /wds/db).

Accepted values

Any valid directory name.

Default value

. (db directory itself, e.g. /wds/db)


Expiry time limit

Section

[WDS]

Parameter

wreqvalidityperiod

Description

Specifies the length of time in hours before unprocessed wireless requests expire.

Accepted values

A positive integer.

Default value

2


Accept and decline new meetings

Section

[WDS]

Parameter

confirmcalevents

Description

Specifies whether or not users can accept and decline new meetings by replying to notification messages. See the Wireless Data Server User's Guide for more details.

Accepted values

TRUE (Users can accept or decline)

FALSE (No option to accept or decline)

Default value

FALSE


Calendar server host name

Section

[<UNISON>]

Parameter

host

Description

The name of the calendar server's host.

Accepted values

Any valid host name.

Default value

None


Calendar server node-ID

Section

[<UNISON>]

Parameter

node

Description

A node-ID on the calendar server specified by the [<UNISON>] host parameter.

Accepted values

Any valid node-ID.

Default value

None


Calendar server SysOp password

Section

[<UNISON>]

Parameter

passwd

Description

Encrypted SysOp password for the calendar server node specified by the node parameter in this [<UNISON>] section. Run cspasswd.exe to set this parameter for each [<UNISON>] section in wds.ini. For more information on using cspasswd.exe, consult the Readme file provided to you with Wireless Data Server.

Accepted values

Alphanumeric string. For example:

3d747b104e0d087f4d

Default value

None

Default value

None



Installation-specific parameters

This section describes the parameters used in the [<DCE>], [<SONERA-CGW>] and [<SMPP>] sections. Please see A word about section names.


Debug mode

Section

[<DCE>]

Parameter

debug

Description

Logs input/output data in wds.log and/or the file specified by the [<DCE>] logfile parameter. Supercedes the [WDS] debug parameter for the connection configured in this [<DCE>] section.

Accepted values

TRUE (Debug mode on)

FALSE (Debug mode off)

Default value

FALSE


Error logging

Section

[<DCE>]

Parameter

errlog

Description

Forces the logging of all errors to wds.log and/or the file specified by the [<DCE>] logfile parameter. Unexpected errors are always logged, regardless of this parameter.

Accepted values

TRUE (Error logging on)

FALSE (Error logging off)

Default value

FALSE


Log file name

Section

[<DCE>]

Parameter

logfile

Description

Specifies a file for log messages concerning only the connection between Wireless Data Server and GSM modem. Wireless Data Server will still print its internal log messages to wds.log.

Accepted values

Any valid filename.

Please note: Wireless Data Server will preface your filename with the default path of its log directory (/wds/log/).

Default value

If this parameter is left blank, Wireless Data Server will print all log messages to wds.log.


DCE serial port

Section

[<DCE>]

Parameter

port

Description

Specifies the serial port to which the DCE is connected.

Accepted values

Any valid port.

Default value

COM1


DCE SMS mode

Section

[<DCE>]

Parameter

smsmode

Description

Specifies whether the DCE uses text or Protocol Data Unit (PDU) mode.

Note: If you set the value of this parameter to 1, you must set the value of the [WDS] smsccharset parameter to MSCP437. In this case, users with Nokia 71xx phones will not be able to create events using calendar notes.

Accepted values

0 (PDU)

1 (text)

Default value

0


Wireless Data Server's MSISDN number

Section

[<DCE>]

Parameter

msisdn

Description

Wireless Data Server's MSISDN number.

Accepted values

Any valid MSISDN number.

Default value

None


SMSC MSISDN

Section

[<DCE>]

Parameter

smscmsisdn

Description

Specifies the MSISDN number of the SMS Centre.

Accepted values

Any numeric string.

Default value

None


DCE connection data rate

Section

[<DCE>]

Parameter

speed

Description

Specifies the data rate of transmissions to and from the DCE in bits per second (bps).

Accepted values

A positive integer.

Default value

19200


Stats mode

Section

[<DCE>]

Parameter

stats

Description

Prints statistics concerning connection time and other information to wds.log and/or the file specified by the [<DCE>] logfile parameter. Supercedes the [WDS] stats parameter for the connection configured in this [<DCE>] section.

Accepted values

TRUE (Stats mode on)

FALSE (Stats mode off)

Default value

FALSE


Trace mode

Section

[<DCE>]

Parameter

trace

Description

Prints every function call Wireless Data Server makes to wds.log and/or the file specified by the [<DCE>] logfile parameter. Supercedes the [WDS] trace parameter for the connection configured in this [<DCE>] section.

Accepted values

TRUE (Trace mode on)

FALSE (Trace mode off)

Default value

FALSE


ENQUIRE_LINK operation

Section

[<SMPP>]

Parameter

enquirelink

Description

Enables and disables ENQUIRE_LINK operations from Wireless Data Server to SMS Centre.

Accepted values

TRUE (Enables ENQUIRE_LINK)

FALSE (Disables ENQUIRE_LINK)

Default value

TRUE


Interval between ENQUIRE_LINK operations

Section

[<SMPP>]

Parameter

enquirelink_timeinterval

Description

Time interval between successive ENQUIRE_LINK operations from Wireless Data Server to SMS Centre, in seconds.

Accepted values

Any integer.

Default value

2700 (45 minutes)


SMSC IP address

Section

[<SMPP>]

Parameter

host

Description

The IP address of the SMS Centre.

Accepted values

Any correctly-formatted IP address. For example:

123.45.67.89

Default value

127.0.0.1


Wireless Data Server's MSISDN number

Section

[<SMPP>]

Parameter

msisdn

Description

Wireless Data Server's MSISDN number.

Accepted values

Any valid MSISDN number.

Default value

None


MSISDN numbering plan indicator

Section

[<SMPP>]

Parameter

msisdnnpi

Description

A number indicating Wireless Data Server's MSISDN numbering plan. For more information, please see GSM 03.40, 9.1.2.5.

Accepted values

An integer between 0 and 15 inclusive.

Default value

0


MSISDN number type

Section

[<SMPP>]

Parameter

msisdnton

Description

Wireless Data Server's type of MSISDN number. For more information, please see GSM 03.40, 9.1.2.5.

Accepted values

An integer between 0 and 7 inclusive.

Default value

None


Password

Section

[<SMPP>]

Parameter

passwd

Description

Wireless Data Server's encrypted password. Please see the Readme file for instructions on using cspasswd.exe to set the value of this parameter.

Accepted values

Alphanumeric string. For example:

3d747b104e0d087f4d

Default value

None


SMSC port number

Section

[<SMPP>]

Parameter

port

Description

The port number of the SMS Centre.

Accepted values

Any valid port number.

Default value

2775


System ID

Section

[<SMPP>]

Parameter

systemid

Description

Wireless Data Server's system identifier.

Accepted values

Numeric string. For example:

8888888129

Default value

None


System type

Section

[<SMPP>]

Parameter

systemtype

Description

Wireless Data Server's system type.

Accepted values

Any valid system type, or none.

Default value

None


Committed burst size

Section

[<SMPP>]

Parameter

throttle_smsmsgburst

Description

The number of messages allowed by the SMS Centre in the time interval specified by the [<SMPP>] throttle_timeinterval parameter.

Please note: configure only two of the three throttle parameters (throttle_timeinterval, throttle_smsmsgburst, and throttle_smsmsgrate). The third will be determined according to the following equation:

timeinterval = smsmsgburst / smsmsgrate

Accepted values

Any integer.

Default value

0


Committed information rate

Section

[<SMPP>]

Parameter

throttle_smsmsgrate

Description

The number of messages allowed by the SMS Centre over a given period of time. Specify the number of messages and time interval using the [<SMPP>] throttle_smsmsgburst and throttle_timeinterval parameters.

Please note: configure only two of the three throttle parameters (throttle_timeinterval, throttle_smsmsgburst, and throttle_smsmsgrate). The third will be determined according to the following equation:

timeinterval = smsmsgburst / smsmsgrate

Accepted values

Any real number.

Default value

0.0


Committed rate measurement interval

Section

[<SMPP>]

Parameter

throttle_timeinterval

Description

The span of time during which a number of SMS messages specified by the [<SMPP>] throttle_smsmsgburst parameter may be sent to the SMS Centre.

Please note: configure only two of the three throttle parameters (throttle_timeinterval, throttle_smsmsgburst, and throttle_smsmsgrate). The third will be determined according to the following equation:

timeinterval = smsmsgburst / smsmsgrate

Accepted values

Any integer.

Default value

0


SMSC address

Section

[<UCP>]

Parameter

host

Description

The network address of the SMSC.

Accepted values

Any valid IP address or host name.

Default value

127.0.0.1


SMSC port number

Section

[<UCP>]

Parameter

port

Description

The port number of the SMS Centre.

Accepted values

Any valid port number.

Default value

3000


Local WDS host address

Section

[<UCP>]

Parameter

localhost

Description

The network address of the WDS.

Accepted values

Any valid IP address or host name.

Default value

127.0.0.1


Location of UCP configuration file

Section

[<UCP>]

Parameter

confile

Description

The location of the file containing the following UCP configuration information:

[NAF]

networks TCP/IP

If no such file exists on your system, this information may also be kept in the wds.ini file. In that case, set the value of the confile parameter to the path and filename of wds.ini (e.g. C:\wds\config\wds.ini).