Documentation

New to Coral8?

The following documents are good places to start for people wanting to learn how to use the features of Coral8 products:

• Coral8 Getting Started. This is a tutorial which explains how to write CCL queries and how to build simple CCL programs.
• Coral8 CCL Cookbook, by President and CTO Mark Tsimelzon (PDF, 226 KB)
• CEP Design Patterns. This paper was published by Coral8 President and CTO Mark Tsimelzon. It contains a detailed examination of the critical, reusable design patterns typically found in CEP applications.

HTML Product Documentation (Release 5.5)

Coral8 Documentation. Opens a new window containing an HTML version of the entire documentation set with full search capabilities.

PDF Product Documentation (Release 5.5)

The following documents make up the standard documentation set that accompanies each product release of Coral8:

• Coral8 Release Notes. This document provides an overview of the latest features and changes made in Coral8 Release 5.5 on October 20, 2008.
• Coral8 Getting Started. This is a tutorial which explains how to write simple CCL queries and how to build simple CCL programs.
• Coral8 CCL Reference. This document is a comprehensive language reference manual for CCL. The first of its kind for a SQL-based CEP language, it covers a complete guide on the grammar, syntax and semantics of CCL.
• Coral8 Programmer's Guide. This document provides information on how to write CCL queries and use CCL in the development of Coral8 applications.
• CEP Design Patterns. This paper was published by Coral8 President and CTO Mark Tsimelzon. It contains a detailed examination of the critical, reusable design patterns typically found in CEP applications.
• Coral8 Engine FAQ (Basic). Covers the questions on the basic functionality of the Coral8 Engine
• Coral8 Engine FAQ (Advanced). Answers more advanced questions concerning the Coral8 engine.
• Coral8 Administrator's Guide. This guide explains how to install Coral8 on all platforms, and provides important information on running, administering and monitoring a Coral8 system.
• Coral8 Studio Guide. This guide explains basic and advanced usage of the Coral8 Studio, including query editing, schema editing, setting properties of query modules, streams and adapters, how to use stream and window viewers, the flow viewer and the server monitor. It also introduces the use of the Coral8 Studio to assist in debugging queries and modules.
• Coral8 Integration Guide. This guide provides information on interfacing Coral8 with the outside world. It explains how to use and write custom Coral8 adapters for sending data to and receiving data from the Coral8 Engine. It also explains how to use Coral8 SDKs to control the Coral8 Engine by starting and stopping modules, monitoring execution and registering dynamically created CCL queries.
• Coral8 Portal Guide. This document contains information about the Coral8 Portal, a dashboard and visualization server that allows users to dynamically query and work with real-time output from the Coral8 Engine. The guide explains how a business user can set up queries and charts for viewing the data, and how an administrator user can create templates, streams, queries and actions, as well as new users to provide business users with an easy way to visualize the data they are interested in.

White Papers

The following white papers explain the Coral8 technology and how it applies to technical, industry and business problems:

• Coral8 Technology Overview (PDF, 642 KB)
• Coral8 Guide to Evaluating CEP Engines (PDF, 326 KB)
• Native XML Processing: Why CEP Cannot Fake It (PDF, 212 KB)

Technical Articles

The following technical articles cover specific aspects of the use of Coral8 that will be of interest to developers:

• Coral8 Shared Windows,
  by Architect Bob Hagmann (PDF, 172 KB)
• Introducing Coral8 Portal,
  by Architect Bob Hagmann (PDF, 1.8 MB)
• Coral8 CCL Cookbook,
  by President and CTO Mark Tsimelzon (PDF, 226 KB)
• BPEL to CCL Translator Guide,
  by Architect Bob Hagmann (PDF, 181 KB)
• Understanding Latency,
  by Architect Bob Hagmann (PDF, 165 KB)
• Stream, Schema, Adapter, and Parameter CCL Language Extensions,
  by Architect Bob Hagmann (PDF, 95 KB)
• Remote Procedure Call Integration with Coral8,
  by Architect Bob Hagmann (PDF, 146 KB)
• Understanding Database Connections,
  by Architect Bob Hagmann (PDF, 186 KB)
• Evaluating Performance,
  by Architect Bob Hagmann (PDF, 129 KB)
• Optimizing Performance,
  by Architect Bob Hagmann (PDF, 181 KB)
• State Persistence,
  by Architect Bob Hagmann (PDF, 209 KB)
• HighAvailability,
  by Architect Bob Hagmann (PDF, 191 KB)
• Dynamic Queries,
  by Architect Bob Hagmann (PDF, 116 KB)
• Patterns,
  by Architect Bob Hagmann (PDF, 132 KB)
• Designing Coral8 Access Control Policies,
  by Jonnie Pekelny (PDF, 100 KB)
• How To Configure High Availability (HA) Managers,
  by Mark Gilkey (PDF, 20 KB)
• Fundamentals of Time in Coral8,
  by Architect Bob Hagmann (PDF, 100 KB)
• The Coral8 Status Stream,
  by Architect Bob Hagmann (PDF, 104 KB)
• Coral8 XML Cookbook,
  by Architect Bob Hagmann (PDF, 335 KB)

Prior Release Notes

• Coral8 Release 5.4. This document provides an overview of the latest features and changes made in Coral8 Release 5.4 on July 31, 2008.
• Coral8 Release 5.3.3. This document provides an overview of the latest features and changes made in Coral8 Release 5.3.3 on June 16, 2008.
• Coral8 Release 5.3. This document provides an overview of the latest features and changes made in Coral8 Release 5.3 on April 30, 2008.
• Coral8 Release 5.2. This document provides an overview of the latest features and changes made in Coral8 Release 5.2 on February 29, 2008.
• Coral8 Release 5.1. This document provides an overview of the latest features and changes made in Coral8 Release 5.1 on October 7, 2007.
• Coral8 Release 5.0. This document provides an overview of the latest features and changes made in Coral8 Release 5.0 on June 27, 2007.
• Coral8 Release 4.8. This document provides an overview of the latest features and changes made in Coral8 Release 4.8 on March 29, 2007.
• Coral8 Release 4.6. This document provides an overview of the latest features and changes made in Coral8 Release 4.6 on December 18, 2006.