Apama Documentation : About the Apama Version 9.12 Documentation : Documentation roadmap
Documentation roadmap
Apama provides documentation in the following formats:
*HTML (viewable in a web browser)
*PDF (available from the documentation website)
*Eclipse help (accessible from Software AG Designer)
You can access the HTML documentation on your machine after Apama has been installed:
*Windows. Select Start > All Programs > Software AG > Tools > Apama n.n > Apama Documentation n.n. Note that Software AG is the default group name that can be changed during the installation.
*UNIX. Display the index.html file, which is in the doc/apama-onlinehelp directory of your Apama installation directory.
The following table describes the different guides that are available.
Title
Description
Release Notes
Describes new features and changes since the previous release.
Installing Apama
Instructions for installing Apama.
Introduction to Apama
Introduction to developing Apama applications, discussions of Apama architecture and concepts, and pointers to sources of information outside the documentation set.
Using Apama with Software AG Designer
Instructions for using Software AG Designer to create and test Apama projects, develop EPL programs, define Apama queries, develop JMon programs, and store, retrieve and play back data.
Developing Apama Applications
Describes the different technologies for developing applications: EPL monitors, Apama queries, and Java. You can use one or several of these technologies to implement a single Apama application. In addition, there are C++, C, and Java APIs for developing components that plug in to a correlator. You can use these components from EPL.
Connecting Apama Applications to External Components
Describes how to connect Apama applications to any event data source, database, messaging infrastructure, or application. The general alternatives for doing this are as follows:
*Implement standard Apama Integration Adapter Framework (IAF) adapters.
*Create applications that use correlator-integrated messaging for JMS, webMethods Universal Messaging or Software AG Digital Event Services.
*Use connectivity plug-ins written in Java or C++.
*Develop adapters with Apama APIs for Java and C++.
*Develop client applications with Apama APIs for Java, .NET, and C++.
Building and Using Dashboards
Describes how to build and use an Apama dashboard, which provides the ability to view and interact with data views. An Apama project typically uses one or more dashboards, which are created in the Dashboard Builder. The Dashboard Viewer provides the ability to use dashboards created in Dashboard Builder. Dashboards can also be deployed as simple Web pages, applets, or WebStart applications. Deployed dashboards connect to one or more correlators by means of a Dashboard Data Server or Display Server.
Deploying and Managing Apama Applications
Describes how to deploy components with Software AG Command Central. Also provides information for:
*Improving Apama application performance by using multiple correlators and saving and reusing a snapshot of a correlator's state.
*Managing and monitoring over REST (Representational State Transfer).
*Using correlator utilities.
In addition to the above guides, Apama also provides the following API reference information:
*API Reference for EPL in ApamaDoc format
*API Reference for Java in Javadoc format
*API Reference for C++ in Doxygen format
*API Reference for .NET in HTML format
Copyright © 2013-2017 Software AG, Darmstadt, Germany.

Product LogoContact Support   |   Community   |   Feedback