Steltor Calendar API (CAPI) 2.0.1

This file was last updated 11 February 2002

Thank you for choosing Steltor's Calendar API (CAPI). This readme contains all installation information. Please see the release notes for a list of included features and a description of known problems. For general questions and troubleshooting information about CAPI, see the FAQs available on the Steltor Web site.

Use of this software is subject to the terms detailed in the license agreement.

Overview:

CAPI gives access to the calendar server database through a series of C function calls. Use these functions to create your own clients and develop your own applications. This release of CAPI contains functionality to fetch, store, and delete calendar events.
Note: calendar events must be in iCalendar format, wrapped in MIME. Please refer to RFC 2445 for a description of this format.

Contents of this package:

This package contains the folowing:

README.html (this file)
license.txt CAPI License Agreement
License_DES_readme.txt - License Agreement for the DES ACE encryption plug-in
"inc" directory with the API header file (ctapi.h)
"lib" directory with the Steltor shared libraries including CAPI
"demo" directory with sample applications
"docs" directory with the CAPI Reference Manual (Reference.html)

System requirements

One of the following Steltor calendar servers:

CorporateTime Server 4.0 or greater (5.1 or greater recommended, certified against 5.2)
Lexacom Calendar Server 4.0 or greater (5.1 or greater recommended, certified against 5.2)
Lexacom Enterprise Calendar Server 5.1 or greater (certified against 5.2)

Please note that older calendar server versions may not be able to take advantage of all CAPI functionality.

This version is certified against the following platforms:

SPARC Solaris 2.6 (using Sun's recommended patches from 21 February 2001 and Sun Workshop 5.0)
HP-UX 10.20 (using cc version A.10.32.30 and aCC version A.01.23)
IBM AIX 4.3.3 (using VisualAge C++ 5.0)
Red Hat Linux 6.1 (using egcs-2.91.66 19990314/Linux (ecgs-1.1.2 release) compiler)
Microsoft Windows NT 4.0 (using MSVC 6.0)

Installation:

CAPI is a shared library, libcapi.so for UNIX, capi.dll for Microsoft Windows NT and capi on Macintosh. This library must be accessible to the system. Additionally, this version of CAPI requires the standard Steltor shared libraries in the capi/lib directory. These files are included in this package and should be accessible by your CAPI applications both at compile time and at run time.

UNIX

Under UNIX, set the runtime library path to include the directory which contains the libraries. For example, if CAPI (libcapi.so) is installed in the subdirectory 'pkg/capi' of your home directory, the following command should do this:

Solaris, Linux:: setenv LD_LIBRARY_PATH $LD_LIBRARY_PATH":"$HOME"/pkg/capi/lib"
HP-UX:: setenv SHLIB_PATH $SHLIB_PATH":"$HOME"/pkg/capi/lib"
AIX:: setenv LIBPATH $LIBPATH":"$HOME"/pkg/capi/lib"

Under Microsoft Windows NT the directory containing capi.dll should be included in your path variable. Either copy the dll to a directory in the path, for example, the Windows system directory, or add the directory containing capi.dll to the path by selecting Start Menu | Settings | Control Panel | System and modifying the PATH variable in the Environment tab.

Macintosh

The Steltor standard shared libraries, the CAPI shared library capi, and any ACE plugins you wish to use must either be in the same folder as your application or in the Extensions Folder. Other Steltor products may install shared libraries in a folder named Steltor in your Extensions Folder, so we suggest following the same convention.

Warning

If you use other Steltor products you may already have copies of the Steltor standard shared libraries installed. Be sure not to overwrite newer versions of these libraries with older ones.

Uninstallation:

To uninstall CAPI delete the shared library, and if necessary remove the directory which was added to the environment variable.

Migration from CAPI 1.0:

If you have created meetings with CAPI 1.0, you will need to migrate these meetings before using any higher versions of CAPI, including 2.0. In this case, please contact Steltor Support at support@steltor.com to obtain a copy of the migration utility.