|
|
|
|
|
Wireless Data Server 3.0 Beta | Administrator's Guide |
| View in pdf format |
| Go to User's Guide |
Server parameters
This appendix describes in detail the configurable parameters controlling the operation of Wireless Data Server and its SNMP subagent.
Server configurationThe 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.
The following parameter descriptions are divided into common and installation-specific sections.
NOTE: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 ParametersThe 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
Parameter
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
Default value
Blocked MSISDN numbers
Section
Parameter
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:
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
Parameter
Description
Logs input/output data in wds.log.
Accepted values
Default value
Message reference number
Section
Parameter
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
Default value
Narrowband Socket datagram reference number
Section
Parameter
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
Default value
Message fragment size
Section
Parameter
Description
The maximum number of characters allowed in an SMS.
Accepted values
Default value
Transaction reference number
Section
Parameter
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
Default value
Transaction log buffering
Section
Parameter
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
FALSE (write transactions directly to the log)
Default value
Transaction log buffer size
Section
Parameter
Description
Determines the number of transactions Wireless Data Server will buffer before recording them in the transaction log. See also [WDS] translogbuffersize.
Accepted values
Default value
Wireless Data Server port
Section
Parameter
Description
Specifies the port used by Wireless Data Server.
Accepted values
Default value
Character set used by the SMSC connection
Section
Parameter
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
Default value
Section name(s) of all SMSC connections
Section
Parameter
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:
Default value
SMSC plug-in
Section
Parameter
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
Section name(s) of all Instant Messaging connections
Section
Parameter
Description
A list of section names for all connections to the Instant Messaging server configured in wds.ini.
Accepted values
A list of strings, enclosed in curly braces and separated by commas. For example:
Default value
Instant Messaging plug-in
Section
Parameter
Description
Specifies the plug-in for Wireless Data Server to use to connect to the Instant Messaging server.
Accepted values
Default value
SMTP message storage directory
Section
Parameter
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
Default value
. (db directory itself, e.g. /wds/db)
Minimum vCalendar summary size
Section
Parameter
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
Default value
Trace mode
Section
Parameter
Description
Prints every function call Wireless Data Server makes to wds.log.
Accepted values
Default value
Cache size
Section
Parameter
Description
Specifies the maximum number of users for whom to store information in memory.
Accepted values
Default value
Section name(s) of all calendar server connections
Section
Parameter
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:
Default value
Repeat symbol
Section
Parameter
Description
Currently obsolete in version 3.0 Beta.
Accepted values
Default value
Incoming request storage directory
Section
Parameter
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
Default value
. (db directory itself, e.g. /wds/db)
Expiry time limit
Section
Parameter
Description
Specifies the length of time in hours before unprocessed wireless requests expire.
Accepted values
Default value
Accept and decline new meetings
Section
Parameter
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
Mobile-originated services
Section
Parameter
Description
Specifies the list of services Wireless Data Server offers for processing mobile-originated commands, separated by commas and enclosed by {}. Currently, the calendar service is the only mobile-originated service supported by Wireless Data Server.
Accepted values
Default value
SNMP port
Section
Parameter
Description
Specifies the UDP port to use for communications with the SNMP subagent.
Accepted values
Default value
SNMP refresh interval for changed data
Section
Parameter
Description
Specifies the interval in seconds at which Wireless Data Server will update the SNMP subagent with any information that has changed since the last update.
Accepted values
Default value
SNMP refresh interval for all data
Section
Parameter
Description
Specifies the interval in seconds at which Wireless Data Server will update the SNMP subagent with all information, regardless of whether or not it has been changed since the last update. This should be done periodically to ensure the consistency of all data between Wireless Data Server and subagent in the case that any previous updates did not propagate correctly.
Accepted values
Default value
Calendar server host name
Section
Parameter
Description
The name of the calendar server's host.
Accepted values
Default value
Calendar server node-ID
Section
Parameter
Description
A node-ID on the calendar server specified by the [<UNISON>] host parameter.
Accepted values
Default value
Calendar server SysOp password
Section
Parameter
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:
Default value
Default value
Calendar server connection SNMP index
Section
Parameter
Description
Specifies an index number to refer to this IM connection. See MIB number 3.6.1 in Appendix C, "Wireless Data Server MIBs," for more details.
Accepted values
Default value
Calendar service localization file
Section
Parameter
Description
Specifies a file to consult for localized mobile-originated commands. By default, Wireless Data Server will look for the specified file in the /etc/config/ directory.
Accepted values
Default value
Installation-specific parametersThis section describes the parameters used in the [<DCE>], [<SONERA-CGW>] and [<SMPP>] sections. Please see A word about section names.
Debug mode
Section
Parameter
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
Default value
Error logging
Section
Parameter
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
Default value
Log file name
Section
Parameter
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
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
Parameter
Description
Specifies the serial port to which the DCE is connected.
Accepted values
Default value
DCE SMS mode
Section
Parameter
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
Default value
Wireless Data Server's MSISDN number
Section
Parameter
Description
Wireless Data Server's MSISDN number.
Accepted values
Default value
SMSC MSISDN
Section
Parameter
Description
Specifies the MSISDN number of the SMS Centre.
Accepted values
Default value
DCE connection data rate
Section
Parameter
Description
Specifies the data rate of transmissions to and from the DCE in bits per second (bps).
Accepted values
Default value
Stats mode
Section
Parameter
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
Default value
Trace mode
Section
Parameter
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
Default value
DCE connection SNMP index
Section
Parameter
Description
Specifies an index number to refer to this IM connection. See MIB number 3.8.1 in Appendix C, "Wireless Data Server MIBs," for more details.
Accepted values
Default value
ENQUIRE_LINK operation
Section
Parameter
Description
Enables and disables ENQUIRE_LINK operations from Wireless Data Server to SMS Centre.
Accepted values
Default value
Interval between ENQUIRE_LINK operations
Section
Parameter
Description
Time interval between successive ENQUIRE_LINK operations from Wireless Data Server to SMS Centre, in seconds.
Accepted values
Default value
SMSC IP address
Section
Parameter
Description
The IP address of the SMS Centre.
Accepted values
Any correctly-formatted IP address. For example:
Default value
Wireless Data Server's MSISDN number
Section
Parameter
Description
Wireless Data Server's MSISDN number.
Accepted values
Default value
MSISDN numbering plan indicator
Section
Parameter
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
MSISDN number type
Section
Parameter
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
Password
Section
Parameter
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:
Default value
SMSC port number
Section
Parameter
Description
The port number of the SMS Centre.
Accepted values
Default value
System ID
Section
Parameter
Description
Wireless Data Server's system identifier.
Accepted values
Default value
System type
Section
Parameter
Description
Wireless Data Server's system type.
Accepted values
Any valid system type, or none.
Default value
Committed burst size
Section
Parameter
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
Default value
Committed information rate
Section
Parameter
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
Default value
Committed rate measurement interval
Section
Parameter
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
Default value
SMPP connection SNMP index
Section
Parameter
Description
Specifies an index number to refer to this IM connection. See MIB number 3.8.1 in Appendix C, "Wireless Data Server MIBs," for more details.
Accepted values
Default value
SMSC address
Section
Parameter
Description
The network address of the SMSC.
Accepted values
Any valid IP address or host name.
Default value
SMSC port number
Section
Parameter
Description
The port number of the SMS Centre.
Accepted values
Default value
Local WDS host address
Section
Parameter
Description
The network address of the WDS.
Accepted values
Any valid IP address or host name.
Default value
Location of UCP configuration file
Section
Parameter
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).
This parameter is required for Windows installations of Wireless Data Server.
Accepted values
Default value
Wireless Data Server MSISDN
Section
Parameter
Description
Wireless Data Server's MSISDN.
Accepted values
Any valid MSISDN number or alphanumeric address. See also the [<UCP>] msisdntoa parameter.
Default value
Wireless Data Server's type of address
Section
Parameter
Description
The type of MSISDN address used by Wireless Data Server. Only change the value of this parameter if Wireless Data Server uses an alphanumeric MSISDN address, not a standard number (e.g. +15147338500).
Accepted values
1139 (NPI telephone and TON International)
Default value
Wireless Data Server data coding scheme
Section
Parameter
Description
The data coding scheme used by Wireless Data Server. It is recommended that you do not change this value without consulting Steltor Support.
Accepted values
1 (user-defined or other type of alphabet)
Default value
Committed burst size
Section
Parameter
Description
The number of messages allowed by the SMS Centre in the time interval specified by the [<UCP>] 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
Default value
Committed information rate
Section
Parameter
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 [<UCP>] 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
Default value
Committed rate measurement interval
Section
Parameter
Description
The span of time during which a number of SMS messages specified by the [<UCP>] 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
Default value
UCP connection SNMP index
Section
Parameter
Description
Specifies an index number to refer to this IM connection. See MIB number 3.8.1 in Appendix C, "Wireless Data Server MIBs," for more details.
Accepted values
Default value
Instant Messaging server address
Section
Parameter
Description
The network name or IP address of the Instant Messaging server.
Accepted values
Any valid host name or IP address.
Default value
Instant Messaging server port
Section
Parameter
Description
The port on which the Instant Messaging server is listening.
Accepted values
Default value
Wireless Data Server Instant Messaging user name
Section
Parameter
Description
The user name on the Instant Messaging server assigned to this Wireless Data Server connection.
Accepted values
Default value
Wireless Data Server Instant Messaging user resource
Section
Parameter
Description
The Jabber resource used by the Instant Messaging user account assigned to this Wireless Data Server connection.
Accepted values
Default value
Wireless Data Server Instant Messaging user password
Section
Parameter
Description
The encrypted password for the Instant Messaging user account assigned to this Wireless Data Server connection. Do not set this parameter manually; use the cspasswd utility instead. For more deatails, see Appendix B, "Server utilities."
Accepted values
The correct password, encrypted through cspasswd.
Default value
Instant Messaging connection SNMP index
Section
Parameter
Description
Specifies an index number to refer to this IM connection. See MIB number 3.12.1 in Appendix C, "Wireless Data Server MIBs," for more details.
Accepted values
Default value
SNMP subagent configurationThe Wireless Data Server SNMP subagent has its own configuration file, etc/config/wdssnmp.ini. Note that this configuration file is in the etc/config subdirectory within the install directory of the subagent itself, not within the install directory of the Wireless Data Server core.
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 A.2 · Subagent configuration parameters
[<WDS>] host WDS host 77 id WDS SNMP ID 78 index WDS SNMP index 78 port WDS port 77 [WDSSNMP] debug Debug mode 75 snmp2wdsport SNMP subagent port 76 stats Stats mode 75 timeout SNMP subagent timeout 76 trace Trace mode 76 wds WDS instances to monitor 77
Debug mode
Section
Parameter
Description
Runs the Wireless Data Server SNMP subagent in debug mode.
Accepted values
Default value
Stats mode
Section
Parameter
Description
Runs the Wireless Data Server SNMP subagent in stats mode.
Accepted values
Default value
Trace mode
Section
Parameter
Description
Runs the Wireless Data Server SNMP subagent in trace mode.
Accepted values
Default value
SNMP subagent port
Section
Parameter
Description
Specifies a port for the SNMP subagent on its host. Do not change this value without express instructions from Steltor support.
Accepted values
Default value
SNMP subagent timeout
Section
Parameter
Description
Specifies a timeout in seconds at which Wireless Data Server and its subagent send idle messages to verify to the other that it is still running.
Accepted values
Default value
WDS instances to monitor
Section
Parameter
Description
A list of section names within the wdssnmp.ini file configuring which Wireless Data Server instances to monitor.
Accepted values
A list of strings, enclosed in curly braces and separated by commas. For example:
Default value
WDS host
Section
Parameter
Description
Specifies the host of this instance of Wireless Data Server.
Accepted values
Default value
WDS port
Section
Parameter
Description
Specifies the port this instance of Wireless Data Server uses to communicate with the SNMP subagent. This value must be the same as the value of the wds.ini [WDS] snmppport parameter used by this instance of Wireless Data Server.
Accepted values
Default value
WDS SNMP index
Section
Parameter
Description
Specifies an index for this instance of Wireless Data Server. See also Appendix C, "Wireless Data Server MIBs."
Accepted values
Default value
WDS SNMP ID
Section
Parameter
Description
Specifies an identification string for this instance of Wireless Data Server. See also Appendix C, "Wireless Data Server MIBs."
Accepted values
Default value
| Steltor http://www.steltor.com Voice: (514) 733-8500 Fax: (514) 733-8878 info@steltor.com |
|
|
|
|
|
| Copyright information | |||