Netscape Calendar Server 4.0: Administrator's G uide

Server Configuration

The Calendar Server contains five UNIX daemons / multi-threaded Windows NT services. Administrators can control and define the server environment and behavior using an extensive number of configurable parameters.

This chapter examines the function of each daemon/service, and the overall structure of the Calendar Server architecture. A section follows outlining the information needed to optimally tune and configure Calendar Server for your environment.

 

Calendar daemons / services

 The five (5) Calendar Server daemons / services are:

 

Calendar Lock Manager

 The Calendar Lock Manager (unilckd) manages the concurrent access to local nodes (sometimes referred to as local databases). In other words, the function of this daemon/service is to queue and process the many requests for node access coming from Calendar Engine threads. Both the Calendar Lock Manager and the Calendar Engine must be running to operate the Calendar Server.

 

Calendar Engine

The Calendar Engine (uniengd) is the database engine for Calendar Server. It provides functionality to accept and service client requests. Since many of these requests can be received at the same time, the servicing Calendar Engines must rely on the Calendar Lock Manager to ensure orderly access to the local nodes. Thus, as mentioned above, both the Calendar Lock Manager and the Calendar Engine must be running for access to local nodes.

 

Calendar Synchronous Network Connection

The Calendar Synchronous Network Connection daemon/service (unisncd) fulfills two roles in the Calendar Server architecture. In all implementations, the unisncd is used to maintain open TCP/IP connections to other nodes on the network and to grant those connections to clients that request access to another node. The connections granted are unidirectional: from a current node to another node, but not vice versa. It is therefore important to ensure that node connections are set in both directions. A unique node identification number called a node-ID distinguishes each node. A group of nodes connected together form a node network.

In its second function, the unisncd acts as a broker in granting connections to the Directory Access Server (unidasd).

The Calendar Synchronous Network Connection service grants connections on a "first in, first out" (FIFO) basis. Requests that cannot be processed immediately are put in a queue. The number of connections between two nodes may be increased or decreased. Thus, it is possible to minimize the traffic and connection time between two nodes or to minimize the number of connections used. If a Calendar Synchronous Network Connection service loses a connection due to network problems, it will attempt to reconnect later.

 

Configuration

The Synchronous Network Connection daemon/service is an iterative server whose purpose is to maintain open connections to many Calendar Engines simultaneously and to broker connections between Calendar Engines (uniengd) and Calendar Directory Access Servers (unidasd). For technical information about the configuration of the Calendar Synchronous Network Connections daemon/service, including a list of the parameters and their default values, see "Server configuration". Unless otherwise indicated, the Calendar Synchronous Network Connections daemon/service must be re-started in order for a configuration change to take effect.

 

Calendar Corporate-Wide Services

The Calendar Corporate-Wide Services (unicwsd) allow the exchange of information between users who reside on different nodes. People on one node may need to view calendar information or schedule events with users from another node. This service also provides mail notification via an SMTP mail server.

The Calendar Corporate-Wide Services communicate with other nodes using TCP/IP sockets and named pipe connections. These links provide fast communication and instant free-time lookups when scheduling an event. The TCP/IP sockets and named pipe connections are provided and managed by the Calendar Synchronous Node Connection daemon/service (unisncd).

 

Processing

The Calendar Corporate-Wide Services process local requests for remote information as well as requests from other nodes for local information. Local requests are requests for information concerning users on another node, or simply requests to send mail messages to remote users. These requests are made by the users on the local node and are put in a local queue. Calendar Corporate-Wide Services process the requests by reading them one after another from the queue. If a TCP/IP connection is available, the information requested by the local user can be accessed by connecting directly to the other node.

The only mail handling is the sending of notifications when a user creates an event and the attendees need to be notified. These mail notifications are dependent on user controlled options.

 

Configuration

For technical information concerning the configuration of the Calendar Corporate-Wide Services daemon/service, including a list of the parameters and their default values, see "Server configuration". Unless otherwise indicated, the Calendar Corporate-Wide Services must be re-started in order for a configuration change to take effect.

 

Calendar Directory Access Server

The Calendar Directory Access Server (unidasd) is used to maintain open connections to an LDAP Directory Server. Connections to the Directory Access Server are granted by the Calendar Synchronous Network Connection (unisncd) daemon/service.

 

Calendar architecture


Client connection requests are initially processed via the uniengd daemon/service through the Berkeley Sockets Interface. During the connection process, a forked uniengd server is created for the client for all subsequent requests. Database access requests are synchronized via the unilckd daemon/service through Interprocess Communication Requests (System V IPC).

User validation. All user attributes are stored in the Directory Server. The local uniengd server process borrows a persistent connection from the unisncd (synchronous network daemon) to the unidasd proxy. This process, then acting as a client, connects directly to the Directory Server which may be on a remote server.

Scheduling meetings with remote users (users on other nodes) is transparent to Calendar users. When a user creates a meeting with a user on a remote server, this places a request in the database which is handled by the unicwsd (corporate-wide services) daemon/service, whose job it is to place remote copies on other nodes.

 

Server configuration

The administrator can control and define both server and client behavior using configurable parameters. These Calendar Server parameters should be reviewed and tuned on a per installation basis.

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

To define a default profile:

  1. From the Calendar Server Manager, select Server Preferences| Manage Calendar Server to open the "Manage Calendar Server" form.

  2. All configuration parameters are displayed under a variety of headings related to the different daemons and services.

  3. To edit the default profile for a section, click the relevant <section name> to open the "Section Editor".

  4. All configurable parameters are displayed with the default value in an edit box. This value can be changed according to the information and limits defined in the following section "Configuration parameters."

  5. To make changes to a value, delete the old value and type in the new value in the edit box.

  6. To return to the default profile or values, click Reset.

  7. To add a new parameter, click Add Key(s) and, in the pop-up window, enter the number of parameters you wish to add. The specified number of boxes will be added to the bottom of the form for the insertion of the new parameters.

  8. To remove a parameter, click Delete Key and enter the key to be deleted in the pop-up window.

  9. Once you have made all required editing changes, click Save Changes.

 

Configuration parameters

The types of behavior that can be modified fall under the following headings:

 

Product license

 Section
[LIC]

Parameter
license

Description
A license for the product expressed in the form <date>/<product name>/<checksum>. This string should not be altered without explicit instructions from Netscape.

Accepted values
The license supplied with the product or an updated version provided by qualified support personnel.

Default value
not applicable

 

Product name

Section
[PRODUCT]

Parameter
name

Description
Specifies the name of the product. Set during installation, this value should not be edited or removed.

Accepted values
n/a

Default value
n/a

 

Product version number

Section
[PRODUCT]

Parameter
version

Description
Specifies the version number of the CorporateTime Server. Set during installation, this value should not be edited or removed.

Accepted values
n/a

Default value
n/a

 

Controlling client behavior

 

Allow calendar attachments

 Section
[LIMITS]

Parameter
allowattachments

Description
Determines whether or not attachments to meetings or tasks are allowed in the client.

Accepted values
TRUE (attachments allowed)

FALSE (attachments not allowed)

Default value
FALSE

 

Maximum size of attachments

Section
[LIMITS]

Parameter
maxattachmentsize

Description
Determines the maximum size, in bytes, allowed for attachments to meetings, tasks and other calendar entries. This parameter is meaningful only if the allowattachments parameter is TRUE. Suggested value is 102400 or 100K.

Accepted values
0 or any positive integer up to a maximum value of (232-1)

Default value
232-1

 

Interval for checks for new calendar entries

Section
[LIMITS]

Parameter
autocontrol

Description
Determines the minimum number of minutes that can be set by a user as the interval between each calendar refresh call made to the server (i.e. each check for new calendar entries).

If this value is less than lck_users/60, the value of lck_users/60 will take precedence. For example, if autocontrol=15 and lck_users=1200, a refresh will not occur before 20 (i.e. 1200/60) minutes has elapsed.

Accepted values
0 or any positive integer up to a maximum value of (216-1)

Default value
15

 

Maximum number of instances for a repeating meeting, note, or day event

Section
[LIMITS]

Parameter
maxrecur

Description
The maximum number of instances a user can create for a single repeating meeting, note or day event.

Accepted values
0 or any positive integer up to a maximum value of (232-1)

Default value
60 (60 instances per meeting, note, or day event)

 

Maximum lead time on a reminder

Section
[LIMITS]

Parameter
maxremleadtime

Description
Specifies the maximum number of days in advance of an event that you can set a reminder to ring.

Accepted values
0 or any positive integer up to a maximum value of (232-1)

Default value
21

 

Default view for calendar

Section
[LIMITS]

Parameter
agendaview

Description
Determines the default view in which calendar windows are opened. This functionality is implemented for Netscape Calendar 4.5and above.

Accepted values
0 (day view)

1 (week view)

2 (month view)

Default value
0

 

Maximum number of open windows

Section
[LIMITS]

Parameter
maxwinopen

Description
Determines the maximum number of windows (views) that can be opened at the same time in the user interface.

Accepted values
0 or any positive integer up to a maximum value of (232-1)

Default value
7

 

Maximum number of users in a group view

Section
[LIMITS]

Parameter
groupviewmax

Description
Specifies the maximum number of users that can be displayed in a group view.

Accepted values
A positive integer up to the value of (232-1)

Default value
100

 

Maximum number of individual calendars in a group calendar

Section
[LIMITS]

Parameter
maxviewcombined

Description
Determines the maximum number of individual calendars that may be included in a group calendar.

Accepted values
A value greater than 2 and less than 232

Default value
20

 

Case sensitivity of passwords

Section
[ENG]

Parameter
passwords

Description
Determines whether the user password verification is case sensitive or case insensitive.

Accepted values
case (for case sensitive)

ignorecase (for case insensitive)

Default value
case

 

Password aging

Section
[LIMITS]

Parameter
maxpasswordage

Description
Controls password aging. The value represents the number of days that a password can exist before users are required to change it.

Accepted values
0 or any positive integer up to a maximum value of (232-1)

Default value
76543 (for all intents and purposes, password aging is OFF)

 

Returning password to client

Section
[ENG]

Parameter
pwdreturnonitemget

Description
Determines whether or not the password of the logged-on user will be sent to the client when the record of that user is retrieved during a session. This parameter must be set to TRUE to allow the off-line use of Calendar client 3.4 and earlier.

Accepted values
TRUE (password is returned)

FALSE (password is not returned)

Default value
FALSE

 

Allow user to update personal attributes

Section
[DAS]

Parameter
dir_updcalonly

Description
Determines whether or not users can update the inetOrgPerson attributes maintained by the directory server and contained within the Calendar schema.

Accepted values
TRUE (updates permitted)

FALSE (updates not permitted)

Default value
TRUE

 

Right to create public groups

Section
[LIMITS]

Parameter
pubgroups

Description
Determines if users holding the necessary access rights are allowed to create public groups.

Accepted values
TRUE (users are permitted to create public groups)

FALSE (users are not permitted to create public groups)

Default value
TRUE

 

Enable mail notification

Section
[LIMITS]

Parameter
mail

Description
Determines whether or not mail notification is enabled, regardless of how the client is set up.

Accepted values
TRUE (mail notification is enabled)

FALSE (mail notification is disabled)

Default value
TRUE

 

Maximum number of people in a mail notification distribution

Section
[LIMITS]

Parameter
maxmaildistr

Description
Specifies the maximum number of users in a mail notification distribution list.

Accepted values
0 or any positive integer up to a maximum value of (232-1)

Default value
30

 

Minimum number of characters in the "Surname" edit box

Section
[LIMITS]

Parameter
mincharsearch

Description
Determines the minimum number of search characters which the user must supply in the "Surname" field when performing a directory search from the client. The default value of 0 allows a user to execute a search without limits and retrieve the complete database of users.

Accepted values
0 or any positive integer up to a maximum value of (232-1)

Default value
0

 

Maximum number of search results displayed

Section
[LIMITS]

Parameter
maxsearchresult

Description
Determines the maximum number of entries that the search dialog box can list as a search result in either the Calendar client, or the Calendar Server Manager . Although this parameter should be tuned relative to the size of your installed base, it cannot exceed the value set for searches by the sizelimit parameter (default value = 500) in the slapd.conf file of the directory server. A second parameter in the same file in the directory server, the lookthroughlimit parameter (default value = 5000), controls the maximum number of entries that will be checked before returning the search results. A third parameter in the slapd.conf file, the timelimit parameter (default value=3600), specifies the maximum number of seconds allocated for a search request. If tuning search capabilities for a large installation, you must assess the dependencies between all four of these parameters. See the Directory Server Administrator's Guide for more information on these parameters.

Accepted values
0 or any positive integer up to the value of (232-1)

Default value
100 (only 100 entries will be listed at a time)

 

"Next" button in search dialog box

Section
[LIMITS]

Parameter
page-forward

Description
This parameter must be set to FALSE.

Accepted values
TRUE (the "next" button will be enabled)

FALSE (the "next" button will be disabled)

Default value
TRUE

 

"Previous" button in search dialog box

Section
[LIMITS]

Parameter
page-backward

Description
This parameter must be set to FALSE.

Accepted values
TRUE (the "previous" button will be enabled)

FALSE (the "previous" button will be disabled)

Default value
TRUE

 

Double-booking resources

Section
[LIMITS]

Parameter
resourceconflicts

Description
Determines whether double-booking of resources is allowed.

Accepted values
TRUE (double-bookings are allowed)

FALSE (double-bookings are not allowed)

Default value
TRUE

 

Allow resources in remote node to appear as local

Section
[YOURNODEID]

Parameter
localnodes

Description
Specifies which remote resources will be considered local for scheduling purposes when using the Calendar client. If you want users on separate but connected nodes to view and treat all resources as local (a common situation when two or more nodes are in close geographic proximity), you would enter the relevant node-ID(s) after this parameter. Nodes must be connected to enable this feature.

Accepted values
Valid node-IDs, separated by a comma

Default value
Not applicable

 

Permission to change default timezone

Section
[LIMITS]

Parameter
settimezone

Description
Determines whether or not the user is permitted to change his/her time zone setting in the client from that set for the node.

Accepted values
TRUE (users permitted to set a different time zone)

FALSE (users not permitted to set a different time zone)

Default value
FALSE

 

Controlling client connections to server

 

Maximum number of logged-on users

 Section
[LCK]

Parameter
lck_users

Description
Specifies the maximum number of logged-on Calendar users. Setting this value higher than required wastes system resources.

Accepted values
A positive integer up to 3800 (NT) or 5000 (UNIX).

Default value
35

 

Maximum number of concurrent sessions by a given user

Section
[ENG]

Parameter
max_userlogons

Description
Specifies the maximum number of concurrent "named" Calendar Server sessions that each user may invoke. A session is "named" if it is associated with a specific user and "unnamed" if it is not associated with a specific user.

Accepted values
0 (no limit is to be enforced) or any positive integer

Default value
0

 

Number of concurrent sessions from a specific client

Section
[ENG]

Parameter
max_addrlogons

Description
Specifies the maximum number of concurrent "unnamed" Calendar Server sessions that can be invoked by a single client, that is, from a single Internet address. A session is "named" if it is associated with a specific user and "unnamed" if it is not associated with a specific user.

Accepted values
0 (no limit is to be enforced) or any positive integer

Default value
The default value is 0.

 

Database lock timeout for reads

Section
[ENG]

Parameter
readlocktimeout

Description
Determines the number of contiguous seconds that the server is permitted to lock the database for a client read request. If this maximum is exceeded, the uniengd server will terminate (and thus the associated user session as well), and the timeout will be logged to eng.log.

Accepted values
0 or any positive integer up to the value of (232-1)

Default value
0

 

Database lock timeout for writes

Section
[ENG]

Parameter
writelocktimeout

Description
Determines the number of contiguous seconds that the server is permitted to lock the database for a client write request. If this maximum is exceeded, the uniengd server will terminate (and thus the associated user session as well), and the timeout will be logged to eng.log.

Accepted values
0 or any positive integer up to the value of (232-1)

Default value
0

 

Retry interval for remote data requests to server

Section
[LIMITS]

Parameter
remotewait

Description
Specifies the number of seconds the client will wait before retrying a call to the server for data from a remote server.

Accepted values
A positive integer up to the value of (232-1)

Default value
2

 

Retry limit for remote data requests to server

Section
[LIMITS]

Parameter
remotemaxretry

Description
Specifies the number of retries of a call to the server requesting data from a remote server that will be made before returning an error.

Accepted values
A positive integer up to the value of (232-1)

Default value
5

 

Use of internal cache on directory server inaccessibility

Section
[ENG]

Parameter
dac_dirdownfailover

Description
Determines whether or not the internal cache will be used when the directory server is down, and thus whether or not it is possible to continue using a Calendar client in such a situation. The Calendar client must have signed in when the directory server was up. Operations in this situation are limited to ones which do not require modifications to the directory server information. Permitted operations are: item retrievals, searches, and creation/modification of calendar entries.

Accepted values
TRUE (client will operate with directory server down)

FALSE (client will not operate with directory server down)

Default value
FALSE

 

Controlling server behavior



 

Internal Database

 Section
[DBI]

Parameter
dbi_name

Description
Specifies the name of the empty node database used as a template for node creation. Set during installation, this value should not be edited or removed.

Accepted values
n/a

Default value
n/a

 

Node database version

Section
[DBI]

Parameter
dbversion

Description
Specifies the node database version number. Set during installation, this value should not be edited or removed.

Accepted values
n/a

Default value
n/a

 

Automatic start of CWS daemon/service

Section
[CWS]

Parameter
enable

Description
Controls whether or not the unicwsd, the Corporate-Wide Services daemon/ service, is automatically started. This parameter must be set to TRUE if your Calendar Server configuration has multiple nodes or mail notification.

Accepted values
TRUE (unicwsd automatically starts)

FALSE (unicwsd does not automatically start)

Default value
TRUE

 

Automatic start of the SNC daemon/service

Section
[SNC]

Parameter
enable

Description
Determines whether or not the unisncd daemon/service will be started with the other services when the Calendar system is brought up. The unisncd service must be started if your Calendar implementation contains multiple nodes.

Accepted values
TRUE (unisncd is started)

FALSE (unisncd is not started)

Default value
FALSE

 

Automatic start of DAS daemon/service

Section
[DAS]

Parameter
enable

Description
Determines whether or not the unidasd daemon/service is automatically started when the Calendar Server is started.

Accepted values
TRUE (unidasd will be started)

FALSE (unidasd will not be started)

Default value
FALSE

 

Reduce start-up time of Calendar Server

Section
[CGI]

Parameter
unistartcheck

Description
Determines whether or not the Calendar Server will perform the usual checks (unicheck and uniclean) on start-up. Omitting the checks reduces the start-up time. This is useful in cases where the Calendar Server is taking too long to start, causing the httpd to time out.

Accepted values
TRUE (standard checks executed upon start-up)

FALSE (standard checks disabled at start-up)

Default value
TRUE

 

Time to sleep on start-up

Section
[CWS]

Parameter
startupsleep

Description
Specifies the number of seconds the Corporate-Wide Services daemon/service will wait (sleep) at the start-up of the Calendar Server before attempting to process any requests. This delay is intended to provide enough time for the SNC daemon/service to start up and establish the necessary connections to nodes. Tuning of this parameter may be necessary for servers with many nodes, or many connections, or where the bandwidth is low.

Accepted values
A positive integer

Default value
45

 

Maximum number of sockets used by SNC

Section
[SNC]

Parameter
max_socket

Description
Specifies the maximum number of connections among all nodes. In situations where multiple nodes exist on a server, this parameter is used to minimize the number of system resources (namely, the number of sockets) required to instantiate the node network defined in the /users/unison/misc/nodes.ini file. The SNC daemon/service in this case will distribute the total number of connections evenly among all nodes.

This parameter may need to be tuned based on usage statistics.

Accepted values
The minimal configuration is two connections per node. The upper limit is the maximum number of open files allowed per process, a limit imposed by the operating system.

Default value
(none)

 

Host name of system

Section
[UTL]

Parameter
host

Description
Specifies the host name of the system on which the Calendar Server is running. There is NO default so you MUST include this parameter.

Accepted values
Any valid (fully-specified) host name

Default value
(none)

 

User under which processes run

Section
[SYS]

Parameter
sys_owner

Description
Specifies the user under which the Calendar Server processes will run. In all cases, Calendar Server executes services with the effective user controlling security set to unison.

Accepted values (UNIX)
unison

root

Accepted values (NT)
unison

administrator

Default value
unison

 

Number of connections to directory server

Section
[YOURHOSTNAME,unidas]

Parameter
numconnect

Description
Specifies the number of DAS (Directory Access Server) connections to establish to the directory server.

Accepted values
A positive integer

Default value
5

 

Enable daemon synchronization during start/stop

Section
[SYS]

Parameter
autosync

Description
Enables the daemon synchronization mechanism during start-up and shutdown operations.

Accepted values
TRUE (use of synchronization mechanism enabled)

FALSE (use of synchronization mechanism disabled; sleep calls are used for synchronization)

Default value
TRUE

 

Statistics logging: user connections

Section
[ENG]

Parameter
activity

Description
Determines whether or not logging of Calendar Server sign-ons and sign-offs is done. The resulting log is useful for tracking Calendar Server usage and for monitoring possible security violations. If logging is enabled, the size of the log file (/users/unison/log/act.log) should be closely monitored as it can grow quickly.

Accepted values
TRUE (enables logging)

FALSE (disables logging)

Default value
FALSE

 

Statistics logging: user sessions

Section
[ENG]

Parameter
stats

Description
Determines whether or not logging of Calendar Server user session statistics (CPU consumption, user wait times, and network traffic) is doneIf logging is enabled, the size of the log file (/users/unison/log/stats.log) should be closely monitored since it can grow quickly.

Accepted values
TRUE (logging is done)

FALSE (no logging is done)

Default value
FALSE

 

Charater set for log files

Section
[ENG]

Parameter
localcharset

Description
Defines the character set used in the log files. Data stored in the calendasr database will be converted to this character set for display in log files. Thus, if for a Japanese configuration the parameter was set to Shift_JIS, names in the /users/unison/log/act.log would be displayed in Shift_JIS.

Accepted values
HPROMAN

ISO-8859-1

MAC-JAPANESE

MAC-ROMAN

MSCP1252

MSCP932

Shift_JIS

T61

Default value
n/a

 

Calendar standards (CAPI)

Section
[ENG]

Parameter
standards

Description
Lists the supported Internet standards.

Accepted values
ICAL2.0 (support for IETF ICAL 2.0 standard; must be activated to enable CAPI support

CAPI (required if CAPI applications are used)

Default value
{ICAL2.0,CAPI}

 

Statistics logging: verbose switch

Section
[CWS]

Parameter
trace

Description
Determines how much information is written to the unicwsd daemon/service log file (/users/unison/log/cws.log). If set to TRUE, a more verbose style of logging is enabled whereby each transaction performed by the CWS daemon/service is logged. This will cause the log file to grow rapidly and should only be used for a short time for testing or debugging purposes.

Accepted values
TRUE (enables verbose logging)

FALSE (disables verbose logging)

Default value
FALSE

 

Statistics logging: unidasd

Section
[DAS]

Parameter
stats

Description
Determines whether or not unidasd statistics are generated and logged to the dasstats.log and the dsstats.log files. The log files grow quickly and thus should be generated for only a short time for testing or debugging purposes.

Accepted values
TRUE (enables logging)

FALSE (disables logging)

Default value
FALSE

 

Logging of dac_dirdownfailover errors

Section
[ENG]

Parameter
dac_dirdownfailoverlog

Description
Determines whether or not the use of the failover mechanism, controlled by the dac_dirdownfailover parameter, will be logged to the /users/unison/log/eng.log file.

Accepted values
TRUE (logging enabled)

FALSE (logging disabled)

Default value
FALSE

 

Logging of failure errors

Section
[ENG]

Parameter
dac_failederrlog

Description
Determines whether or not directory server access related errors that appear in the client interface as "unexpected error" are logged to the /users/unison/log/eng.log file.

Accepted values
TRUE (logging enabled)

FALSE (logging disabled)

Default value
TRUE

 

Logging of configuration errors

Section
[ENG]

Parameter
dac_configerrlog

Description
Determines whether or not three directory server access errors are logged to the /users/unison/log/eng.log file. The three errors are: "unable to connect to the SNC daemon/service"; "no connections to the directory access (DAS) daemon/service are currently available" and "the number of retries to obtain a connection has been attained; no connections to the directory access (DAS) daemon/service are configured".

Accepted values
TRUE (logging enabled)

FALSE (logging disabled)

Default value
TRUE

 

Logging of miscellaneous errors

Section
[ENG]

Parameter
dac_miscerrlog

Description
Determines whether or not three types of directory server access errors related to the client are logged to the /users/unison/log/eng.log file. The three errors are: password discrepancy due to changes made in the directory server through another application; an LDAP client-side error; an LDAP server-side error.

Accepted values
TRUE (logging enabled)

FALSE (logging disabled)

Default value
TRUE

 

Logging of non-critical errors

Section
[ENG]

Parameter
dac_ignorederrlog

Description
Determines whether or not non-critical directory server access errors are logged to the /users/unison/log/eng.log file.

Accepted values
TRUE (logging enabled)

FALSE (logging disabled)

Default value
TRUE

 

Logging of failure to instantiate UTF-8 conversion functionality

Section
[ENG]

Parameter
utf8_onfailprintmesg

Description
Determines whether or not an error message is logged to /users/unison/log/eng.log if the server is unable to instantiate UTF-8 conversion functionality for a given user session. Enough information is logged in the error message to determine why the functionality could not be created.

Accepted values
TRUE (error message is logged to eng.log)

FALSE (no error message is logged)

Default value
TRUE

 

Database item retrieval

Section
[ENG]

Parameter
dac_itemget

Description
Determines whether an item being retrieved (as a result of a search or a signon) is retrieved from the directory server or from the internal cache.

Accepted values
TRUE (items are retrieved from the directory server)

FALSE (items are retrieved from the internal cache)

Default value
TRUE

 

Enable conversion of data to UTF-8 format

Section
[ENG]

Parameter
utf8_autoconvert

Description
Determines whether or not data input from the client is converted and stored in the server in UTF-8 format.

Accepted values
TRUE (input data is converted to UTF-8)

FALSE (input data is not converted to UTF-8)

Default value
TRUE

 

Number of pages in the database cache

Section
[DB]

Parameter
db_pages

Description
Specifies the number of pages for the database cache. The greater the value, the greater the amount of memory used and the better the performance. As the number increases beyond a certain point, the performance enhancement returns diminish.

Accepted values
A positive integer

Default value
8

 

Number of pages for transaction overflow cache

Section
[DB]

Parameter
db_indexpages

Description
Specifies the number of pages for the transaction overflow cache.

Accepted values
A positive integer

Default value
4

 

Maximum number of database reconnection attempts

Section
[DB]

Parameter
db_openrepeat

Description
Specifies the maximum number of attempts that will be made to reconnect to the database.

Accepted values
A positive integer

Default value
5

 

Interval between database reconnection attempts

Section
[DB]

Parameter
db_opensleep

Description
Specifies the number of seconds to wait (sleep) between attempts to connect to the database.

Accepted values
A positive integer

Default value
2

 

Maximum number of database files open per user

Section
[DB]

Parameter
db_files

Description
Specifies the number of database files that may be opened for each user. Increasing this number can improve performance.

Accepted values
A positive integer up to the maximum set by the operating system for number of open files per process. On UNIX systems this maximum is the value of the system variable NOFILE, which may be found in the file /usr/include/sys/param.h.

Default value
15

 

Maximum number of retries on the database locking mechanism

Section
[DB]

Parameter
taf_max_retry

Description
Specifies the maximum number of retries on the database locking mechanism.

Accepted values
A positive integer

Default value
100

 

Database lock operation timeout

Section
[UTL]

Parameter
lock_timeout

Description
Sets the timeout, in seconds, for the lock operation on the database.

Accepted values
A positive integer

Default value
300

 

Specify alternate backup utility

Section
[UTL]

Parameter
external_backup

Description
Specifies an alternate backup utility to be invoked by unidbbackup. The value of this parameter is used to construct the following command line:

value_of_external_backup [-f] -s src -d dst

where

-f indicates that the source is a file (absence of this flag indicates the source is a directory)

-s specifies the source to be backed up ("src" is any valid file or directory name)

-d specifies the destination for the backup, as specified by the user

and both "src" and "dst" are any valid file or directory name

The generated command line must be valid. It may be that an intermediate script is required to take this command line, create one which is valid, and then invoke it. In this case, the value of external_backup would be set to the appropriate value for invoking the intermediate script.

Accepted values
A command line

Default value
None

 

Specify alternate restore utility

Section
[UTL]

Parameter
external_restore

Description
Specifies an alternate restore utility to be invoked by unidbrestore. The value of this parameter is used to construct the following command line:

value_of_external_restore [-f] -s src -d dst

where

-f indicates that the source is a file (absence of this flag indicates the source is a directory)

-s specifies the source to be restored ("src" is any valid file or directory name)

-d specifies the destination for the restore, as specified by the user

and both "src" and "dst" are any valid file or directory name

The generated command line must be valid. It may be that an intermediate script is required to take this command line, create one which is valid, and then invoke it. In this case, the value of external_restore would be set to the appropriate value for invoking the intermediate script.

Accepted values
A command line

Default value
None

 

Backup operation timeout

Section
[UTL]

Parameter
backup_timeout

Description
Sets the timeout, in seconds, for the backup operation on the database.

Accepted values
A positive integer

Default value
3600

 

Restore operation timeout

Section
[UTL]

Parameter
restore_timeout

Description
Sets the timeout, in seconds, for the restore operation on the database.

Accepted values
A postive integer

Default value
3600

Default value
100

 

Node alias(es)

Section
[YOURNODEID]

Parameter
aliases

Description
Specifies the name (alias) or names (aliases) of the nodes configured on a server. When multiple nodes are configured on a server, users must indicate to which node they want to connect. Since, in general, a name is easier to remember than a numeric node-ID, aliases can be configured.

Accepted values
A list of one or more aliases where each alias is an alphanumeric string containing at least one letter and no spaces; each alias in the list is separated from the next by a comma

Default value
(none)

 

Node name

Section
[YOURNODEID]

Parameter
name

Description
The name of the root directory for the node database found under /users/unison/db/nodes/<name>. The value of this parameter is automatically generated during node creation. The first node created is labelled `N0', the second `N1', and following up to `N9'. Subsequent nodes continue the cycle through the alphabet from O to Z and then from A to L.

Accepted values
A code composed of a letter (A-Z) and a number (0-9)

Default value
not applicable

 

Time zone of node

Section
[YOURNODEID]

Parameter
timezone

Description
Indicates the time zone of the node. This parameter is set automatically at the time the node is created and must not be changed.

The value of this parameter is set to either the time zone specified by the administrator creating the new node, or, where none is specified, the value of the [TIMEZONE] default parameter.

The timezone parameter allows nodes in a multiple node configuration to be associated with different time zones.

Accepted values
not applicable

Default value
(none)

 

Database version number

Section
[YOURNODEID]

Parameter
version

Description
Specifies the version of the node database. This is a reference value set automatically during node creation. It must NEVER be manually edited.

Accepted values
not applicable

Default value
not applicable

 

Mail Notification

Section
[ENG]

Parameter
notify

Description
Determines whether or not notification by SMTP-based UNIX mail is done on event creation. This parameter applies only to pre-3.0 versions of the client.

Accepted values
TRUE (enable notification)

FALSE (disable notification)

Default value
TRUE

 

User mail mapping

Section
[ENG]

Parameter
usermailmap

Description
Specifies the attribute in the user record which contains the e-mail address of the user.

Accepted values
A valid X.400 key

Default value

 

Resource mail mappings

Section
[ENG]

Parameter
resourcemailmap

Description
Specifies the attribute in the resource record which contains the e-mail address of the resource.

Accepted values
A valid X.400 key

Default value

 

Mail server

Section
[CWS]

Parameter
smtpmail

Description
Determines whether or not mail notifications will be sent using the SMTP mail server. This parameter should always be set to TRUE, regardless of whether or not mail notification is enabled. Mail notification is enabled or disabled using the mail parameter in the [LIMITS] section.

This parameter supercedes unixmail. For backwards compatibility, if smtpmail is not set, and a value for the unixmail parameter can be found, that value will be used.

Accepted values
TRUE (the SMTP mail server is used)

FALSE (the SMTP mail server is not used)

Default value
FALSE

 

Mail server

Section
[CWS]

Parameter
unixmail

Description
This parameter is superceded by smtpmail.

 

Mail utility

Section
[CWS]

Parameter
smtpmailprogram

Description
The mail utility used to transfer messages to the SMTP mail server. This parameter supercedes unixmailprogram. For backwards compatibility, if smtpmailprogram is not set, and a value for the unixmailprogram parameter can be found, that value will be used.

Accepted values
sendmail

postmail

Default value (UNIX)
sendmail

Default value (NT)
sendmail.exe

 

Mail utility

Section
[CWS]

Parameter
unixmailprogram

Description
This parameter is superceded by smtpmailprogram.

 

Pathname of the mail utility

Section
[CWS]

Parameter
smtpmailpath

Description
Specifies the directory pathname of the local mail utility. This parameter supercedes unixmailpath. For backwards compatibility, if smtpmailpath is not set, and a value for the unixmailpath parameter can be found, that value will be used.

Accepted values
A valid pathname

Default value (UNIX)
/usr/lib

Default value (NT)
/users/unison/bin

 

Pathname of the mail utility

Section
[CWS]

Parameter
sendmailpath

Description
This parameter is superceded by smtpmailpath.

 

Host name of the smtp mail server

Section
[CWS]

Parameter
smtpmailhost

Description
Specifies the host name on which the SMTP mail server is running. This parameter supercedes mailhost. For backwards compatibility, if smtpmailhost is not set, and a value for the mailhost parameter can be found, that value will be used.

Accepted values
A valid host name

Default value (NT)
local-host

 

Redirection of mail script output

Section
[CWS]

Parameter
smtpmaillog

Description
Specifies the file to which any script output resulting from the invocation of the mail utility will be redirected.

Under UNIX, unicwsd delivers e-mail by calling the system() function to execute sendmail (or the mail utility configured). The input to the system() function is a Bourne Shell script. If this script produces output, the issue arises of what to do with that output: as a daemon process, unicwsd has no stdout or stderr. To ensure that the output does not get sent to uniengd (and result in a deadlocking of communications between the two daemons), it is redirected to the file specified by this parameter.

Accepted values
A valid file name (/dev/null may also be used if no log of the output is required)

Default value (UNIX)
/users/unison/log/smtpmail.log

 

"To:" field of mail header

Section
[CWS]

Parameter
mailhdrtofield

Description
Determines whether or not the "To:" field of the header is displayed.

Accepted values
TRUE ("To:" field is displayed)

FALSE ("To:" field is not displayed)

Default value
TRUE

 

UTF-8 for names in "To:" field of mail header

Section
[CWS]

Parameter
mailhdrtoname

Description
Determines whether or not names are included with addresses in the "To:" field of the mail header. While addresses are constructed using ASCII characters (and hence present no display problem for mail readers), names may contain non-ASCII characters. In cases where the mail reader is unable to properly display the non-ASCII characters, it may be preferable to simply remove the names from the "To:" field altogether.

Accepted values
TRUE (names are included)

FALSE (names are not included)

Default value
TRUE

 

Character set for content portion of mail message

Section
[CWS]

Parameter
mimecontentcharset

Description
Determines the character set used to encode the content and subject portion of the (MIME) mail message.

Accepted values
ISO-8859-1

Shift_JIS

MSCP932

Default value
ISO-8859-1

 

Character set for content portion of mail message

Section
[LOCALE]

Parameter
charset

Description
Determines the character set used to encode the content portion of the mail message.

Accepted values
HPROMAN

ISO-8859-1

MAC-JAPANESE

MAC-ROMAN

MSCP1252

MSCP932

Shift_JIS

T61

Default value
ISO-8859-1

 

Temporary directory for mail server

Section
[CWS]

Parameter
tmp_dir

Description
Specifies the temporary directory used by the mail server to store working files.

Accepted values
A valid directory pathname

Default value
/users/unison/tmp

 

Sleep time between mail server connection retries

Section
[CWS]

Parameter
maxmailsleep

Description
Specifies the maximum number of seconds the unicwsd will wait (sleep) when it cannot connect to the mail server before trying again. This sleep time starts at 300 seconds (5 minutes) and is incremented by 600 seconds (10 minutes) each time a connect is retried, up to the defined maximum.

Accepted values
A positive integer

Default value
1800 (30 minutes)

 

Delay between sending of warning messages

Section
[CWS]

Parameter
warninggap

Description
The minimum number of seconds between each warning message sent to the Calendar Administrator when the attempt to make a connection to a remote node fails.

Accepted values
A positive integer

Default value
21600 (6 hours)

 

Persistence of connections from uniengd to unidasd

Section
[ENG]

Parameter
dac_rscconnectmodel

Description
Determines whether connections between the uniengd and the unidasd are persistent or on-demand. The ideal of maintaining persistent connections (for speed) is balanced against the number of open file descriptors permitted by the operating system.

Accepted values
ondemand (connection maintained for the duration of each specific request)

persistent (open connections maintained)

Default value
ondemand

 

SNC to DAS connection retries

Section
[ENG]

Parameter
dac_maxretry

Description
Specifies the maximum number of retries the SNC daemon/service will make when attempting to establish a connection to the DAS daemon/service.

Accepted values
0 or any positive integer up to a maximum value of (232-1)

Default value
3

 

SNC to DAS connection retry delay

Section
[ENG]

Parameter
dac_retrywaitsecs

Description
Specifies the number of seconds that the SNC daemon/service will wait between retries when attempting to establish a connection to the DAS. This value is combined with the value of dac_retrywaitusecs to determine the total time between retries.

Accepted values
0 or any positive integer up to a maximum value of (232-1)

Default value
0

 

SNC to DAS connection retry delay

Section
[ENG]

Parameter
dac_retrywaitusecs

Description
Determines the number of microseconds that the SNC daemon/service will wait between retries when attempting to establish a connection to the DAS. This value is combined with the value of dac_retrywaitsecs to determine the total time between retries.

Accepted values
0 or any positive integer up to a maximum value of (232-1)

Default value
100

 

Listening on any IP address associated with a multi-homed machine [ENG]

Section
[ENG]

Parameter
so_any

Description
Determines whether or not the uniengd daemon/service process will listen for packets directed at ANY of the addresses associated with the machine hosting the Calendar Server. This is only relevant when the Calendar Server is running on a machine which has multiple IP addresses.

Accepted values
TRUE (listens for packets destined for ANY of the addresses associated with the machine)

FALSE (only listens for packets destined for the IP address given to it on start-up)

Default value
TRUE

 

Listening on any IP address associated with a multi-homed machine [DAS]

Section
[DAS]

Parameter
so_any

Description
Determines whether or not the unidasd daemon/service process will listen for packets directed at ANY of the addresses associated with the machine hosting the Calendar Server. This is only relevant when the Calendar Server is running on a machine which has multiple IP addresses.

Accepted values
TRUE (listens for packets destined for ANY of the addresses associated with the machine)

FALSE (only listens for packets destined for the IP address given to it on start-up)

Default value
TRUE

 

Re-use of socket address

Section
[DAS]

Parameter
so_reuseaddr

Description
Determines whether or not, on creation of the socket address for the unidasd daemon, the local portion of the address handed to the operating system is flagged as re-usable. Note that this is relevant only for the start-up of the unidasd daemon and not for any subsequent unidasd servers.

Accepted values
TRUE (the local portion of the address is flagged re-usable)

FALSE (the local portion of the address is flagged not re-usable)

Default value
TRUE

 

Sleep time between checks on request queue

Section
[CWS]

Parameter
noreqsleep

Description
The number of seconds the Corporate-Wide Services daemon/service will wait (sleep) when there are no requests in the local queue. After that time, the unicwsd will again check its queue for pending requests. This setting affects how long it will take to propagate data, such as remote user invitations, to other nodes.

Accepted values
A positive integer up to a maximum value of (232 -1)

Default value
60

 

Maximum age of request in queue

Section
[CWS]

Parameter
requestmaxage

Description
Specifies the maximum number of minutes that a request labelled CANTSERVICE will remain on the Corporate-Wide Services queue before being assigned a lower servicing priority.

Accepted values
A positive integer up to a maximum value of (232-1)

Default value
2880 (two days)

 

Default time zone

Section
[TIMEZONE]

Parameter
default

Description
Specifies the local time zone.

Accepted values
Any time zone that appears in the /users/unison/misc/timezone.ini file (e.g. "EST-5EDT")

Default value
(none)

 

Time zone rules

Section
[TIMEZONE]

Parameter
rules

Description
Specifies the name of the file containing time zone rules.

Accepted values
A valid fully-specified file name

Default value
/users/unison/misc/timezone.ini

 

Checksum of the time zone rules file

Section
[TIMEZONE]

Parameter
checksum

Description
Contains the checksum of the time zone rules file. This is a preset value and it must not be altered under any circumstance.

Accepted values
not applicable

Default value
not applicable

 

Controlling server interactions with directory server

 

Set directory service

 Section
[DAS]

Parameter
dir_service

Description
Specifies the directory service that the unidasd daemon/service will access. The value of this parameter is also found as the name of the section in the /user/unison/misc/unison.ini file where the configuration parameters for the directory service will be found. For example, if dir_service=LDAP, the LDAP directory service configuration parameters would be found in the [LDAP] section of the unison.ini file.

Accepted values
not applicable

Default value
LDAP

 

Name of directory server

Section
[LDAP]

Parameter
dsa

Description
Specifies the name of the LDAP directory server.

Accepted values
Netscape (for the Netscape LDAP directory server)

Default value
(null string)

 

Name of directory server host

Section
[LDAP]

Parameter
host

Description
Specifies the name of the host on which the LDAP directory server runs.

Accepted values
A valid host name

Default value
(null string)

 

LDAP protocol version number

Section
[LDAP]

Parameter
version

Description
Specifies the LDAP protocol version number to use.

Accepted values
A positive integer

Default value
3

 

Port number of the LDAP directory server

Section
[LDAP]

Parameter
port

Description
Specifies the port number of the LDAP directory server.

Accepted values
A valid port number

Default value
389

 

Character set used by the directory server

Section
[LDAP]

Parameter
charset

Description
Indicates the character set used by the LDAP directory server, and thus the character set that the Calendar Server must use for data destined for the LDAP directory server.

Accepted values
A valid character set name for which a .map file exists in the directory specified by the charsetdir parameter. The charmap.config file in that directory may be consulted to determine the .map file associated with a particular character set as well as the set of valid names for that character set.

Default value
UTF-8

 

Directory server support for ldap_compare() requests

Section
[LDAP]

Parameter
dsausesearchtocompare

Description
Indicates whether the LDAP directory server can handle ldap_compare() calls properly or whether ldap_search() calls must be used instead.

Accepted values
TRUE (ldap_compare() must be used)

FALSE (ldap_search() calls are handled properly)

Default value
FALSE

 

Permissions for modifying directory server attributes

Section
[YOURHOSTNAME,unidas]

Parameter
dir_adminmodcalonly

Description
Specifies whether the Calendar reserved users can modify all Directory Server attributes or are limited to modifying only the Calendar attributes in the directory server.

Accepted values
TRUE (permit modifications only to Calendar attributes in the directory server)

FALSE (permit modifications to all attributes in the directory server)

Default value
FALSE

 

Permissions for updating directory server attributes

Section
[YOURHOSTNAME,unidas]

Parameter
dir_adminupdcalonly

Description
Specifies whether the Calendar reserved users can update all directory server attributes or are limited to updating only the Calendar attributes in the directory server.

Accepted values
TRUE (only permit updates to Calendar attributes in the directory server)

FALSE (permit updates to all attributes in the directory server)

Default value
FALSE

 

Attribute preserve list

Section
[LDAP]

Parameter
attrpreservelist

Description
Specifies a list of attributes (a "preserve list") which are not to be deleted when a Calendar user is deleted (i.e. when the user's calendar attributes as well as their nsCalUser object class are deleted). If the Calendar user entries also use the inetOrgPerson object class, this parameter should be configured as follows:

{"employeeNumber", "givenName", "initials", "mail", "ou"}

Any fields mapped to attributes outside of the nsCalUser object class (e.g. attr_organization="uid") should also be added to the "preserve list".

Accepted values
A list of strings, where each string in the list is the name of a user attribute which is not to be deleted when the user is deleted

Default value
(the empty list)

 

Name of the "country" attribute

Section
[LDAP]

Parameter
attr_country

Description
Determines the attribute name that the LDAP directory server will use for the "country" attribute.

Accepted values
Any attribute name defined in the LDAP directory server schema

Default value
(null string)

 

Name of the "generation qualifier" attribute

Section
[LDAP]

Parameter
attr_generation

Description
Determines the attribute name that the LDAP directory server will use for the "generation qualifier" attribute.

Accepted values
Any attribute name defined in the LDAP directory server schema

Default value
generationQualifier

 

Name of the "organization" attribute

Section
[LDAP]

Parameter
attr_organization

Description
Determines the attribute name that the LDAP directory server will use for the "organization" attribute.

Accepted values
Any attribute name defined in the LDAP directory server schema

Default value
(null string)

 

Name of the "fax" attribute

Section
[LDAP]

Parameter
attr_fax

Description
Determines the attribute name that the LDAP directory server will use for the "fax" attribute.

Accepted values
Any attribute name defined in the LDAP directory server schema

Default value
facsimileTelephoneNumber

 

Name of the "given name" attribute

Section
[LDAP]

Parameter
attr_givenname

Description
Determines the attribute name that the LDAP directory server will use for the "given name" attribute.

Accepted values
Any attribute name defined in the LDAP directory server schema

Default value
givenName

 

Name of the "mail" attribute

Section
[LDAP]

Parameter
attr_mail

Description
Determines the attribute name that the LDAP directory server will use for the "mail" attribute.

Accepted values
Any attribute name defined in the LDAP directory server schema

Default value
mail

 

Location of the calendar server administrators

Section
[LDAP]

Parameter
admin

Description
Specifies part of the Distinguished Name (DN) of the location under which the Calendar Server administrators will be created. The DN of this location is constructed by appending the value of the basedn parameter to the value of the admin parameter. For example, where admin="ou=calendar servers" and basedn="o=acme", the DN for the location under which the Calendar Server administrators will be created is "ou=calendar servers, o=acme".

Accepted values
A valid Distinguished Name or Relative Distinguished Name (see your LDAP directory server documentation for further information on the correct form)

Default value
ou=Netscape Servers

 

Group entry for calendar server administrators

Section
[LDAP]

Parameter
admingroup

Description
Specifies part of the Distinguished Name (DN) of the group entry for the Calendar Server administrators (the administrators are added to this group). The DN of the group entry is constructed by appending the value of the basedn parameter to the value of the admingroup parameter. For example, where admingroup="cn=calendar server admins" and basedn="o=acme", the DN for the group entry of the Calendar Server administrators is "cn=calendar server admins, o=acme".

Accepted values
A valid Distinguished Name or Relative Distinguished Name (see your LDAP directory server documentation for further information on the correct form)

Default value
cn=Netscape Server Admins, ou=Netscape Servers

 

Distinguished Name of the subtree containing the calendar server entries

Section
[LDAP]

Parameter
basedn

Description
Specifies the Distinguished Name of the LDAP directory server subtree containing the Calendar entries.

Accepted values
A valid Distinguished Name (see your LDAP directory server documentation for further information on the correct form of a Distinguished Name)

Default value
(null string)

 

Distinguished Name used for anonymous connections

Section
[LDAP]

Parameter
binddn

Description
Specifies the Distinguished Name used by the LDAP directory server for anonymous connections.

Accepted values
Any valid Distinguished Name (see your LDAP directory server documentation for further information on the correct form of a Distinguished Name)

Default value
(null string)

 

Distinguished Name of the directory server administrator

Section
[LDAP]

Parameter
mgrdn

Description
Specifies the Distinguished Name of the LDAP directory server administrator.

Accepted values
A valid Distinguished Name (see your LDAP directory server documentation for further information on the correct form of a Distinguished Name)

Default value
(null string)

 

Password used for anonymous connections

Section
[LDAP]

Parameter
bindpwd

Description
Specifies the password used by the LDAP directory server for anonymous connections.

Accepted values
Any string

Default value
(null string)

 

Password to use during migrations for users without passwords

Section
[LDAP]

Parameter
defaultpwd

Description
Specifies the password to use during migrations for users without passwords.

Accepted values
Any string

Default value
sesame

 

Directory server handling of changes to passwords

Section
[LDAP]

Parameter
dsausedeladdtoreplacepwd

Description
Determines how the LDAP directory server handles changes to passwords.

Accepted values
TRUE (passwords must first be erased and then set afresh)

FALSE (passwords may be reset without first erasing them)

Default value
FALSE

 

Enable debugging mode

Section
[LDAP]

Parameter
debug

Description
Enables debugging mode on the LDAP directory server.

Accepted values
TRUE (enable debugging mode)

FALSE (disable debugging mode)

Default value
FALSE

 

Additional parameters

The following parameters are documented here for reference purposes only. It is unlikely that the default values supplied for these parameters would require tuning in the majority of Calendar Server implementations.

 

Optional [SNC] parameters

 

Number of minutes to wait for remote node connection

 Section
[SNC]

Parameter
wait_sbh

Description
Specifies the number of minutes to wait if the SNC daemon/service is not able to connect to the remote node.

Accepted values
A positive integer

Default value
5

 

Number of requests that are reset at a time

Section
[SNC]

Parameter
request_chunk_size

Description
Specifies the number of requests that are reset at a time by the SNC daemon/service. When the SNC daemon/service establishes a connection, it also examines the request queue of each local node and resets all requests labelled CANTSERVICE to NOTSERVICED. To minimize the time that another process may be made to wait for access to the node database while the SNC daemon/service resets the request queue (which is in the node database), this parameter allows the resetting to be performed in "chunks" of requests.

Accepted values
A positive integer

Default value
25

 

Block size for communications

Section
[SNC]

Parameter
snc_tr_block

Description
Specifies the block size, in bytes, that will be used for communications between the uniengd and the unidasd. This value should not be changed without first consulting your support provider.

Accepted values
0 (choose the default from the trn library)

A positive integer

Default value
0

 

Time-out for received transmissions

Section
[SNC]

Parameter
snc_tr_recv_timeout

Description
Specifies the time-out value for received transmissions. This value should be increased substantially if the Calendar administrator expects a large volume of recurring events with both local and remote attendees. A tenfold increase (i.e. 600) should suffice.

Accepted values
A positive integer

Default value
60

 

Time-out for sent transmissions

Section
[SNC]

Parameter
snc_tr_send_timeout

Description
Specifies the time-out value for sent transmissions.

Accepted values
A positive integer

Default value
0

 

Size of the socket layer receive buffer

Section
[SNC]

Parameter
snc_so_rcvbuf

Description
Specifies the size, in bytes, of the socket layer receive buffer. This value should not be changed without first consulting your support provider.

Accepted values
0 (let trn library supply a default value)

A positive integer

Default value
0

 

Size of the socket layer send buffer

Section
[SNC]

Parameter
snc_so_sndbuf

Description
Specifies the size, in bytes, of the socket layer send buffer. This value should not be changed without first consulting your support provider.

Accepted values
0 (let trn library supply a default value)

A positive integer

Default value
0

 

Unsent messages on termination of SNC daemon/service

Section
[SNC]

Parameter
snc_so_linger

Description
Determines what is done with any unsent data that exists in the socket send buffer at the time the SNC daemon/service is terminated.

Accepted values
TRUE (system will attempt to deliver the unsent data)

FALSE (system will discard any unsent data)

Default value
FALSE

 

Idle connections

Section
[SNC]

Parameter
snc_so_keepalive

Description
Determines whether or not the system keeps idle connections active.

If this parameter is set to TRUE, a network packet is sent periodically to determine whether or not the process on the other end of an idle connection is still running. If no acknowledgement is received from that process within a specified period of time, it is assumed to have terminated and the connection is no longer maintained.

If this parameter is set to FALSE, periodic checking on idle connections is not done, and the connection is maintained indefinitely.

Accepted values
TRUE (periodically checks idle connections and terminates ones which have no acknowledging process at the other end)

FALSE (maintains idle connections indefinitely)

Default value
TRUE

 

[SNC] Section

 

Multiple Configurations

 Each time the Calendar Synchronous Network Connection service connects to a Calendar Engine, a section could be used to describe the connection, transaction, and socket options. Defaults always apply if none is present. For example: 


[ computername | ALL , unieng , node-ID | ALL ]


service = unieng


tmp_dir = /users/unison/tmp


socketfile = unieng.sck


tr_block = 0


tr_recv_timeout = 60


tr_send_timeout = 0


so_rcvbuf = 0


so_sndbuf = 0


so_linger = FALSE


so_reuseaddr = FALSE


so_keepalive = FALSE


retry = 1


connect_timeout = 30


max_wait_before_retry = 64


send_cleanup_timeout = 200


recv_cleanup_timeout = 200


unstable_net_period = 15


unstable_net_lost_per_min = 1


unstable_net_first_retry = 32
The section name consists of three parts: the computer name, the service name (uniengd) and the associated node. In the example above, eight new options have been introduced: 


retry = 1
Indicates the number of times the SNC service should retry to establish a connection. 


connect_timeout = 30
The time-out (in seconds) used to indicated that a connection has failed. 


max_wait_before_retry = 64
The maximum time (in minutes) for the retry mechanism. 


send_cleanup_timeout = 200
Determines the time-out (in milliseconds) associated with the connection shutdown. 


recv_cleanup_timeout = 200
Determines the time-out (in milliseconds) associated with the connection shutdown. 


unstable_net_period = 15


unstable_net_lost_per_min =1


unstable_net_first_retry = 32
The above three parameters are used to define an unstable network. In the above case, when the SNC service finds unstable_net_lost_per_min connections for unstable_net_period minutes, the service enters the retry mechanism mode. In this case, the SNC service waits for unstable_net_first_retry minutes before reconnecting to the node.