Sun Java logo     Copyright      Index      Next     

Sun logo
Sun Java System Calendar Server 6 2005Q1 Administration Guide 

Contents


List of Procedures

List of Tables

List of Figures

About This Guide
Who Should Read This Guide
What You Need to Know
How This Guide is Organized
Document Conventions Used in This Guide
Monospaced Font
Italicized Font
Square Brackets [ ]
Braces { }
Vertical Bar (|)
Command-Line Prompts
Related Third-Party Web Site References
Accessing Sun Documentation Online

Chapter 1   Overview
Calendar Server Installation
Post Installation Configuration
Calendar Server Administrators
Calendar Server Administrator (calmaster)
Calendar Server User and Group
Superuser (root)
Proxy Administrator Logins
Calendar Server End User Administration
Creation of Calendar Server Users
Authentication of Calendar Server Users
Calendar Server User Preferences
Calendar Groups
Calendar Resources
Calendar Server Data
Calendar Server Data Format
Import and Export of Calendar Data
Calendar Links for Data Exchange
Calendar Server Alarms
Calendar Access Control
Secure Calendar Server Logins
Access Control by Users
Access Control Lists (ACLs)
Who
What
How
Grant
Examples of ACEs
Placing ACEs in an ACL
Calendar Server Internal Subsystems
Protocol Subsystem
Core Subsystem
Database Subsystem
Calendar Server Services
Administration Service: csadmind
HTTP Service: cshttpd
Automatic Backup Service: csstored
Event Notification Service (ENS): csnotifyd and enpd
Distributed Database Service: csdwpd
Calendar Server APIs and SDKs
Web Calendar Access Protocol (WCAP)
Calendar Server API (CSAPI)
Event Notification Service (ENS) API
Proxy Authentication SDK (authSDK)

Part I Postinstallation Configuration

Chapter 2   Directory Preparation Script (comm_dssetup.pl)
Installing the Directory Preparation Script
Before You Run the Directory Preparation Script
What the Directory Preparation Script Does
Directory Server Considerations
Information You Need to Gather
About the Schema Choices
Access Manager Considerations
Attribute Indexes
Running the Directory Preparation Script
Manually Updating Schema Files
Resolving Conflicting OIDs in the LDAP Schema Directory

Chapter 3   Calendar Server Configuration Program (csconfigurator.sh)
Gathering Your Configuration Information
LDAP Server Options
Directory Manager Options
Calendar Server Administrator
Email and Email Alarms Options
Runtime Configuration Options
Calendar Server Startup
Database, Logs, and Temporary Files Directories
Running csconfigurator.sh
Welcome Panel
Administration, User Preferences and Authentication Panel
Email and Email Alarms Panel
Runtime Configuration Panel
Select Directories Panel
Archive and HotBackup Configuration Panel
Ready to Configure Panel
Configuration Summary Panel

Chapter 4   Database Migration Utilities
Post-Installation Database Migration Utilities
Choosing the Right Utilities
csmig
csmig Functions
csmig Requirements
csmig Syntax
csmig Migration Steps
csmig Tips and Troubleshooting
The csmig dry run calendar shows the wrong owner for a calendar.
The LDAP calendar search doesn’t work correctly.
The csmig dry run indicates duplicate calendar names.
How do I assign orphan calendars to different owners?
How do I move calendar users to another back-end server?
csvdmig
csvdmig Functions
csvdmig Syntax
Mapping File
Destination DB
csvdmig Examples
commdirmig
Who Should Run the Utility
When to Run the Utility
Where to Find Documentation
Where to Find the Utility

Part II Customizing Your Calendar Server Configuration

Chapter 5   Customizing the Configuration File
Configuring the User Interface
Configuring Calendars
Configuring Calendar Users
Configuring Calendar Server
Configuring Logins and Authentication
Configuring Calendar Services
Configuring Calendar Server for the Berkeley Databases
Configuring Calendar Server for LDAP

Chapter 6   Configuring Calendar Database Distribution Across Multiple Machines
CLD Plug -in Overview
How the CLD Plug-in Works
Configurations Supported by the CLD Plug-in
Multiple Front-End Servers with Multiple Back-End Servers
Multiple Machines Functioning as Both Front-end and Back-end Servers
Enabling the CLD Plug-in
Configuring the Servers for CLD and DWP
Maintaining Security Between Front-End and Back-End Servers
How Authentication is Accomplished

Chapter 7   Configuring for High Availability (Failover Service)
Requirements for an HA Configuration
Installation and Configuration
Log in as root
Prepare Each Node in the Cluster
Install Sun Java Enterprise System Products and Packages
Node 1
Node 2
Selecting the Calendar Server Installation Directory
Installing Shared Components
Configure the Logical Host
Activate the Storage Resource
Configure Calendar Server
Locate Automatic Backup Directories on Shared Storage
Relocate the Calendar Server config Directory
To Change the Symbolic Link Found in /opt/SUNWics5/cal:
To Change the Symbolic Link Found in /opt/SUNWics5/lib:
To Change the Symbolic Link Found in /opt/SUNWics5/sbin:
Edit the Calendar Server ics.conf File
Start the HA Calendar Server
Verify the HA Configuration
Starting and Stopping Calendar Server HA Service
Related Documentation

Chapter 8   Configuring SSL
Configuring SSL for Calendar Server
Create the SSL Certificate Database
Mozilla Tools
Library Path Variable
Example Files and Directories
Request and Import a Certificate From a Root Certificate Authority (CA)
Configure SSL Parameters in the ics.conf File
Troubleshooting SSL
Checking for the cshttpd Process
Verifying Certificates
Reviewing Calendar Server Log Files
Connecting to the SSL Port

Chapter 9   Configuring Single Sign-on
Configuring SSO Through Access Manager
Considerations for Using SSO With Access Manager
Configuring SSO Through Communications Servers Trusted Circle Technology

Chapter 10   Configuring Automatic Backups (csstored)
Automatic Backups Overview
How Automatic Backups Work
How csstored Works
How Circular Backups Work
Setting up Transaction Log Files
Understanding Transaction Log Files
Specifying the Administrator’s Email Address
Email Messages Sent to the Administrator
Enabling Hotbackups
What are Hotbackups?
Enabling Archive Backups
What are Archive Backups?
Disabling the Warning Message
Why is the Message Emitted?

Chapter 11   Setting Up Hosted Domains
Overview of Hosted Domains
Organization of the LDAP Directory
Sun LDAP Schema 2
Sun LDAP Schema 1
Calendar Server Logins
Cross Domain Searches
Support for a Non-Hosted Domains Environment
Setting up a Hosted Domain Environment
Using Domains Created by Messaging Server

Part III Calendar Server Administration

Chapter 12   Administering Calendar Server
Starting and Stopping Calendar Server
About start-cal and stop-cal
Enabling or Disabling Automatic Backups
Managing the Group Scheduling Engine Queue
About GSE
About the GSE Queue
Monitoring Calendar Server
About csmonitor
Listing Counter Statistics
Using cstool for Monitoring
Using Calendar Server Log Files
Clearing the CLD Cache
Why Clear the Cache?
Changing a Server Name
Configuring Anonymous Access
Enabling Proxy Administrator Logins
Refreshing the Calendar Server Configuration
Turning Off the Old Calendar Express UI

Chapter 13   Administering Hosted Domains
Choosing the Correct User Management Tool
Creating New Hosted Domains
Enabling Cross Domain Searches
Modify the Access Control Information (ACI)
Enabling Hosted Domains

Chapter 14   Administering Users and Resources
Two User Management Tools
Creating Users and Resources
Administering Users
commadmin user delete
csuser disable
commadmin user create
csuser enable
commadmin user delete
csuser delete
Managing Resources
To Set Up a Bitbucket Channel for Resource Email
Managing User and Resource LDAP Attributes

Chapter 15   Administering Calendars
Calendar Administration Overview
Calendar Types
Schema 1 Tools for Calendars
Schema 2 Tools for Calendars
Creating Calendar Unique Identifiers (calids)
Calid Syntax
Calendar ID Creation Rules
Converting Non-Hosted Calids to Hosted Domain Format Calids
Automatic Creation of User Calendars
Automatic Calendar Creation Feature
Calendar Access Control
Configuration Parameters for Access Control
Public and Private Events and Tasks Filter
Command-Line Utilities for Access Control
Creating Calendars
Creating a User Calendar Using cscal
Preparing to Create Resource Calendars
Creating a Resource Calendar
Managing User Calendars
Managing Resource Calendars
Linking to a Calendar
Importing and Exporting Calendar Data
Exporting Calendar Data
Importing Calendar Data

Chapter 16   Administering Calendar Server Databases with csdb
Using csdb to Manage Calendar Databases
How csdb Groups Database Files
Calendar Database (caldb)
Session Database (sessdb)
Statistical Database (statdb)
csdb Can Target Specific Databases
csdb Administrative Tasks
Sample Rebuild Output

Chapter 17   Backing Up and Restoring Calendar Server Data
Backing Up Calendar Server Data
Backing Up the Calendar Database to a Directory
Backing Up a Specific Calendar to a File
Backing Up a User’s Default Calendar to a File
Restoring Calendar Server Data
Restoring the Calendar Database
Restoring a Calendar From a Backup Directory
Restoring a Calendar From a File
Restoring a User’s Default Calendar
Using Sun StorEdge Enterprise Backup™ or Legato NetworkerŽ
Calendar Server Backup/Restore Files
Backing Up Calendar Server Data Using Sun StorEdge Enterprise Backup software or Legato Networker
Restoring Calendar Server Data Using Sun StorEdge Enterprise Backup software or Legato Software

Chapter 18   Administering the Delete Log Database
Creation of the Delete Log Database
Querying the Delete Log Database
Purging the Delete Log Database
Automatic Purge of the Delete Log Database
Manual Purge of the Delete Log Database
Using Calendar Server Utilities for the Delete Log Database

Chapter 19   Administering Calendar Server Time Zones
Overview of Calendar Server Time Zones
Managing Calendar Server Time Zones
Adding a New Time Zone
Modifying an Existing Time Zone

Chapter 20   Using Instant Messaging Pop-up Reminders
Pop-up Reminders Overview
Pop-up Reminders Operation
Pop-up Reminders Architectural Flow
Configuring Instant Messaging Pop-ups

Chapter 21   Tuning Calender Server Performance
Indexing the LDAP Directory Server
Improving Calendar Search Performance in a DWP Environment
Improving Performance of Calendar Searching by Disabling Wildcard Searches
Improving Performance of the CLD Plug-in
Improving Performance of the LDAP Data Cache
Tuning the LDAP SDK Cache
Tuning Automatic Backups
Using a Memory-Based File System for the Session Database
Using Load Balancing Across Multiple CPUs
Using Timeout Values
Timeout Values for csadmind
HTTP Timeout Values for End Users
GSE Queue Timeout Value
Tuning the Calendar Express User Interface
Using the Refresh View Option
Disabling the Tool Bar Repainting Option
XSL Rendering in the Client Browser

Chapter 22   Troubleshooting
Turning on Debugging Information
Increase Logging Level
Enable Logging Access to the LDAP Cache
Monitor the System Using Calendar Server Utilities
Troubleshooting LDAP Issues
Calendar Server Utilities Won’t Work
Troubleshooting Migration Utilities
What to do Before Calling Technical Support
Where to Find the Migration Utilities
Troubleshooting Calendar Server
Pinging a Calendar Service
Fixing stop-cal Problems
Troubleshooting Searches that Don’t Complete Properly
Turning Off Those Annoying Daily Messages from csstored
Dealing with Database Issues
Finding Berkeley Database Tools
List of Available Tools
Detecting Database Corruption
Database Corruption Basics
Monitoring Log Files
Using csmonitor
Checking for Calendar Database Corruption
To Check for Calendar Database Corruption:
Preventing Service Interruptions When Your Database is Corrupted (Read-only Mode)
Using Read-only Mode
Handling Common Database Failures
Rebuilding a Corrupted Calendar Database
rebuild Overview
Sample Rebuild Output
Using the Dump and Load Procedure to Recover a Calendar Database
Dump and Load Overview
Restoring an Automatic Backup Copy
Before You Restore
Repairing Custom Backup Scripts
Berkeley Tools Now Compiled with a Dynamic Library

Part IV Appendixes

Appendix A   Directory Configuration Worksheet
Appendix B   Calendar Server Configuration Worksheet
Administration, User Preferences and Authentication Panel Worksheet
Email and Email Alarms Worksheet
Runtime Configuration Worksheet
Database, Logs, and Temporary Files Directories Worksheet

Appendix C   High Availability (HA) Configuration Worksheets
Calendar Server HA Configuration Worksheet
Calendar Server Installation Worksheet
Calendar Server Configuration Worksheet

Appendix D   Calendar Server Command-Line Utilities Reference
Running the Command-Line Utilities
Syntax for Command-Line Utilities
Usage Rules for Command-Line Utilities
Return Code in Scripts
Table of Command-Line Utilities
csattribute
Requirements
Syntax
Examples
csbackup
Requirements
Syntax
Examples
cscal
Requirements
Syntax
Examples
csclean
Requirements
Syntax
Examples
cscomponents
Requirements
Syntax
Examples
csdb
Requirements
Syntax
Examples
csdomain
Requirements
Syntax
LDAP Attributes and Property Names
Examples
csexport
Requirements
Syntax
Examples
csimport
Requirements
Syntax
Examples
csmonitor
Syntax
csplugin
Requirements
Syntax
Examples
cspurge
Requirements
Syntax
Examples
csrename
Requirements
Syntax
Examples
csresource
Requirements
Syntax
Examples
csrestore
Requirements
Syntax
Examples
csschedule
Requirements
Syntax
Examples
csstart (deprecated)
Requirements
Syntax
Examples
csstats
Requirements
Syntax
Examples
csstop (deprecated)
Requirements
Syntax
Examples
cstool
Requirements
Syntax
Examples
csuser
Requirements
Syntax
Examples
start-cal
Requirements
Syntax
Example
stop-cal
Requirements
Syntax
Example

Appendix E   Calendar Server Configuration Parameters
Editing the ics.conf Configuration File
Configuration Parameters (ics.conf) File
Local Configuration
Calendar Store Configuration
Calendar Log Information Configuration
Administrator Configuration Parameters
Services Configuration
SSL Configuration
Hosted Domain Configuration
Alarm Notification Parameters
Calendar Lookup Database Configuration
LDAP Data Cache Configuration Parameters
Resource Calendar Configuration Parameters
Single Sign-on (SSO) Configuration
Configuring SSO Through Access Manager
Configuring SSO Through Communications Servers Trusted Circle Technology
Group Scheduling Engine (GSE) Configuration
Database Configuration
Automatic Backups of the Calendar Database
Calendar Database Parameters for ENS Messages
Event Notification Server (ENS) Configuration
Calendar Server API Configuration
Calendar Express Configuration
csmonitor Utility Configuration
Counters Configuration (counter.conf) File
Alarm Counters
Disk Usage Counters
HTTP Counters
Group Scheduling Counters
Authentication Counters
WCAP Counters
Database Counters
Server Response Counters
Session Status Counters
Notification Messages
Calendar Server Mail Parameters
Special Character Sequences for Events
Date Sub-Formatting
Example
Conditional Printing
Special Character Sequences for Task Notifications
Special Character Sequences for Dates
Simple Event Reminder Example
Complex Event Reminder Example

Glossary


Copyright      Index      Next     

Part No: 819-0024-10.   Copyright 2005 Sun Microsystems, Inc. All rights reserved.