Sun ONE Calendar Server 6.0 Administrator's Guide |
Chapter 12
Calendar Server Configuration ParametersSun ONE Calendar Server configuration parameters are stored in configuration files, including ics.conf and counter.conf.
This chapter provides the following information:
Editing the ics.conf Configuration FileCalendar Server configuration parameters are stored in the following file:
cal_svr_base/etc/opt/SUNWics5/config/ics.conf
The ics.conf file is a ASCII text file, with each line defining a parameter and its associated value(s). The parameters are initialized during Calendar Server installation. After installation, you can edit the file using a text editor.
Caution
Modify the settings for parameters in the ics.conf file only as described in Sun documentation or as directed by a customer support representative.
To edit the ics.conf file:
- Log in as a user who has administrator rights to the system where Calendar Server is running.
- Change to the cal_svr_base/etc/opt/SUNWics5/config directory where the ics.conf file is located.
- Edit parameters in the ics.conf file using a text editor such as vi on Solaris Systems. Conventions for parameters are:
Some parameters are released as comments, beginning with either one or two exclamation points (! or !!). To use this type of parameter, you must remove the exclamation point(s), supply a value (if needed), and then restart Calendar Server for the parameter to take effect.
For example, to use !!caldb.dwp.server.[hostname].ip, you must remove the exclamation points (!!), supply a value for hostname, and then restart Calendar Server.
- After you make changes to parameters in the ics.conf file, stop and then restart the Calendar Server for the new configuration values to take effect. (If you prefer, you can also stop Calendar Server before you edit the ics.conf file.)
For more information, see "Starting and Stopping Calendar Server".
Configuration Parameters (ics.conf) FileConfiguration parameters in the ics.conf file include:
Local Configuration
The following table shows the Local Configuration parameters with each parameter’s default value and description.
Calendar Store Configuration
The following table shows the Calendar Store Configuration parameters with each parameter’s default value and description.
Table 12-2 Calendar Store Configuration Parameters in the ics.conf File
Parameter
Default Value
Description
calstore.anonymous.calid
"anonymous"
Calendar ID (calid) used for anonymous logins.
user.allow.doublebook
"yes"
Determines if a user calendar can have more than one event scheduled for the same time slot when the calendar is created:
This parameter is used only when a user calendar is created. After a user calendar is created, Calendar Server checks the calendar properties (ics50calprops.db) to determine if double booking is allowed.
If you need to change the calendar properties for a user calendar to allow or disallow double booking, use cscal with the -k option.
calstore.calendar.default.acl
"@@o^a^r^g;@@o^c^wdeic^g;@^a^fs^g;@^c^^g;@^p^r^g"
Specifies the default access control permissions used when a user creates a calendar. The format is specified by a semicolon-separated list of access control entry (ACE) argument strings.
For details on the ACE format, see Chapter 4, "Managing Calendar Server Access Control".
To specify Access Control Entries for one or more calendars using the command-line utilities, see "cscal".
calstore.calendar.owner.acl
"@@o^a^rsf^g;@@o^c^wdeic^g"
Specifies the default access control settings for owners of a calendar.
Note: When a user specifies access rights using the Privacy dialog in the Calendar Express user interface, they are applied in reverse order. For example, @@o^a^rsf^g;@@o^c^wdeic^g is applied as @@o^c^wdeic^g;@@o^a^rsf^g.
calstore.calendar.create.lowercase
"no"
Specifies whether Calendar Server should convert a calendar ID (calid) to lowercase when creating a new calendar or when looking up a calendar using the LDAP CLD plug-in.
calstore.default.timezoneID
"America/New_York"
Timezone ID to be used when importing files when:
An invalid value causes the server to use to the GMT (Greenwich Mean Time) timezone.
calstore.filterprivateevents
"yes"
Specifies whether Calendar Server filters (recognizes) Private and Time and Date Only (confidential) events and tasks. If "no", Calendar Server treats them the same as Public events and tasks.
calstore.freebusy.include.defaultcalendar
"yes"
Specifies whether a user's default calendar is included in user's free/busy calendar list.
calstore.freebusy.remove.defaultcalendar
"no"
Specifies whether a user's default calendar can be removed from user's free/busy calendar list.
calstore.group.attendee.maxsize
"0"
Maximum number of attendees allowed in an LDAP group when expanding an event. Value of "0" means to expand the group entirely.
calstore.recurrence.bound
"60"
Maximum number of events that can be created by a recurrence expansion.
calstore.subscribed.include.defaultcalendar
"yes"
Specifies whether a user's default calendar is included in the user's subscribed calendar list.
calstore.subscribed.remove.defaultcalendar
"no"
Specifies whether a user's default calendar can be removed from the user's subscribed calendar list.
calstore.userlookup.maxsize
"200"
Maximum number of results returned from LDAP lookup from user search. Value of "0" means no limit.
calstore.virtualdomain.mode
"n"
Specifies whether Calendar Server is in limited virtual domain mode ("y" or "n").
calstore.unqualifiedattendee.fmt1.type
"uid"
Specifies how Calendar Server treats strings, such as jdoe or jdoe:tv, when performing a directory lookup for attendees of an event. Values can be:
calstore.unqualifiedattendee.fmt2.type
"mailto"
Specifies how Calendar Server treats strings with an at sign (@), such as jdoe@foo.com, when performing a directory lookup for attendees of an event. Values can be:
calstore.unqualifiedattendee.fmt3.type
"cn"
Specifies how Calendar Server treats strings with a space, such as john doe, when performing a directory lookup for attendees of an event. Values can be:
store.partition.primary.path
"."
Location of primary disk partition where calendar information is stored.
Calendar Log Information Configuration
The following table shows the Calendar Log Configuration parameters with each parameter’s default value and description.
Services Configuration
The following table shows the Services Configuration parameters with each parameter’s default value and description.
Table 12-4 Services Configuration Parameters in the ics.conf File
Parameter
Default Value
Description
service.authcachesize
"10000"
Maximum number of authenticated user IDs (UIDs) and passwords that Calendar Server will maintain.
service.authcachettl
"900"
Number of seconds before a user UID and password are cached.
resource.allow.doublebook
"no"
Determines if a calendar that belongs to a resource (such as a conference room or audio visual equipment) can have more than one event scheduled for the same time slot when the calendar is created:
This parameter is used only when a resource calendar is created.
After a resource calendar is created, Calendar Server checks the calendar properties (ics50calprops.db) to determine if double booking is allowed.
If you need to change the calendar properties for a resource calendar to allow or disallow double booking, use csresource with the -k option.
resource.default.acl
"@@o^a^r^g;@@o^c^wdeic^g;@^a^rsf^g"
Specifies the default access control permissions used when a resource calendar is created.
service.admin.alarm
"yes"
Enable ("yes") or disable ("no") alarm notifications for administration tools.
service.admin.calmaster.cred
" "
Password of the user ID specified as the Calendar Server administrator. This value is supplied at installation and is required by the installation program.
service.admin.calmaster.userid
"calmaster"
User ID of the person designated as the Calendar Server administrator. This value is supplied at installation and is required by the installation program.
service.admin.calmaster.overrides.accesscontrol
"no"
Indicates whether the Calendar Server administrator can override access control.
service.admin.calmaster.wcap.allowgetmodifyuserprefs
"no"
Indicates whether the Calendar Server administrator can get and set user preferences using WCAP commands.
service.admin.checkpoint
"yes"
If "yes", start the csadmind database checkpoint thread.
service.admin.dbcachesize
"8388608"
Maximum cache size (in bytes) for Berkeley Database for administration sessions.
service.admin.deadlock
"yes"
If "yes", start the csadmind database deadlock detection thread.
service.admin.diskusage
"no"
If "yes", start the csadmind low disk space monitor thread.
service.admin.enable
"yes"
If "yes", start the csadmind service when starting all services and stop csadmind when stopping all services.
service.admin.idletimeout
"120"
Number of seconds before timing out an HTTP connection in csadmind.
service.admin.ldap.enable
"yes"
If “yes”, enables LDAP for user authentication of the user specified in service.admin.calmaster.userid.
service.admin.maxsessions
"100"
Maximum number of administration sessions allowed.
service.admin.maxthreads
"10"
Maximum number of running threads per administration session.
service.admin.resourcetimeout
"900"
Number of seconds before timing out an administration connection.
service.admin.serverresponse
"no"
If "yes", start the csadmind service response thread.
service.admin.sessiondir.path
" "
Temporary directory for administration session requests.
service.admin.sessiontimeout
"1800"
Number of seconds before timing out an HTTP session in csadmind.
service.admin.sleeptime
"2"
Number of seconds to wait between checking for started, stopped, or ready calendar service.
service.admin.starttime
"300"
Number of seconds to wait for any calendar service to start.
service.admin.stoptime
"300"
Number of seconds to wait for any calendar service to stop.
service.admin.stoptime.next
"60"
Number of seconds to wait between sending stop commands to any calendar service.
service.dnsresolveclient
"no"
If "yes", client IP addresses are checked against DNS if allowed HTTP access.
service.http.admins
"calmaster"
Space separated list of user IDs with administration rights to this Calendar Server.
service.http.allowadminproxy
"no"
If "yes", allow login via proxy.
service.http.allowanonymouslogin
"yes"
If "yes", allow anonymous (no login) access.
service.http.calendarhostname
" "
HTTP host for retrieving HTML documents. To enable users to use a fully qualified host name to access calendar data, this value must be the fully qualified host name (including the machine name, DNS domain and suffix) of the machine on which Calendar Server is running, such as mycal@sesta.com.
If not specified, the local HTTP host is used.
service.http.cookies
"yes"
Tells the server to whether or to support cookies (yes/no). It must be set to "yes" to enable single sign-on.
service.http.dbcachesize
"8388608"
Maximum cache size of Berkeley DB for HTTP sessions.
service.http.domainallowed
" "
If specified and not " ", filter to allow access based on TCP domains. For example, "ALL: LOCAL.sesta.com" would allow local HTTP access to anyone in the sesta.com domain. Multiple filters are separated by CR-LF (line feed).
service.http.domainnotallowed
" "
If specified and not " ", filter to not allow access based on TCP domains. For example, "ALL: LOCAL.sesta.com" would deny HTTP access to anyone in the sesta.com domain. Multiple filters must be separated by CR-LF (line-feed).
service.http.attachdir.path
"."
Directory location relative to local.queuedir (or an absolute path if specified) where imported files are temporarily stored.
service.http.ipsecurity
"yes"
If "yes", all requests that reference an existing session are verified as originating from the same IP address.
service.http.enable
"yes"
If "yes", start the cshttpd service when starting all services and stop cshttpd when stopping all services.
service.http.idletimeout
"120"
Number of seconds before timing out an HTTP connection.
service.http.ldap.enable
"yes"
If "yes", LDAP connections for authentication and user preferences are created and maintained.
service.http.logaccess
"no"
If "yes", HTTP connections to server are fully logged.
service.http.maxsessions
"5000"
Maximum number of HTTP sessions in cshttpd service.
service.http.maxthreads
"20"
Maximum number of threads to service HTTP requests in cshttpd service.
service.http.numprocesses
"1"
Maximum number of concurrently running HTTP service (csdwpd) processes that should run on a server.
For a server that has multiple CPUs, see "Using Load Balancing Across Multiple CPUs".
service.http.port
"80"
Port for HTTP requests from Calendar Server users.
service.http.proxydomainallowed
" "
If specified and not " ", filter for allowing proxy login based on TCP domains. Same syntax as service.http.domainallowed.
service.http.resourcetimeout
"900"
Number of seconds before timing out an HTTP session.
service.http.sessiondir.path
"http"
Temporary directory for HTTP sessions.
service.http.sessiontimeout
"1800"
Number of seconds before timing out an HTTP session in cshttpd service.
service.http.sourceurl
" "
Directory relative to executable where all URL references to files are stored.
service.http.uidir.path
"html"
Directory that contains the default calendar client. If allowing only WCAP access, set to "".
service.http.renderhtml
"no"
Enables or disables rendering of HTML and JavaScript in the Event Title and Description fields for events in Calendar Express.
Rendering does not apply to any other text fields for events or to any text fields for tasks.
service.ldapmemcache
"no"
If "yes", use cache in LDAP SDK.
service.ldapmemcachettl
"30"
If service.ldapmemcache is "yes", pass in this value to the LDAP SDK. This is the maximum number of seconds that an item can be cached. If 0, there is no limit to the amount of time that an item can be cached.
service.ldapmemcachesize
"131072"
If service.ldapmemcache is "yes", pass in this value to the LDAP SDK. This is the maximum amount of memory in bytes that the cache will consume. If 0, the cache has no size limit.
service.listenaddr
"INADDR_ANY"
On Solaris Systems, specifies the TCP address that HTTP services will listen on for client requests. "INADDR_ANY" indicates any address.
service.plaintextloginpause
"0"
Number of seconds to delay after successfully authenticating a user using plain text passwords.
service.wcap.anonymous.allowpubliccalendarwrite
"yes"
If "yes", allow anonymous users to write to publicly writable calendars.
service.wcap.format
"text/calendar"
Specifies the default output format for commands currently applied only for freebusy.
service.wcap.freebusybegin
"30"
Specifies the default offset from the current time in days for get_freebusy for beginning of the range.
service.wcap.freebusyend
"30"
Specifies the default offset from the current time in days for get_freebusy for end of the range.
service.wcap.allowcreatecalendars
"yes"
If "yes", allow calendars to be created.
service.wcap.allowdeletecalendars
"yes"
If "yes", allow calendars to be deleted.
service.wcap.allowchangepassword
"no"
If "yes", allow users to change their passwords via this server.
service.wcap.allowpublicwritablecalendars
"yes"
If "yes", allow users to have publicly writable calendars.
service.wcap.allowsetprefs.cn
"no"
If "yes", allow the set_userprefs.wcap attribute to modify the user preference "cn" (LDAP user's common name).
service.wcap.allowsetprefs.givenname
"no"
If "yes", allow the set_userprefs.wcap attribute to modify the user preference "givenname" (LDAP user's given name).
service.wcap.allowsetprefs.icsCalendar
"no"
If "yes", allow the set_userprefs.wcap attribute to modify the user preference “icsCalendar" (a user's default calendar identifier).
service.wcap.allowsetprefs.mail
"no"
If "yes", allow the set_userprefs.wcap attribute to modify the user preference "mail" (user's e-mail address).
service.wcap.allowsetprefs.preferredlanguage
"no"
If "yes", allow the set_userprefs.wcap attribute to modify the user preference "preferredlanguage" (LDAP user's preferred language).
service.wcap.allowsetprefs.sn
"no"
If "yes", allow the set_userprefs.wcap attribute to modify the user preference "sn" (LDAP user's surname).
service.wcap.allowsetprefs.nswccalid
"no"
If "yes", allow the set_userprefs.wcap attribute to modify the user preference "nswccalid", which is the user's default calendar ID.
service.wcap.login.calendar.publicread
"no"
If "yes", default user calendars are initially set to public read/private write. If no, default user calendars are initially set to private read/private write.
service.wcap.userprefs.ldapproxyauth
"no"
If "yes", enables LDAP proxy authorization for get_userprefs.wcap command. If "no", anonymous LDAP search is performed.
service.wcap.validateowners
"no"
If "yes", the server must validate that each owner of a calendar exists in the directory (through LDAP or a CSAPI compatible user directory mechanism).
service.wcap.version
"3.0"
WCAP version.
SSL Configuration
The following table shows the SSL Configuration parameters with each parameter’s default value and description.
Hosted Domain Configuration
The following table shows the hosted (virtual) domain configuration parameters with each parameter’s default value and description.
Alarm Notification Configuration
The following table shows the Alarm Notification Server Configuration parameters with each parameter’s default value and description.
Calendar Lookup Database Configuration
The following table shows the Calendar Lookup Database (CLD) parameters with each parameter’s default value and description.
Table 12-8 Calendar Lookup Database (CLD) Parameters in the ics.conf File
Parameter
Default Value
Description
csapi.plugin.calendarlookup
"n"
Enable ("y") or disable ("n") calendar lookup plug-ins.
csapi.plugin.calendarlookup.name
"*"
Specifies the name of a specific calendar lookup plug-in to load. If this value is an asterisk ("*"), Calendar Server loads all plug-ins.
caldb.cld.type
"local"
Specifies the type of CLD plug-in to use:
caldb.dwp.server.default= "server-name"
" "
Specifies the fully qualified default DWP server name used by Calendar Server if a user or resource calendar entry in the LDAP server database does not have an icsDWPHost attribute.
If a user who logs into Calendar Server through Calendar Express or using WCAP commands does not have an icsDWPHost attribute, Calendar Server uses this parameter to auto-provision the attribute.
If a user already has an icsDWPHost attribute, caldb.dwp.server.default is not used.
This name must be resolvable by your Domain Name Service (DNS) into a valid IP address.
caldb.cld.cache.enable
"yes"
Enables ("yes") or disables ("no") the Calendar Lookup Database (CLD) cache option. For optimum performance for the LDAP CLD plug-in, set to "yes".
caldb.cld.cache.logfilesizemb
"10"
Specifies the maximum size in megabytes of the checkpoint file for the CLD cache.
caldb.cld.cache.mempoolsizemb
"4"
Specifies the size in megabytes of shared for the CLD cache option.
caldb.cld.cache.maxthread
"1000"
Specifies the maximum number of database threads for the CLD cache option.
caldb.cld.cache.homedir.path
"."
Specifies the location of database event, task, and alarm files for the CLD cache option. The default value of "." specifies that these files are stored in the cal_svr_base/var/opt/SUNWics5/csdb/cld_cache directory.
caldb.cld.cache.checkpointinterval
"60"
Specifies the number of seconds between checkpointing for the CLD cache option.
caldb.cld.cache.circularlogging
"yes"
Specifies whether to remove the checkpoint files after they are synchronized for the CLD cache option.
caldb.dwp.server.host-name.ip = "host-name"
" "
Specifies the host name of a server that is storing a calendar database. The server must be running the DWP (csdwpd) service. This name must be resolvable by your Domain Name Service (DNS) into a valid IP address. This parameter is used by the LDAP CLD plug-in.
Note: In each part of the parameter, host-name must be identical and fully qualified. For example:
caldb.dwp.server.sesta.com.ip ="sesta.com"
caldb.dwp.connthreshold
"1"
Maximum number of backlogged requests before the server obtains a new network connection.
caldb.dwp.initconns
"2"
Initial number of connections for the Database Wire Protocol service client to make to each Database Wire Protocol service host.
caldb.dwp.initthreads
"2"
Initial number of threads for handling Database Wire Protocol service requests.
caldb.dwp.maxcons
"1000"
Maximum number of connections allowed to a server using the Database Wire Protocol service.
caldb.dwp.maxthreads
"20"
Maximum number of threads allowed to a server using the Database Wire Protocol service.
caldb.dwp.md5
"n"
Specifies if the server performs MD5 (Message Digest 5) one-way hash checking of all Database Wire Protocol service requests. (One-way hash functions are used to create digital signatures for message authentication.)
caldb.dwp.server.hostname.ip
" "
Specifies the IP address of the server using the Database Wire Protocol (DWP) service at the specified machine’s hostname.
caldb.dwp.server.back-end-server.admin
" "
On a front-end server, specifies the user ID that is used for authentication for a DWP connection to a back-end server, where back-end-server is the name of the server.
caldb.dwp.server.back-end-server.cred
" "
On a front-end server, specifies the password that is used for authentication for a DWP connection to a back-end server, where back-end-server is the name of the server.
caldb.dwp.stacksize
"65536"
Stack size for Database Wire Protocol service threads.
csapi.plugin.authentication
"n"
If "y", load only the plug-in specified in csapi.plugin.authentication.name or if not specified, load all authentication class plug-ins in alphabetical order. For authentication, use each of these plug-ins in alphabetical order.
csapi.plugin.authentication.name
" "
If csapi.plugin.loadall is "n" and csapi.plugin.authentication is "y", only load this specific plug-in. If not specified or " ", load all authentication class plug-ins.
service.dwp.admin.userid
" "
On a back-end server, specifies the user ID that is used to authenticate a DWP connection. This parameter is optional. If a back-end server does not specify a user ID, no authentication is performed.
service.dwp.admin.cred
" "
On a back-end server, specifies the password that is used to authenticate a DWP connection. This parameter is optional. If a back-end server does not specify a password, no authentication is performed.
service.dwp.maxthreads
"1000"
Maximum number of concurrently running Database Wire Protocol service threads.
service.dwp.numprocesses
"1"
Maximum number of concurrently running Database Wire Protocol (DWP) service (csdwpd) processes that should run on a server.
For a server that has multiple CPUs, see "Using Load Balancing Across Multiple CPUs".
service.dwp.enable
"no"
If "yes", start the csdwpd service when starting all services and stop csdwpd when stopping all services
service.dwp.idletimeout
"86400"
Amount of time (in seconds) before closing the Database Wire Protocol service persistent connections that are idle.
service.dwp.port
"59779"
Port number that the Database Wire Protocol service listens to. This value is the default port for the LDAP CLD plug-in.
service.dwp.ldap.enable
"yes"
Enable ("yes") or disable ("no") LDAP for remote user authentication for the Database Wire Protocol (csdwpd) service.
service.calendarsearch.ldap
"yes"
Specifies whether Calendar Server searches the LDAP directory and then the calendar database ("yes") or only the calendar database ("no").
Single Sign-on (SSO) Configuration
Configuring SSO Through Identity Server
The following table shows the SSO configuration parameters with each parameter’s default value and description when you are using Identity Server.
Configuring SSO Through Communications Servers Trusted Circle Technology
The following table shows the SSO configuration parameters with each parameter’s default value and description when the Communications Servers trusted circle technology.
Group Scheduling Engine (GSE) Configuration
The following table shows the Group Scheduling Engine (GSE) configuration parameters with each parameter’s default value and description.
Database Configuration
The following table shows the Database configuration parameters with each parameter’s default value and description.
Calendar Database Parameters for ENS Messages
Table 12-13 describes the parameter, default value, and description. If you require a value other than the default, you must add the parameter to the ics.conf file.
Calendar Server API Configuration
Table 12-14 shows the Calendar Server API (CSAPI) configuration parameters with each parameter’s default value and description.
Event Notification Server (ENS) Configuration
Calendar Server, when configured to do so, uses an external generic service called the Event Notification Server (ENS), which accepts reports of server-level events that can be categorized into specific areas of interest and notifies other servers that have registered interest in certain categories of events. Calendar Server uses ENS to send and receive alarm notifications that include the creation, deletion, or modification of calendar events and tasks as well as general operational warning and error messages.
Table 12-15 shows the Event Notification Server (ENS) configuration parameters in ics.conf. with each parameter’s default value and description.
User Interface (UI) Configuration
The following table shows the user interface (UI) configuration parameters with each parameter’s default value and description.
Table 12-16 User Interface Configuration Parameters in the ics.conf File
Parameter
Default Value
Description
ui.config.file
" "
Calendar Server can read an optional (xml based) configuration file at startup that can hide parts of the user interface. Calendar Server allows only one configuration file, and the value of this setting determines the name of the file to use. Calendar Server looks for the file in the data directory where the user interface xml and xslt files are:
cal_svr_base/opt/SUNWics5/cal/data
Calendar Server provides the following files that provide customized versions of the user interface:
ui.allow.anyone
"yes"
Allows Calendar Express to show and use the "Everybody" access control list (ACL).
ui.allow.domain
"no"
Allows Calendar Express to show and use the "This Domain" access control list (ACL).
ui.proxyaddress.url
" "
Specifies the proxy server address to prepend in an HTML UI JavaScript file. For example: "https://web_portal.sesta.com/"
ui.base.url
" "
Specifies the base server address. For example: "https://proxyserver"
ine.invitation.enable
"yes"
Controls the notification for an invitation to an event:
"yes" – Notification is sent.
"no" – No notification is sent.
ine.cancellation.enable
"yes"
Controls the notification for a cancellation of an event:
"yes" – Notification is sent.
"no" – No notification is sent.
ui.eventdialog.inform.enable
"no"
Specifies whether Calendar Express should display the “Inform About Event” option when users create or edit an event.
ui.toolbar.repainting.enable
"yes"
Enables ("yes") or disables ("no") repainting (or refreshing) of the Calendar Express tool bar.
Setting to "no" can improve performance, because does not perform the XML and XSLT transformation for the tool bar. If set to "no", clicking refresh on any view takes the Calendar Express user back to the default view.
If the browser cache option (next parameter) is enabled, the tool bar repainting option is not used.
browser.cache.enable
"no"
Enables ("yes") or disables ("no") the browser cache option. For more information, see "Using the Refresh View Option".
render.xslonclient.enable
"yes"
Enables ("yes") or disables ("no") client-side rendering by downloading the XSLT processing to the end user’s browser. For more information, see XSL Rendering in the Client Browser.
csmonitor Utility ConfigurationThe following table shows the csmonitor utility configuration parameters with each parameter’s default value and description.
Counters Configuration (counter.conf) FileCalendar Server counters (statistics) configuration parameters are in the following file:
cal_svr_base/etc/opt/SUNWics5/config/counter.conf
The counter.conf file is an ASCII text file, with each line defining a counter and its parameters: name, type, size (in bytes), and description. A parameter with spaces must be enclosed in double quotation marks (" "). A comment line must begin with an exclamation point (!). Comment lines are for informational purposes only.
The first part of a counter's name identifies the counter object used with the csstats utility. For more information about the command-line utilities, see Chapter 11, "Calendar Server Command-Line Utilities".”
This section describes the Calendar Server counter.conf parameters, including:
Alarm Counters
The following table shows each alarm counter’s name, type, size, and description.
Disk Usage Counters
The following table shows each disk usage counter’s name, type, size, and description.
HTTP Counters
The following table shows each HTTP counter’s name, type, size, and description.
Group Scheduling Counters
The following table shows each Group Scheduling Engine (GSE) counter’s name, type, size, and description.
Authentication Counters
The following table shows each Authentication counter’s name, type, size, and description.
WCAP Counters
The following table shows each WCAP counter’s name, type, size, and description.
Table 12-23 WCAP (wcapstat) Counters in the counter.conf File
Name
Type
Size
Description
wcapstat.numRequests
COUNTER
4
Total number of WCAP requests.
Database Counters
The following table shows each Database counter’s name, type, size, and description.
Server Response Counters
The following table shows each Server Response counter’s name, type, size, and description.
Session Status Counters
The following table shows each Session Status counter’s name, type, size, and description.
Notification MessagesCalendar Server sends the types of email messages described in Table 12-27. The format of these messages is controlled by the associated format (.fmt) file listed in the table. Format files are located in specific directories for each local (such as /en for English and /fr for French) in the following directory:
cal_svr_base/etc/opt/SUNWics5/config
For example, the English version of the task alarm message format is specified in the file:
cal_svr_base/etc/opt/SUNWics5/config/en/mail_todoalarm.fmt
This section describes:
Calendar Server Mail Parameters
The following table shows the message type, parameter name, default format file description, and recipient for each Calendar Server Mail parameter.
Calendar Server generates notification messages by combining a particular event or task with the contents of a format file. The values of data fields within an event or task can be output to the message. The notification message can also include MIME header lines and associated special values. Using special character sequences (format notations), you can include the values of events, tasks, and MIME headers in the message. The lines in the format file are format strings comprised of special character sequences that are replaced with actual values from calendar data fields when the mail message is generated. Special character sequences consist of two characters, the first is the percent sign (%) and the second represents the specific format notation.
The following sections describe special character sequences:
Special Character Sequences for Events
The following table shows the format code and meaning for Special Character Sequences for Event Notifications.
Table 12-28 Special Character Sequences for Event Notifications
Format Code
Meaning
%0
Start time in localized format
%1
End time in localized format
%A
exdates in iCalendar format (semicolon-separated list of ISO8601 date strings listing dates to exclude)
%a
rdates in iCalendar format (semicolon-separated list of ISO8601 date strings listing recurrence dates)
%B
Start time (also see %Z)
%b
Output the start time and end time in iCalendar format. If the start time has the parameter value=date, only the month/day/year portion of the date is output. If end time has the same month/day/year value as the start time, only the start time is generated.
%C
Create time
%c
Event class
%d
Event description. (also see %F)
%E
End time (also see %Z)
%e
Exception rules in iCalendar format
%F
Event description - folded line / iCalendar format (also see %d)
%G
The event's geographic location (latitude and longitude)
%g
Organizer's email address. (There is no guarantee as to the authenticity of this value.)
%K
Organizer email in the form of a mailto:url
%k
Alarm count
%L
Location
%l
Recurrence rules in iCalendar format
%M
Modify time
%N
New line
%n
The current time stamp used with DTSTAMP
%P
Priority
%r
Recurrence id (blank if this event does not recur)
%S
Event sequence number
%s
Summary
%t
Event status
%U
Unique Event Identifier
%u
URL to the event
%Z
Used in conjunction with the time field code to force the time to be rendered in UTC. (%B displays the start time in local time whereas %ZB displays the start time in UTC time.)
%%
Displays the percent (%) character
% (sub-format code)
Specifies a subformat for the data identified by code. (For details, see Date Sub-Formatting.)
Date Sub-Formatting
Date-time values can be formatted in many different ways. Using a sub-format, you can provide additional information to describe how a date-time value should be formatted. If a sub-format is not specified, the server uses a default format to output the date. Using a sub-format field allows you to specify the exact format to be used.
For example, %B specifies that the output string includes the event's begin time. This default format prints out the date, time, the time zone, and everything possible about the date. The sub-format string for date values is a strftime format string (see Special Character Sequences for Dates). If you were only interested in the month and year of the start time, instead of %B, you would use: %(%m %Y)B.
Example
The following example:
produces output that resembles the following notification:
Conditional Printing
Sometimes it is desirable to print a line only under certain conditions. For example, the following lines:
produce output that resembles the following notification:
There are two conditions, however, where the above example would yield misleading or incorrect results:
In these situations, it is best not to print the end time at all. By default, only the year, month, and day are printed when a time stamp has the attribute of being all-day. Furthermore, if an event start time has the all-day attribute and the event ends on the same day as it starts, a special conditional flag is set. Use the ? modifier to print conditional values only when the special conditional flag is not set.
For example, if you change the lines in the above example to:
The last line will not be printed for all-day events for which the start day and end day are the same. It produces the following output for typical all-day events (such as birthdays or anniversaries):
The ? flag can be combined with other modifiers. For example:
The event ends: %?(%b %d, %Y %I:%M %p)E%N
Special Character Sequences for Task Notifications
The following table shows the format code and meaning for Special Character Sequences for Task Notifications.
Table 12-29 Special Character Sequences for Task Notifications
Format Code
Meaning
%A
exdates in iCalendar format (semicolon-separated list of ISO8601 date strings listing dates to exclude)
%a
rdates in iCalendar format (semicolon-separated list of ISO8601 date strings listing recurrence dates)
%B
start time (also see %Z)
%C
create time
%c
task class
%D
due date/time.
%d
task description. (also see %F)
%E
due date/time in IMIP format
%e
exception rules in iCalendar format
%F
task description - folded line / iCalendar format (also see %d)
%G
this task's geographic location, the latitude and longitude.
%g
organizer's email address (cannot guarantee the authenticity of this value)
%K
organizer’s email in the form of a mailto:URL
%k
alarm count
%L
the location
%l
recurrence rules in iCalendar format
%M
modify time
%N
a new line
%n
"now" (the current time stamp and used with DTSTAMP)
%P
priority
%r
the recurrence id (blank if this task does not recur)
%S
is the task’s Sequence Number
%s
summary
%t
the status
%U
the UID
%u
URL to the task
%Z
used in conjunction with time field code to force the time to be rendered in UTC (%B displays the start time in local time whereas %ZB displays the start time in UTC time)
%%
displays the % character
% (sub-format code)
specify a sub-format for the data identified by code (for details, see Date Sub-Formatting)
Special Character Sequences for Dates
The following table shows the format code and meaning for Special Character Sequences for dates.
Note
The special date format codes appear in this section only for convenience. Calendar Server does not re-write any of the strftime codes, but simply uses the operating system implementation.
Simple Event Reminder Example
The following example shows the default event reminder message format:
The description of each line in this example is:
- Line 1 is the message subject.
- Line 2 begins with ~~, which indicates that it is a MIME wrapper line. That is, the replacement of special character sequences are those associated with an internal MIME object rather than an event or task. The special sequence %N is a line feed. The subject line does not need the special new line sequence, while all other lines do.
- Line 3 is also a MIME header line. It contains the special character sequence %s, which will be replaced by the character set associated with the event or task being mailed.
- Line 4 is the last MIME line, %x is the content transfer encoding string needed for this message.
- Line 5 lists the event summary and calls out the event summary with %s.
- Line 6 lists the event start time. It makes use of a sub-format string on the special character sequence %B. For details, see Date Sub-Formatting.
- Line 7 lists the event end time.
- Line 8 lists the location of the event.
- Line 9 lists the description of the event.
The following sample resembles the notification message generated by the above example:
From: jsmith@sesta.com (James Smith)
Date: Wed, 15 Nov 1999 19:13:49
To: jsmith@sesta.com
Subject: EVENT REMINDER
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Transfer-Encoding: 7bit
Summary: smtp_rig event 1
Start: Tues, 16 Nov 1999 02:00 PM
End: Tues, 16 Nov 1999 03:00 PM
Location: Green Conference Room
Description: This is the description for a randomly generated event.
Complex Event Reminder Example
The following example shows a more complex multipart message. This example has a text part and an IMIP PUBLISH part.
EVENT PUBLICATION
~~MIME-Version: 1.0%N
~~Content-Type: multipart/mixed; boundary="%b"%N%N
This is a multi-part message in MIME format.%N
~~--%b%N
~~Content-Type: text/plain; charset=%s%N
~~Content-Transfer-Encoding: %x%N%N
Summary: %s%N
Start: %(%a, %d %b %Y %I:%M %p)B%N
End: %(%a, %d %b %Y %I:%M %p)E%N
Location: %L%N%N
Description: %N%d%N%N
~~--%b%N
~~Content-Type: text/calendar; method=%m; component=%c; charset=%s%N
~~Content-Transfer-Encoding: %x%N%N
BEGIN:VCALENDAR%N
PRODID:-//iPlanet/Calendar Hosting Server//EN%N
METHOD:PUBLISH%N
VERSION:2.0%N
BEGIN:VEVENT%N
ORGANIZER:%K%N
DTSTAMP:%Zn%N
DTSTART:%ZB%N
DTEND:%ZE%N
SUMMARY:%s%N
UID:%U%N
%R
%A
%a
%e
%l
SEQUENCE:%S%N
LOCATION:%L%N
GEO:%G%N
%F
STATUS:%t%N
END:VEVENT%N
END:VCALENDAR%N
~~--%b--