•  About this Documentation
  • Documentation roadmap
  • Online Information and Support
  • Data Protection
•  Release Notes
  • Overview
  • License Terms and Technical Restrictions
  • Deprecated and removed capabilities
  •  What's New In Apama 10.15.4
    • EPL enhancements in 10.15.4
    • New EPL plug-in for Base64 encoding and decoding in 10.15.4
    • Connectivity plug-ins enhancements in 10.15.4
    • PySys changes in 10.15.4
    • Removed and deprecated features in 10.15.4
    • Errata
  •  What's New In Apama 10.15.3
    • Apama helper classes for PySys in 10.15.3
    • Connectivity plug-ins enhancements in 10.15.3
    • EPL enhancements in 10.15.3
    • Miscellaneous enhancements and changes in 10.15.3
    • Miscellaneous changes in 10.15.3 affecting backwards compatibility
  •  What's New In Apama 10.15.2
    • EPL enhancements in 10.15.2
    • Dashboard enhancements in 10.15.2
    • Miscellaneous changes in 10.15.2 affecting backwards compatibility
    • Removed and deprecated features in 10.15.2
  •  What's New In Apama 10.15.1
    • Installation changes in 10.15.1
    • PySys ApamaHelper class in 10.15.1
    • Miscellaneous changes in 10.15.1 affecting backwards compatibility
  •  What's New In Apama 10.15.0
    • Installation changes in 10.15.0
    • Connectivity plug-ins enhancements in 10.15.0
    • Miscellaneous enhancements and changes in 10.15.0
    • Platform changes in 10.15.0
    • Miscellaneous changes in 10.15.0 affecting backwards compatibility
    • Removed and deprecated features in 10.15.0
  •  What's New In Apama 10.11.3
    • PySys changes in 10.11.3
    • Dashboard enhancements in 10.11.3
    • Miscellaneous enhancements and changes in 10.11.3
    • Miscellaneous changes in 10.11.3 affecting backwards compatibility
  • What's New In Apama 10.11.2
  •  What's New in Apama 10.11.1
    • Miscellaneous enhancements and changes in 10.11.1
    • Miscellaneous changes in 10.11.1 affecting backwards compatibility
    • Removed and deprecated features in 10.11.1
  •  What's New in Apama 10.11.0
    • Java upgrade in 10.11.0
    • Compiler upgrade in 10.11.0
    • Python upgrade in 10.11.0
    • PySys changes in 10.11.0
    • Apama enhancements in Software AG Designer in 10.11.0
    • Dashboard enhancements in 10.11.0
    • Miscellaneous enhancements and changes in 10.11.0
    • Platform changes in 10.11.0
    • Miscellaneous changes in 10.11.0 affecting backwards compatibility
    • Removed and deprecated features in 10.11.0
  •  What's New In Apama 10.7.2
    • Connectivity plug-ins enhancements in 10.7.2
    • EPL enhancements in 10.7.2
    • Miscellaneous changes in 10.7.2 affecting backwards compatibility
  •  What's New In Apama 10.7.1
    • Connectivity plug-ins enhancements in 10.7.1
    • EPL code coverage enhancements in 10.7.1
    • AnyExtractor enhancements in 10.7.1
    • Miscellaneous enhancements and changes in 10.7.1
    • Miscellaneous changes in 10.7.1 affecting backwards compatibility
    • Removed and deprecated features in 10.7.1
  •  What's New In Apama 10.7.0
    • PySys changes in 10.7.0
    • Connectivity plug-ins enhancements in 10.7.0
    • Miscellaneous enhancements and changes in 10.7.0
    • Platform changes in 10.7.0
    • Miscellaneous changes in 10.7.0 affecting backwards compatibility
    • Removed and deprecated features in 10.7.0
  •  What's New In Apama 10.5.4
    • Connectivity plug-ins enhancements in 10.5.4
    • Miscellaneous changes in 10.5.4 affecting backwards compatibility
  •  What's New In Apama 10.5.3
    • PySys changes in 10.5.3
    • Connectivity plug-ins enhancements in 10.5.3
    • Miscellaneous enhancements and changes in 10.5.3
  •  What's New In Apama 10.5.2
    • Cumulocity API enhancements in 10.5.2
    • Miscellaneous enhancements and changes in 10.5.2
    • Miscellaneous changes in 10.5.2 affecting backwards compatibility
  •  What's New In Apama 10.5.1
    • PySys enhancements in 10.5.1
    • Connectivity plug-ins enhancements in 10.5.1
    • EPL enhancements in 10.5.1
    • Miscellaneous enhancements and changes in 10.5.1
    • Platform changes in 10.5.1
    • Support for Red Hat Enterprise Linux (RHEL) 8.0 in 10.5
    • Miscellaneous changes in 10.5.1 affecting backwards compatibility
  •  What's New In Apama 10.5.0
    • New Apama image on Docker Hub in 10.5.0
    • Change of Java Log4j logging library in 10.5.0
    • PySys changes in 10.5.0
    • Connectivity plug-ins enhancements in 10.5.0
    • Apama enhancements in Software AG Designer in 10.5.0
    • EPL enhancements in 10.5.0
    • Miscellaneous enhancements and changes in 10.5.0
    • Platform changes in 10.5.0
    • Miscellaneous changes in 10.5.0 affecting backwards compatibility
    • Removed and deprecated features in 10.5.0
    • Migrating the Cumulocity IoT transports to 10.5
  •  What's New In Apama 10.3.1
    • New command-line tool for adding Apama projects in 10.3.1
    • New Base64 codec connectivity plug-in in 10.3.1
    • New Batch Accumulator codec connectivity plug-in in 10.3.1
    • New Message List codec connectivity plug-in in 10.3.1
    • Connectivity plug-ins enhancements in 10.3.1
    • Apama enhancements in Software AG Designer in 10.3.1
    • EPL enhancements in 10.3.1
    • Miscellaneous enhancements and changes in 10.3.1
    • Platform changes in 10.3.1
    • Miscellaneous changes in 10.3.1 affecting backwards compatibility
    • Removed and deprecated features in 10.3.1
  •  What's New In Apama 10.3.0
    • New Cumulocity IoT transport connectivity plug-in in 10.3.0
    • New EPL plug-in for JSON support in 10.3.0
    • New Prometheus support in 10.3.0
    • New Python EPL plug-in support in 10.3.0
    • PySys changes in 10.3.0
    • Connectivity plug-ins enhancements in 10.3.0
    • Apama enhancements in Software AG Designer 10.3.0
    • EPL enhancements in 10.3.0
    • Correlator utility enhancements in 10.3.0
    • Command Central support in 10.3.0
    • Dashboard enhancements in 10.3.0
    • Miscellaneous enhancements and changes in 10.3.0
    • Platform changes in 10.3.0
    • Miscellaneous changes in 10.3.0 affecting backwards compatibility
    • Removed and deprecated features in 10.3.0
  •  What's New In Apama 10.2
    • New support for using the TCStore driver for queries in 10.2
    • New Kubernetes support in 10.2
    • Connectivity plug-ins enhancements in 10.2
    • Apama enhancements in Software AG Designer 10.2
    • Query enhancements in 10.2
    • EPL enhancements in 10.2
    • Correlator utility enhancements in 10.2
    • Command Central support in 10.2
    • Miscellaneous enhancements and changes in 10.2
    • Platform changes in 10.2
    • Miscellaneous changes in 10.2 affecting backwards compatibility
    • Removed and deprecated features in 10.2
  •  What's New In Apama 10.1
    • New any type in 10.1
    • New HTTP server transport connectivity plug-in in 10.1
    • New EPL plug-in for R in 10.1
    • New TCStore driver (for Terracotta DB) for the MemoryStore in 10.1
    • MemoryStore enhancements in 10.1
    • Connectivity plug-ins enhancements in 10.1
    • Apama enhancements in Software AG Designer 10.1
    • Query enhancements in 10.1
    • EPL enhancements in 10.1
    • Correlator utility enhancements in 10.1
    • Dashboard enhancements in 10.1
    • Miscellaneous enhancements and changes in 10.1
    • Platform changes in 10.1
    • Miscellaneous changes in 10.1 affecting backwards compatibility
    • Removed and deprecated features in 10.1
  •  What's New In Apama 10.0
    • New HTTP client transport connectivity plug-in in 10.0
    • Apama integration with MQTT in 10.0
    • Apama integration with Kafka in 10.0
    • Connectivity plug-ins enhancements in 10.0
    • New API for writing EPL plug-ins in C++ in 10.0
    • Apama enhancements in Software AG Designer 10.0
    • Query enhancements in 10.0
    • EPL enhancements in 10.0
    • Correlator utility enhancements in 10.0
    • Dashboard enhancements in 10.0
    • Miscellaneous enhancements and changes in 10.0
    • Platform changes in 10.0
    • Windows compiler update in 10.0
    • Miscellaneous changes in 10.0 affecting backwards compatibility
    • Removed and deprecated features in 10.0
    • Migrating the C and C++ EPL plug-ins written in 9.12 or earlier
  •  What's New In Apama 9.12
    • Apama integration with Software AG Digital Event Services in 9.12
    • Apama integration with Universal Messaging in 9.12
    • New optional type in 9.12
    • New Microsoft Edge support in 9.12
    • Connectivity plug-ins enhancements in 9.12
    • Connectivity API changes in 9.12.0.1
    • Apama enhancements in Software AG Designer 9.12
    • Query enhancements in 9.12
    • EPL enhancements in 9.12
    • Correlator utility enhancements in 9.12
    • Dashboard enhancements in 9.12
    • PySys enhancements in 9.12
    • Command Central support in 9.12
    • Miscellaneous enhancements and changes in 9.12
    • Platform changes in 9.12
    • Miscellaneous changes in 9.12 affecting backwards compatibility
    • Removed and deprecated features in 9.12
  •  What's New In Apama 9.10
    • New connectivity plug-ins feature in 9.10
    • New query and DataView metadata feature in 9.10
    • New EPL memory profiler feature in 9.10
    • New EPL code coverage feature in 9.10
    • New PySys version in 9.10
    • New dashboard server HTTP REST support in 9.10
    • New JSON-based REST support in 9.10
    • Command Central support in 9.10
    • Apama enhancements in Software AG Designer 9.10
    • EPL enhancements in 9.10
    • Correlator utility enhancements in 9.10
    • Dashboard enhancements in 9.10
    • Miscellaneous enhancements and changes in 9.10
    • Platform changes in 9.10
    • Supported JDK version in 9.10
    • Miscellaneous changes in 9.10 affecting backwards compatibility
    • Removed and deprecated features in 9.10
  •  What's New In Apama 9.9
    • Installation changes in 9.9
    • Query enhancements in 9.9
    • Apama enhancements in Software AG Designer 9.9
    • EPL enhancements in 9.9
    • Correlator utility enhancements in 9.9
    • Dashboard enhancements in 9.9
    • Miscellaneous enhancements and changes in 9.9
    • New samples in 9.9 showing how to containerize Apama for Docker (Linux only)
    • Platform changes in 9.9
    • Renaming of Apama client libraries in 9.9
    • Miscellaneous changes in 9.9 affecting backwards compatibility
    • Removed and deprecated features in 9.9
•  Readme
  •  Usage Notes
    • ADBC
    • Adapters
    • Software AG Designer
    • Correlator
    • Dashboards
    • Other
  •  Resolved Issues
    • Release 10.15.4.1
    • Release 10.15.4
    • Release 10.15.3.4
    • Release 10.15.3.3
    • Release 10.15.3.2
    • Release 10.15.3.1
    • Release 10.15.3
    • Release 10.15.2.4
    • Release 10.15.2.3
    • Release 10.15.2.1
    • Release 10.15.2
    • Release 10.15.1.2
    • Release 10.15.1
    • Release 10.15.0.2
    • Release 10.15.0
    • Release 10.11.3.3
    • Release 10.11.3.2
    • Release 10.11.3.1
    • Release 10.11.3
    • Release 10.11.2.1
    • Release 10.11.2
    • Release 10.11.1.2
    • Release 10.11.1.1
    • Release 10.11.1
    • Release 10.11.0.1
    • Release 10.11.0
    • Release 10.7.2.1
    • Release 10.7.2
    • Release 10.7.1.3
    • Release 10.7.1.2
    • Release 10.7.1.1
    • Release 10.7.1
    • Release 10.7.0
    • Release 10.5.3.3
    • Release 10.5.3.2
    • Release 10.5.3.1
    • Release 10.5.3
    • Release 10.5.2.1
    • Release 10.5.2
    • Release 10.5.1
    • Release 10.5.0
    • Release 10.3.1.5
    • Release 10.3.1.1
    • Release 10.3.1
    • Release 10.3.0
    • Release 10.2.0
    • Release 10.1.0
    • Release 10.0.0
•  Installing Apama
  • Overview
  •  Before You Start the Installation
    • Supported platforms
    • Ways to install Apama
    • Disk space requirements
    • License file
    • System clock
    • Persistence database backup
    • Windows platform notes
    • Linux platform notes
  •  Installing Apama Using the Software AG Installer
    • Prerequisites
    • Running the Software AG Installer
    • Installing the latest fixes
    • Running the Software AG Uninstaller
    • Uninstalling Apama service packs or fixes
  •  Installing Apama Using Debian apt
    • Overview of installing Apama with Debian apt
  •  Installing Apama Using Command Central
    • Overview of installing Apama with Command Central
    • Uninstalling Apama with Command Central
  •  After the Installation
    • Post-installation steps
    • Post-installation considerations for Linux users
•  Introduction to Apama
  • Overview
  •  Apama Overview
    • What is Apama?
    • About Apama license files
    • Running Apama without a license file
  •  Apama Architecture
    • Distinguishing architectural features
    • How Apama integrates with external data sources
    •  Descriptions of Apama components
      • Description of the Apama correlator
      • Description of Apama EPL
      • Description of Software AG Designer
      • Description of Dashboard Builder and Dashboard Viewer
      • Description of client development kits
      • Description of Apama's Data Player
    • How the correlator works
  •  Apama Concepts
    • Event-driven programming
    • Complex event processing
    • Understanding monitors and listeners
  •  Getting Ready to Develop Apama Applications
    • Becoming familiar with Apama
    • Introduction to Software AG Designer
    • Steps for developing Apama applications
    • Overview of starting, testing and debugging applications
  •  Apama Glossary
    • action
    • activation
    • aggregate function
    • batch
    • bundle
    • .cdp
    • CEP
    • channel
    • connectivity plug-in
    • context
    • correlator
    • correlator deployment package
    • correlator-integrated messaging for JMS
    • .csv
    • current events
    • DataView
    • EPL
    • EPL plug-in
    • event
    • event collection
    • event listener
    • event pattern
    • event template
    • .evt
    • exception
    • listener
    • lot
    • MemoryStore
    • method
    • .mon
    • monitor
    • MonitorScript
    • optional
    • partitioning
    • Software AG Designer
    • stack trace element
    • static action
    • stream
    • stream listener
    • stream network
    • stream query
    • stream source template
    • window
•  Using Apama with Software AG Designer
  • Overview
  •  Overview of Developing Apama Applications
    • Starting Software AG Designer
    • Demos and tutorials
    • The Apama interface
    •  The Apama Workbench perspective
      • Workbench Project view
    •  The Apama Developer perspective
      • Project Explorer view
    • The Apama Runtime perspective
    •  About Apama projects
      • Managing project hierarchies
      • Editors
      • Outline view
      • Scenario Browser view
      • Engine Receive view
      • Engine Status view
      • Engine Information view
      • Console view
      • Problems view
      • Data Player Control view
    • Building Apama projects
    • Launching Apama projects
  •  Working with Projects
    • Creating Apama projects
    •  Adding resources to Apama projects
      • Creating new monitor files for EPL applications
      •  Creating new event definition files for EPL applications
        • Creating event definitions by adding EPL code
        • Creating event definitions from XML files
        • Creating event definitions from XSD files
      •  Creating new files for JMon applications
        • Adding a new JMon application
        • Adding a JMon monitor
        • Adding a JMon event
      • Adding an EPL Plug-in written in Java
      • Creating new dashboards
      • Creating new dashboard-deployment configurations
      • Creating new event files
      • Event Type Selection
      • Adding resources to EPL projects
      •  Adding resources to JMon projects
        • Java Configuration Editor
        • Adding JMon applications
        • Adding JMon classes
        • Adding non-JMon Java files
      • Adding Docker support to Apama projects
      •  Adding bundles to projects
        • Adding EPL bundles to projects
        •  Adding connectivity and adapter bundles to projects
          • Bundle instances
          • Connectivity bundles
          • Using the Digital Event Services connectivity bundle
          • Adding the Universal Messaging connectivity plug-in to a project
          • Adding the MQTT connectivity plug-in to a project
          • Adding the HTTP server connectivity plug-in to a project
          • Adding the HTTP client connectivity plug-in to a project
          • Adding the Kafka connectivity plug-in to a project
          • Adding the Cumulocity IoT connectivity plug-in to a project
          • Removing a bundle instance
    •  Editing Apama files
      • Obtaining content assistance
      • Using auto-completion
      • Displaying information for events and actions
      • Specifying comments
      • Using auto-indent
      • Using auto-bracketing
      • Using tabs
      • Defining shorthand (templates) for frequently used EPL code
      • Sharing templates among Software AG Designer  installations
      • Specifying colors to distinguish EPL elements
      • Shortcuts when editing Apama files
    •  Navigating in Apama files
      • Using the Outline view to navigate
      • Using the Quick Outline to navigate
      • Jumping to an event or action definition or variable declaration
      • Opening EPL elements and Java classes using the Open Type dialog
      • Searching in Apama project files
      • Search tab
    •  Building Apama projects
      • Build automatically when a resource changes
      • Build all Apama projects
      • Build one Apama project
      • Build a working set
      • Clean and rebuild projects
      •  Configuring the project EPL build path
        • Project source files
        • Specifying projects
        •  Specifying external dependencies
          • Specifying dependencies for a single-user project
          • Specifying dependencies for a multi-user project
        • Specifying the project bundles properties
        • Defining Apama Build Path variables
    • Importing projects
    • Reusing dependency, variable and catalog configuration with extension (.ste) files
    •  Exporting project information
      • Exporting a project initialization file list
      • Exporting to a deployment script
      • Exporting correlator deployment packages
      • Exporting ApamaDoc
    •  Deleting projects and resources
      • Deleting resources
      • Deleting projects
    • Adding the Apama nature to a project
    • Adding the Java nature to an Apama project
    • Viewing all EPL objects in all projects
    • Internationalizing Apama applications
    • Checking the error log
    • Checking the Apama log file for Software AG Designer
    • Specifying an adapter configuration in a launch configuration
    • Using Software AG Designer to configure adapters that use Universal Messaging
  •  Using Query Designer
    • Adding query files to projects
    • Steps for using Software AG Designer to implement queries
    • Overview of creating a query in the Design tab
    •  Creating queries in Query Designer
      • Configuring a query
      • Adding query inputs
      • Adding query patterns
      • Adding query parameters
      •  Adding query conditions
        • Adding query condition filters (where)
        • Adding query time constraints (within)
        • Adding query exclusions (without)
      •  Adding query aggregates
        • Adding query aggregate calculations
        • Adding query aggregate filters
      •  Adding query actions
        • Adding query send event actions
        • Adding query custom EPL actions
        • Adding query route event actions
      • Specifying a time period in Query Designer
      • Editing source code in Query Designer
      • Errors in query definitions
      • Enabling diagnostic logging
    • Configuring query projects
    • Exporting query deployment scripts
  •  Launching Projects
    •  Running Apama projects
      •  Default launch configuration
        • Workbench perspective
        • Developer perspective
      • Defining custom launch configurations
      •  Adding a correlator
        • Correlator arguments
        • Persistence options
        • Connectivity
        • Injections
        • Event Files
      • Configuring correlator log settings in Designer
      • Connecting correlators
      • Adding an external process
      • Testing a subset of your Apama application
      • Troubleshooting connection problems in Software AG Designer
    •  Monitoring Apama applications
      • Console view
      •  Using the Engine Information view
        • Sending an event from the Engine Information view
      •  Using the Engine Receive view
        • Engine Receive Viewer preferences
        • Specifying channels for the Engine Receive View
      • Using the Engine Status view
      •  Using the Scenario Browser view
        • Displaying the Scenario Browser
        • Browsing query definitions
        • Creating a new instance a parameterized query
        • Viewing the instances of a scenario
        • Editing an instance of a parameterized query
        • Deleting an instance of a parameterized query
        • Deleting all instances of a parameterized query
      • Dashboards
  •  Debugging EPL Applications
    • Adding breakpoints
    •  Launching a debug session
      • Creating a debug configuration
    • Debugging a remote application
    • Debug view for an EPL application
    • Breakpoints view for an EPL application
    • Variables view for an EPL application
    • Command-line debugger
  •  Debugging JMon Applications
    • Preparing the correlator for remote debugging
    • Creating a debug run configuration
    •  Debug perspective
      • Using the Debug view with a JMon application
      • Working with breakpoints in a JMon application
      • Viewing stack frame variables for a JMon application
    • Additional resources for Java debugging
  •  Profiling EPL Applications
    •  Launching profiling sessions
      • Launching a default profiling session
      •  Launching a custom profiling session
        • Creating a custom profile launch configuration
        • Correlator Profile Configurations
      •  Launching a remote profiling session
        • Creating a remote profiler launch configuration
    •  The Apama Profiler perspective
      • Profiling Monitor view
      •  Execution Statistics view
        • The Execution Statistics tab
        • Comparison of Execution Statistics tab
      • Viewing EPL code
    •  Using filters
      • Creating a Filter
      • Managing Filters
    • Taking snapshots
    • Using snapshots
    • Choosing profiling information columns
    • Updating profile data
    • Displaying Apama perspective preferences
  •  Using the Data Player
    • Introduction to the Data Player
    •  Using the Data Player
      • Adding the ADBC adapter
      • Launching the project
      • Specifying Data Player playback queries
    •  Data Player Control view
      • Playback settings
      • Playback controls
      • Playback status
    • Creating Data Player query templates
    • Command-line Data Player interface
  •  Setting the Apama Preferences
    • Showing the Apama-specific preferences
    • Exporting the Apama-specific preferences
    • Importing the Apama-specific preferences
    • Apama
    • Catalogs
    • EPL
    • Editor Colors
    • Editor Formatting
    • Editor Templates
    • Apama Build Path Variables
    • Profiling and Logging
    • Query
    • Syntax Coloring
    • Workbench
•  Developing Apama Applications
  • Overview
  •  Developing Apama Applications in EPL
    •  Getting Started with Apama EPL
      • Introduction to Apama Event Processing Language
      • How EPL applications compare to applications in other languages
      • About dynamic compilation in the correlator
      • About the Apama development environment in Software AG Designer
      • Terminology
      •  Defining event types
        • Allowable event field types
        • Format for defining event types
        • Example event type definition
      •  Working with events
        • Making event type definitions available to monitors
        • Channels and input events
    •  Defining Monitors
      •  About monitor contents
        • Loading monitors into the correlator
        • Terminating monitors
        • Unloading monitors from the correlator
      • Example of a simple monitor
      •  Spawning monitor instances
        • How spawning works
        • Sample code for spawning
        • Terminating monitor instances
        • About executing ondie() actions
        • Specifying parameters when spawning
      •  Communication among monitor instances
        • Organizing behavior into monitors
        • Event processing order for monitors
        • Allocating events in monitors
        • Sending events to other monitors
        • Defining your application's message exchange protocol
        • Using events to control processing
      • About service monitors
      • Adding predefined annotations
      •  Subscribing to channels
        • About the default channel
        • About wildcard channels
      • Adding service monitor bundles to your project
      • Utilities for operating on monitors
    •  Defining Queries
      •  Introduction to queries
        • Example of a query
        • Use cases for queries
        • Delayed and out of order events
        • Query terminology
        • Overview of query processing
        • Overview of query application components
      • Format of query definitions
      • Defining metadata in a query
      •  Partitioning queries
        • Defining query keys
        • Defining actions as query keys
        • Query partition example with one input
        • Query partition example with multiple inputs
        • About keys that have more than one field
      •  Defining query input
        • Format of input definitions
        • Behavior when there is more than one input
        • Specifying event duration in windows
        • Using the output of another query as query input
        • Specifying maximum number of events in windows
        • Specifying event duration and maximum number of events
        • Using source timestamps of events
        • Using heartbeat events with source timestamps
        • Out of order events
        • Matching only the latest event for a given field
      •  Finding and acting on event patterns
        •  Defining event patterns
          • Query followed-by operator
          • Query and operator
          • Query or operator
          • Query wait operator
          • Query conditions
          • Query condition ranges
          • Special behavior of the and operator
          • Aggregating event field values
        • Event matching policy
        • Acting on pattern matches
        • Defining actions in queries
      •  Implementing parameterized queries
        • Parameterized queries as templates
        • Using the Scenario Service to manage parameterized queries
        • Referring to parameters in queries
        • Scaling and performance of parameterized queries
      • Restrictions in queries
      • Best practices for defining queries
      • Testing query execution
      • Communication between monitors and queries
    •  Defining Event Listeners
      • About event expressions and event templates
      • Specifying the on statement
      • Using a stream source template to find events of interest
      •  Defining event expressions with one event template
        • Listening for one event
        • Listening for all events of a particular type
        • Listening for events with particular content
        • Using positional syntax to listen for events with particular content
        • Using name/value syntax to listen for events with particular content
        • Listening for events of different types
        • Listening for events of all types
      • Terminating and changing event listeners
      • Specifying multiple event listeners
      • Listening for events that do not match
      •  Specifying completion event listeners
        • Example using unmatched and completed
      • Improving performance by ignoring some fields in matching events
      • Defining event listeners for patterns of events
      •  Specifying and/or/xor/not logic in event listeners
        • Specifying the 'or' or 'xor' operator in event expressions
        • Specifying the 'and' operator in event expressions
        • Example event expressions using 'and/or' logic in event listeners
        • Specifying the 'not' operator in event expressions
        •  Specifying 'and not' logic to terminate event listeners
          • Pausing event listeners
          • Choosing which action to execute
          • Specifying 'and not' logic to detect when events are missing
      •  How the correlator executes event listeners
        • How the correlator evaluates event expressions
        • Avoiding event listeners that trigger upon instantiation
        • When the correlator terminates event listeners
        • How the correlator evaluates event listeners for a series of events
        • Evaluating event listeners for all A-events followed by B-events
        • Evaluating event listeners for an A-event followed by all B-events
        • Evaluating event listeners for all A-events followed by all B-events
      •  Defining event listeners with temporal constraints
        • Listening for event patterns within a set time
        • Waiting within an event listener
        • Triggering event listeners at specific times
        • Using variables to specify times
      •  Understanding time in the correlator
        • Correlator timestamps and real time
        • Event arrival time
        • About timers and their trigger times
        •  Disabling the correlator's internal clock
          • Externally generating events that keep time (&TIME events)
          • About repeating timers and &TIME events
          • Setting the time in the correlator (&SETTIME event)
      • Out of band connection notifications
    •  Working with Streams and Stream Queries
      • Introduction to streams and stream networks
      •  Defining streams
        • Creating streams from event templates
        • Terminating streams
      •  Using output from streams
        • Listener variables and streams
        • Coassigning to sequences in stream listeners
      •  Defining stream queries
        • Linking stream queries together
        • Simple example of a stream network
        • Stream query definition syntax
        • Stream query processing flow
        • Specifying input streams in from clauses
        •  Adding window definitions to from and join clauses
          • Window definition syntax
          • Defining time-based windows
          • Defining size-based windows
          • Combining time-based and size-based windows
          • Defining batched windows
          • Partitioning streams
          • Partitions and aggregate functions
          • Using multiple partition by expressions
          • Partitioning time-based windows
          • Defining content-dependent windows
        •  Joining two streams
          • Defining cross-joins with two from clauses
          • Defining equi-joins with the join clause
        • Filtering items before projection
        •  Generating query results
          • Aggregating items in projections
          • Filtering items in projections
        • IEEE special values in stream query expressions
      •  Defining custom aggregate functions
        • Example of defining a custom aggregate function
        • Defining actions in custom aggregate functions
        • Overloading in custom aggregate functions
        • Distinguishing duplicate values in custom aggregate functions
      •  Working with lots that contain multiple items
        • Stream queries that generate lots
        •  Behavior of stream queries with lots
          • Size-based windows and lots
          • Join operations and lots
          • Grouped projections and lots
      •  Stream network lifetime
        • Disconnection vs termination
        • Rules for termination of stream networks
      •  Using dynamic expressions in stream queries
        • Behavior of static and dynamic expressions in stream queries
        • When to avoid dynamic expressions in stream queries
        • Ordering and side effects in stream queries
        •  Understanding when the correlator evaluates particular expressions
          • Using dynamic expressions in windows
          • Using dynamic expressions in equi-joins
          • Using dynamic expressions in where predicates
          • Using dynamic expressions in projections
        •  Examples of using dynamic expressions in stream queries
          • Example of altering query window size or period
          • Example of altering a threshold
          • Example of looking up values in a dictionary
          • Example of actions and methods in dynamic expressions
      •  Troubleshooting and stream query coding guidelines
        • Prefer on statements to from statements
        • Know when to spawn and when to partition
        • Filter early to minimize resource usage
        • Avoid duplication of stream source template expressions
        • Avoid using large windows where possible
        • In some cases prefer retain all to a timed window
        • Prefer equi-joins to cross-joins
        • Be aware that time-based windows can empty
        • Be aware that fixed-size windows can overflow
        • Beware of accidental stream leaks
    •  Defining What Happens When Matching Events Are Found
      •  Using variables
        • Using global variables
        • Using local variables
        • Using variables in listener actions
        • Specifying named constant values
      •  Defining actions
        • Format for defining actions
        • Invoking an action from another action
        • Specifying actions in event definitions
        • Using action type variables
      • Defining static actions
      • Getting the current time
      •  Generating events
        • Generating events with the route statement
        • Generating events with the send statement
        • Sending events to com.apama.Channel objects
        • Enqueuing to contexts
        • Generating events to emit to outside receivers
      • Handling the any type
      • Handling any values of different types with the switch statement
      • Assigning values
      • Defining conditional logic with the if statement
      • Defining conditional logic with the ifpresent statement
      • Defining loops
      • Exception handling
      •  Logging and printing
        • Specifying log statements
        • Log levels determine results of log statements
        • Where do log entries go?
        • Examples of using log statements
        • Strings in print and log statements
      • Sample financial application
    •  Implementing Parallel Processing
      •  Introduction to contexts
        • What is inside/outside a context?
        • About context properties
        • Context lifecycle
        • Comparison of a correlator and a context
      • Creating contexts
      • How many contexts can you create?
      • Using channels to communicate between contexts
      • Obtaining context references
      • Spawning to contexts
      • Channels and contexts
      • Sending an event to a channel
      • Sending an event to a particular context
      • Sending an event to a sequence of contexts
      • Common use cases for contexts
      •  Samples for implementing contexts
        • Simple sample implementation of contexts
        • Running samples of common concurrency problems
        • About the samples of concurrency problems
        • About the race sample
        • About the deadlock sample
        • About the compareswap sample
      • Contexts and correlator determinism
      •  How contexts affect other parts of your Apama application
        • About input logs and parallel processing
        • Deadlock avoidance when parallel processing
        • Clock ticks when parallel processing
        • Using EPL plug-ins in parallel processing applications
    •  Using Functional Operations in EPL
      • Functional operators
      • Functional listeners
      • Generators
      • Partially bound functions
    •  Using Correlator Persistence
      • Description of state that can be persistent
      • When persistence is useful
      • When non-persistent monitors are useful
      • How the correlator persists state
      • Enabling correlator persistence
      •  How the correlator recovers state
        • Recovery order
        • Defining recovery actions
        • Simplest recovery use case
      • Designing applications for persistence-enabled correlators
      • Upgrading monitors in a persistence-enabled correlator
      •  Sample code for persistence applications
        • Sample code for discarding stale state during recovery
        • Sample code for recovery behavior based on downtime duration
        • Sample code that recovers subscription to non-persistent monitor
      • Requesting snapshots from EPL
      • Developing persistence applications
      • Backing up the persistence database while the correlator is running
      • Using EPL plug-ins when persistence is enabled
      • Using the MemoryStore when persistence is enabled
      • Comparison of correlator persistence with other persistence mechanisms
      • Restrictions on correlator persistence
    •  Common EPL Patterns in Monitors
      •  Contrasting using a dictionary with spawning
        • Translation using a dictionary
        • Translation using spawning
      •  Factory pattern
        • Canonical factory pattern
        • Alternate factory pattern
      • Using quit() to terminate event listeners
      • Combining the dictionary and factory patterns
      • Testing uniqueness
      • Reference counting
      •  Inline request-response pattern
        • Routing events for request-response behavior
        • Canonical form for synchronous requests
      • Writing echo monitors for debugging
      • Versioning and upgrading monitors
    •  Using EPL Plug-ins
      • Overhead of using plug-ins
      • When to use plug-ins
      • When not to use plug-ins
      •  Using the TimeFormat event library
        • TimeFormat format functions
        • TimeFormat parse functions
        • Format specification for the TimeFormat functions
        • Supported time zones
      •  Using the MemoryStore
        • Introduction to using the MemoryStore
        • Overview of MemoryStore events
        • Adding the MemoryStore bundle to your project
        •  Steps for using the MemoryStore
          • Preparing and opening stores
          • Description of row structures
          • Preparing and opening tables
          • Using transactions to manipulate rows
          • Determining which commit action to call
          • Creating and removing rows
          • Iterating over the rows in a table
          • Requesting persistence
        • Exposing in-memory or persistent data as DataViews
        • Monitoring status for the MemoryStore
        • Restrictions affecting MemoryStore disk files
      •  Using the distributed MemoryStore
        • Overview of the distributed MemoryStore
        • Distributed store transactional and data safety guarantees
        •  Configuring a distributed store
          • Adding distributed MemoryStore support to a project
          • Adding a distributed store to a project
          • Configuring a distributed store
          • Launching a project that uses a distributed store
        • Interacting with a distributed store
        • Configuration files for distributed stores
        • Standard configuration properties for distributed stores
        • TCStore (Terracotta) driver details
        • BigMemory Max driver details
        • Migrating from BigMemory Max to TCStore
        • Changing bean property values when deploying projects
        • Creating a distributed MemoryStore driver
      • Using the Management interface
      • Using the JSON plug-in
      • Using the Base64 plug-in
      •  Using MATLAB® products in an application
        • MatlabManager actions
        • MATLAB examples
      •  Using the R plug-in
        • Introduction to using the R plug-in
        • Adding the R Support bundle to your project
        • Steps for using the R plug-in
        • R plug-in samples
      • Interfacing with user-defined EPL plug-ins
      • About the chunk type
    •  Making Application Data Available to Clients
      • Adding the DataView Service bundle to your project
      • Creating DataView definitions
      • Deleting DataView definitions
      • Creating DataView items
      • Deleting DataView items
      • Updating DataView items
      • Looking up field positions
      • Using multiple correlators
    •  Testing and Tuning EPL Monitors
      • Optimizing EPL programs
      •  Best practices for writing EPL
        • Wildcard fields that are not relevant
        • Avoiding unnecessary allocations
        • Implementing states
      • Structure of a basic test framework
      • Using event files
      •  Handling runtime errors
        • What happens
        • Using ondie() to diagnose runtime errors
        • Using logging to diagnose errors
        • Standard diagnostic log output
      • Capturing test output
      • Avoiding listeners and monitor instances that never terminate
      • Handling slow or blocked receivers
      • Diagnosing infinite loops in the correlator
      •  Tuning contexts
        • Parallel processing for instances of an event type
        • Parallel processing for long-running calculations
    •  Generating Documentation for Your EPL Code
      • Code constructs that are documented
      • Steps for using ApamaDoc
      • Inserting ApamaDoc comments
      • Inserting ApamaDoc tags
      • Inserting ApamaDoc references
      • Inserting EPL source code examples
      • Generating ApamaDoc from the command line
      • Generating ApamaDoc from an Ant script
  •  Developing Apama Applications in Java
    •  Overview of Apama JMon Applications
      • Introducing JMon API concepts
      •  About event types
        • Simple example of an event type
        • Extended example of a JMon event type
        • Comparing JMon and EPL event type parameters
        • About event parameters that are complex types
        • Non-null values for non-primitive event field types
      • About monitors
      •  About event listeners and match listeners
        • Example of a MatchListener
        • Defining multiple listeners
        • Removing listeners
      • Description of the flow of execution in JMon applications
      •  Parallel processing in JMon applications
        • Overview of contexts in JMon applications
        • Using contexts in JMon applications
        • Using the Context class default constructor
        • Descriptions of methods on the Context class
      • Identifying external events
      •  Optimizing event types
        • Wildcarding parameters in event types
      • Logging in JMon applications
      • Using EPL keywords as identifiers in JMon applications
    •  Defining Event Expressions
      •  About event templates
        • Specifying positional syntax
        • Specifying completed event templates
      • Specifying parameter constraints in event templates
      • Obtaining matching events
      • Emitting, routing, and enqueuing events
      •  Specifying temporal sequencing
        • Chaining listeners
        • Using temporal operators
      •  Defining advanced event expressions
        • Specifying other temporal operators
        • Specifying a perpetual listener for repeated matching
        • Deactivating a listener
        • Temporal contexts
        •  Specifying the timer operators
          • Looking for event sequences within a set time
          • Waiting within a listener
          • Working with absolute time
      • Optimizing event expressions
      • Validation of event expressions
    •  Concept of Time in the Correlator
      • Getting the current time
      • About timers and their trigger times
    •  Developing and Deploying JMon Applications
      • Steps for developing JMon applications in Software AG Designer
      • Java prerequisites for using Apama's JMon API
      • Steps for developing JMon applications manually
      • Deploying JMon applications
      • Removing JMon applications from the correlator
      •  Creating deployment descriptor files
        • Format for deployment descriptor files
        • Specifying the classpath in deployment descriptor files
        • Defining event types in deployment descriptor files
        • Defining monitor classes in deployment descriptor files
        • Inserting annotations for deployment descriptor files
        • Sample source files with annotations
        • Generating deployment descriptor files from annotations
      • Package names and namespaces in JMon applications
      • Sample JMon applications
  •  Developing EPL Plug-ins
    • Introduction to EPL Plug-ins
    • Providing an EPL Event Wrapper for a Plug-in
    •  Writing EPL Plug-ins in C++
      •  Creating a plug-in using C++
        • Method signatures
        • Compiling C++ plug-ins
        • Exceptions
        • Writing to the correlator log file
        • Storing data using chunks
        • Sending events
        • Receiving events
        • Blocking behavior of plug-ins
        • Load-time or unload-time code
        • Handling thread-specific data in plug-ins
      • Using plug-ins written in C++
    •  Writing EPL Plug-ins in Java
      •  Creating an EPL plug-in using Java
        • Permitted signatures for methods
      • Using EPL plug-ins written in Java
      • Steps for developing EPL plug-ins written in Java in Software AG Designer
      • Java prerequisites for using Apama's API for EPL plug-ins written in Java
      • Steps for developing EPL plug-ins written in Java manually
      • Deploying EPL plug-ins written in Java
      • Removing EPL plug-ins written in Java from the correlator
      •  Creating deployment descriptor files for EPL plug-ins written in Java
        • Format for deployment descriptor files
        • Specifying the classpath in deployment descriptor files
        • Defining plug-ins in deployment descriptor files
        • Inserting annotations for deployment descriptor files
        • Generating deployment descriptor files from annotations
      •  Sample EPL plug-ins written in Java
        • A simple plug-in in Java
        • A more complex plug-in in Java
        • A plug-in in Java that sends events
        • A plug-in in Java that subscribes to receive events
    •  Writing EPL Plug-ins in Python
      •  Creating a plug-in using Python
        • Method signatures and types
        • Exceptions
        • Writing to the correlator log file
        • Sending events
      • Using Python plug-ins
      • Installing Python modules
      • Sample plug-ins written in Python
  •  Protecting Personal Data in Apama Applications
    • Introduction
    • Where personal data is held within the Apama platform
    • Documenting personal data flows within an Apama application
    • Handling personal data in the "in-memory" state of the correlator
    • Handling personal data "at rest" in the correlator persistence and JMS datastores
    • Handling personal data "in motion" from dashboards
    •  Handling personal data "at rest" in log files
      • Example log messages containing personal data
      • Protecting and erasing data from Apama log files
      • Recommended log levels
      • Recommendations for logging by Apama application code
    • Handling personal data "at rest" in the correlator input log file
    • Handling personal data "at rest" in containerization environments
  •  EPL Reference
    •  Introduction
      • Hello World example
    •  Types
      • Primitive and string types
      • Reference types
      • Default values for types
      • Type properties summary
      • Timestamps, dates, and times
      • Type methods and instance methods
      • Type conversion
      • Comparable types
      • Cloneable types
      •  Potentially cyclic types
        • Which types are potentially cyclic?
        • String form of potentially cyclic types
      • Support for IEEE 754 special values
    •  Events and Event Listeners
      •  Event definitions
        • Event fields
        • Event actions
        • Event field and action scope
      •  Event templates
        • By-position qualifiers
        • By-name qualifiers
        • Range expressions
        • Field operators
      • Event listener definitions
      • Event lifecycle
      • Event listener lifecycle
      • Event processing order for monitors
      • Event processing order for queries
      •  Event expressions
        • Event primaries
        • Timers
        • The not operator
        • The all operator
        • The and, xor, and or logical event operators
        • The followed-by event operator
        • Event expression operator precedence
      • Event channels
    •  Monitors
      • Monitor lifecycle
      • Monitor files
      • Packages
      • The using declaration
      • Monitor declarations
      • The import declaration
      •  Monitor actions
        • Simple actions
        • Actions with parameters
      • Contexts
      • Plug-ins
      • Garbage collection
    •  Queries
      • Query lifetime
      • Query definition
      • Metadata section
      • Parameters section
      • Inputs section
      • Query input definition
      •  Find statement
        • Pattern
        • Where condition
        • Within condition
        • Without condition
        • Between clause
        • Select clause
        • Having clause
    •  Aggregate Functions
      • Built-in aggregate functions
      • Custom aggregates
    •  Statements
      •  Simple statements
        • Assignments
        • The emit statement
        • The enqueue . . . to statement
        • The log statement
        • The print statement
        • The route statement
        • The send . . . to statement
        • The spawn statement
        • The spawn action to context statement
        • The throw statement
      •  Compound statements
        • The for statement
        • The from statement
        • The if statement
        • The ifpresent statement
        • The on statement
        • The switch statement
        • The try ... catch statement
        • The while statement
      •  Transfer of control statements
        • The break statement
        • The continue statement
        • The die statement
        • The return statement
    •  Expressions
      • Introduction to expressions
      • Using an expression as a statement
      • Primary expressions
      •  Bitwise logical operators
        • Bitwise intersection (and)
        • Bitwise union (or)
        • Bitwise exclusive (xor)
        • Unary bitwise inverse
      •  Logical operators
        • Logical intersection (and)
        • Logical union (or)
        • Logical exclusive or (xor)
        • Unary logical inverse (not)
      •  Shift operators
        • Left shift operator
        • Right shift operator
      • Comparison operators
      • Additive operators
      • Multiplicative operators
      • Unary additive operators
      • Expression operators
      • Expression operator precedence
      •  Postfix expressions
        • Action and method calls
        • The subscript operator [ ]
        • The new object creation operator
      •  Stream queries
        • Stream query window definitions
      • Stream source templates
    •  Variables
      • Variable declarations
      •  Variable scope
        • Predefined variable scope
        • Monitor scope
        • Action scope
        • Block scope
        • Event action scope
        • Custom aggregate function scope
      •  Provided variables
        • currentTime
        • Event timestamps
        • self
      • Specifying named constant values
    •  Lexical Elements
      • Program text
      • Comments
      • White space
      • Line terminators
      • Symbols
      • Identifiers
      • Keywords
      • Operators
      • Separators
      •  Literals
        • Boolean literals
        •  Integer literals
          • Base 10 literals
          • Base 16 literals
        • Floating point and decimal literals
        • String literals
        • Location literals
        • Dictionary literals
        • Sequence literals
        • Time literals
      • Names
      • Annotations
    • Limits
  • EPL Naming Conventions
  • Testing Apama Applications Using PySys
•  Connecting Apama Applications to External Components
  • Overview
  •  Working with Connectivity Plug-ins
    •  Getting Started with Connectivity Plug-ins
      • Concepts
      • Adding the connectivity bundles
      • Specifying the main settings in the properties file
      • Specifying the settings for the connectivity chains in the YAML file
      • Controlling how the correlator interacts with a chain
      • Using codecs
      • Writing EPL
    •  Using Connectivity Plug-ins
      • Overview of using connectivity plug-ins
      • Static and dynamic connectivity chains
      • Configuration file for connectivity plug-ins
      • Host plug-ins and configuration
      • Translating EPL events using the apama.eventMap host plug-in
      • Using reliable transports
      • Creating dynamic chains from EPL
      • Sending and receiving events with connectivity plug-ins
      • Deploying plug-in libraries
    •  Developing Connectivity Plug-ins
      • Chain components and messages
      • Requirements of a plug-in class
      • Requirements of a transport chain manager plug-in class
      • Building plug-ins
      • C++ data types
      • Map contents used by the apama.eventMap host plug-in
      • Metadata values
      • Lifetime of connectivity plug-ins
      • Creating dynamic chains from a chain manager plug-in
      • User-defined status reporting from connectivity plug-ins
      • Logging and configuration
      • Threading
      • Developing reliable transports
      • Flushing background queues in connectivity plug-ins
      • General notes for developing transports
  •  Standard Connectivity Plug-ins
    •  The Universal Messaging Transport Connectivity Plug-in
      • About the Universal Messaging transport
      •  Overview of using Universal Messaging in Apama applications
        • Comparison of Apama channels and Universal Messaging channels
        • Choosing when to use Universal Messaging channels and when to use Apama channels
        • General steps for using Universal Messaging in Apama applications
        • Using Universal Messaging channels instead of engine_connect
        • Using Universal Messaging channels instead of configuring IAF adapter connections
        • Considerations for using Universal Messaging channels
      • Setting up Universal Messaging for use by Apama
      •  Configuring the Universal Messaging connectivity plug-in
        • Loading the Universal Messaging transport
        • Configuring the connection to Universal Messaging (dynamicChainManagers)
        • Configuring message transformations (dynamicChains)
        • Using dynamic replacement variables
        • Subscribing to automatically created Universal Messaging channels
        • Channel lookup caching
        • Supported payloads
      • EPL and Universal Messaging channels
      • Using Universal Messaging connectivity from EPL
      • Monitoring Apama application use of Universal Messaging
    •  The MQTT Transport Connectivity Plug-in
      • About the MQTT transport
      • Using MQTT connectivity from EPL
      • Loading the MQTT transport
      • Configuring the connection to MQTT
      • Mapping events between MQTT messages and EPL
      • Payload for the MQTT message
      • Wildcard topic subscriptions
      • Metadata for the MQTT message
      • Restrictions
    •  The Digital Event Services Transport Connectivity Plug-in
      • About the Digital Event Services transport
      • Using Digital Event Services connectivity from EPL
      • Reliable messaging with Digital Event Services
    •  The HTTP Server Transport Connectivity Plug-in
      • About the HTTP server transport
      • Loading the HTTP server transport
      • Configuring the HTTP server transport
      • Handling requests to different paths with different chains
      • Handling responses in EPL
      • Serving static files
      •  Mapping events between EPL and HTTP server requests
        • Distinguishing request types
        • Handling HTTP headers
        • Handling HTTP form decoding
        • Mapping the body
        • Dealing with cookies
        • Providing HTTP query parameters
        • Examples
      •  HTTP server security
        • TLS
        • Authentication
      • Monitoring status for the HTTP server
    •  The HTTP Client Transport Connectivity Plug-in
      • About the HTTP client transport
      • Loading the HTTP client transport
      • Configuring the HTTP client transport
      •  Mapping events between EPL and HTTP client requests
        • Distinguishing response types
        • Handling HTTP headers
        • Handling HTML form encoding
        • Handling HTML form encoding using a predefined generic event definition
        • Mapping the body
        • Dealing with cookies
        • Providing HTTP query parameters
        • Example mapping rules
      • Monitoring status for the HTTP client
      • Configuring dynamic connections to services
      • Using predefined generic event definitions to invoke HTTP services with JSON and string payloads
      • Executing HTTP requests concurrently
    •  The Kafka Transport Connectivity Plug-in
      • About the Kafka transport
      • Loading the Kafka transport
      • Configuring the connection to Kafka (dynamicChainManagers)
      • Configuring message transformations (dynamicChains)
      • Payload for the Kafka message
      • Metadata for the Kafka message
    •  The Cumulocity IoT Transport Connectivity Plug-in
      • About the Cumulocity IoT transport
      • Configuring the Cumulocity IoT transport
      • Loading the Cumulocity IoT transport
      •  Using managed objects
        • Updating a managed object
        • Querying for managed objects
      •  Using alarms
        • Creating a new alarm
        • Updating an existing alarm
        • Querying for alarms
      •  Using events
        • Creating a new event
        • Updating an existing event
        • Querying for events
      •  Using measurements
        • Creating a new measurement
        • Querying for measurements
      •  Using measurement fragments
        • Creating measurement fragments
        • Listening for measurement fragments
        • Turning measurement fragments on/off
        • Handling measurement fragments
      •  Using operations
        • Creating a new operation
        • Updating an existing operation
        • Querying for operations
      • Receiving update notifications
      • Paging Cumulocity IoT queries
      • Invoking other parts of the Cumulocity IoT REST API
      • Invoking microservices
      • Monitoring status for Cumulocity IoT
      • Finding tenant options
      • Getting user details
      • Optimizing requests to Cumulocity IoT with concurrent connections
      • Working with multi-tenant deployments
      • Sample EPL
    •  Codec Connectivity Plug-ins
      • The String codec connectivity plug-in
      • The Base64 codec connectivity plug-in
      • The JSON codec connectivity plug-in
      • The Classifier codec connectivity plug-in
      • The Mapper codec connectivity plug-in
      • The Batch Accumulator codec connectivity plug-in
      • The Message List codec connectivity plug-in
      • The Unit Test Harness codec connectivity plug-in
      • The Diagnostic codec connectivity plug-in
  •  Correlator-Integrated Support for the Java Message Service (JMS)
    •  Using the Java Message Service (JMS)
      •  Overview of correlator-integrated messaging for JMS
        • Samples for using correlator-integrated messaging for JMS
        • Key concepts for correlator-integrated messaging for JMS
      •  Getting started with simple correlator-integrated messaging for JMS
        • Adding and configuring connections
        •  Adding JMS receivers
          • Configuring receiver event mappings
          • Using conditional expressions
        • Adding a classpath variable entry
        • Configuring sender event mappings
        • Using EPL to send and receive JMS messages
      • Getting started with reliable correlator-integrated messaging for JMS
      •  Mapping Apama events and JMS messages
        • Simple mapping for JMS messages
        • Using expressions in mapping rules
        • Template-based XML generation
        •  Adding multiple XPath mapping rules for a received XML document
          • Using Treat As on JMS Body dialog - Sender
          • Using Treat As on JMS Body dialog - Receiver
          • Using the Type Chooser dialog
        •  Using the XPath Helper
          • Launching the XPath Helper
          • Setting node properties
          • Generating XPath expressions
          • Adding and removing namespaces
          • Evaluating XPath expressions
        •  Using convention-based XML mapping with JMS messages
          • Convention-based JMS message mapping example
          • Using convention-based XML mapping when receiving/parsing messages
          • Using convention-based XML mapping when sending/generating messages
          • Combining convention-based XML mapping with template-based XML generation
          • Add Computed Node dialog
          • XMLDecode
        • Handling binary data
        • Using custom EL mapping extensions
        • JUEL mapping expressions reference for JMS
        • Implementing a custom Java mapper
        • Specifying transformation types
      • Dynamic senders and receivers
      • Durable topics
      • Receiver flow control
      • Monitoring correlator-integrated messaging for JMS status
      • Logging correlator-integrated messaging for JMS status
      •  JMS configuration reference
        • Configuration files for JMS
        • XML configuration file format
        •  XML configuration bean reference
          • Advanced configuration bean properties
      •  Designing and implementing applications for correlator-integrated messaging for JMS
        •  Using correlator persistence with correlator-integrated messaging for JMS
          • How reliable JMS sending integrates with correlator persistence
          • How reliable JMS receiving integrates with correlator persistence
        •  Sending and receiving reliably without correlator persistence
          • Receiving messages with APP_CONTROLLED acknowledgements
          • Sending messages reliably with application flushing notifications
        • Using the correlator input log with correlator-integrated messaging for JMS
        • Reliability considerations when using JMS
        • Duplicate detection when using JMS
        •  Performance considerations when using JMS
          • Performance logging when using JMS
          • Receiver performance when using JMS
          • Sender performance when using JMS
        • Configuring Java options and system properties when using JMS
      • Diagnosing problems when using JMS
      • JMS failures modes and how to cope with them
  •  Working with IAF Plug-ins
    •  The Integration Adapter Framework
      • Overview
      • Architecture
      • The transport layer
      • The codec layer
      • The Semantic Mapper layer
      • Contents of the IAF
    •  Using the IAF
      •  The IAF runtime
        • IAF library paths
        • IAF command-line options
        • IAF log file status messages
        • IAF log file rotation
        •  Using the Apama component extended configuration file
          • Binding server components to particular addresses
          • Ensuring that client connections are from particular addresses
          • Setting environment variables for Apama components
          • Sample extended configuration file
      • IAF Management – Managing a running adapter I
      • IAF Client – Managing a running adapter II
      • IAF Watch – Monitoring running adapter status
      •  The IAF configuration file
        • Including other files
        • Transport and codec plug-in configuration
        • Event mappings configuration
        • Apama correlator configuration
        • Configuring IAF adapters to use Universal Messaging
        • Defining Universal Messaging properties for the IAF
        • Communicating with the correlator over Universal Messaging
        • Logging configuration (optional)
        • Java configuration (optional)
    •  C/C++ Transport Plug-in Development
      •  The C/C++ transport plug-in development specification
        • Transport functions to implement
        • Defining the transport function table
        • The transport constructor, destructor and info functions
        • Other transport definitions
        • Transport utilities
        • Communication with the codec layer
    •  C/C++ Codec Plug-in Development
      •  The C/C++ codec plug-in development specification
        •  Codec functions to implement
          • Codec encoder functions
          • Codec decoder functions
        •  Defining the codec function tables
          • The codec function table
          • The codec encoder function table
          • The codec decoder function table
          • Registering the codec function tables
        • The codec constructor, destructor and info functions
        • Other codec definitions
        • Codec utilities
        • Communication with other layers
        • Working with normalized events
    •  C/C++ Plug-in Support APIs
      • Logging from IAF plug-ins in C/C++
      •  Using the latency framework
        • C/C++ timestamp
        • C/C++ timestamp set
        • C/C++ timestamp configuration object
        • C/C++ latency framework API
    •  Transport Plug-in Development in Java
      •  The transport plug-in development specification for Java
        • Java transport functions to implement
        •  Communication with the codec layer
          • Sending upstream messages received from a codec plug-in to a sink
          • Sending downstream messages received from a source on to a codec plug-in
        • Transport exceptions
        • Logging
    •  Java Codec Plug-in Development
      •  The codec plug-in development specification for Java
        • Java codec functions to implement
        •  Communication with other layers
          • Sending upstream messages received from the Semantic Mapper to a transport plug-in
          • Sending downstream messages received from a transport plug-in to the Semantic Mapper
        • Java codec exceptions
        • Semantic Mapper exceptions
        • Logging
        • Working with normalized events
    •  Plug-in Support APIs for Java
      • Logging from IAF plug-ins in Java
      •  Using the latency framework
        • Java timestamp
        • Java timestamp set
        • Java timestamp configuration object
        • Java latency framework API
    •  Monitoring Adapter Status
      • IAFStatusManager
      • Application interface
      • Returning information from the getStatus method
      • Connections and other custom properties
      •  Asynchronously notifying IAFStatusManager of connection changes
        • Mapping AdapterConnectionClosed and AdapterConnectionOpened events
      •  StatusSupport
        • StatusSupport events
      • DataView support
    •  Out of Band Connection Notifications
      • Mapping example
      • Ordering of out of band notifications
    • The Event Payload
  •  Standard IAF Plug-ins
    •  The Database Connector IAF Adapter (ADBC)
      • Overview of using ADBC
      • Registering your ODBC database DSN on Windows
      • Adding an ADBC adapter to an Apama project
      •  Configuring the Apama database connector
        •  Configuring an ADBC adapter
          • Manually editing a configuration file
          • Configuring ADBC localization
          • Configuring ADBC Automatic Database Close
        • Service monitors
        • Codecs
      •  The ADBCHelper application programming interface
        • ADBCHelper API overview
        • Opening databases
        • Specifying the adapter instance
        • Checking to see if a database is open
        • Issuing and stopping SQL queries
        • Issuing SQL commands
        • Committing database changes
        • Performing rollback operations
        • Handling query results for row data
        • Handling query results for event data
        • Handling acknowledgments
        • Handling errors
        • Reconnection settings
        • Closing databases
        • Getting schema information
        • Setting context
        • Logging
      •  The ADBC Event application programming interface
        • Discovering data sources
        • Discovering databases
        • Opening a database
        • Closing a database
        • Storing event data
        • Storing non-event data
        • Creating and deleting store events
        • Handling data storing errors
        • Committing transactions
        • Rolling back transactions
        • Running commands
        •  Executing queries
          • Executing standard queries
          • Stopping queries
          • Preserving column name case
        •  Prepared statements
          • Using a prepared statement
        •  Stored procedures
          • Using a stored procedure
        •  Named queries
          • Using named queries
          • Creating named queries
      •  The Visual Event Mapper
        • Using the Visual Event Mapper
      • Playback
      • Format of events in .sim files
    •  The File IAF Adapter (JMultiFileTransport)
      • File adapter plug-ins
      • File adapter service monitor files
      • Adding the File adapter to an Apama project
      • Configuring the File adapter
      • Overview of event protocol for communication with the File adapter
      •  Opening files for reading
        • Opening files for reading with parallel processing applications
      • Specifying file names in OpenFileForReading events
      • Opening comma separated values (CSV) files
      • Opening fixed width files
      • Sending the read request
      • Requesting data from the file
      • Receiving data
      •  Opening files for writing
        • Opening files for writing with parallel processing applications
      • LineWritten event
      • Monitoring the File adapter
    • The Basic File IAF Adapter (FileTransport/JFileTransport)
    •  Codec IAF Plug-ins
      • The String codec IAF plug-in
      •  The Null codec IAF plug-in
        • Null codec transport-related properties
      •  The Filter codec IAF plug-in
        • Filter codec transport-related properties
        • Specifying filters for the Filter codec
        • Examples of filter specifications
      •  The XML codec IAF plug-in
        • Supported XML features
        • Adding XML codec to adapter configuration
        • Setting up the classpath
        • About the XML parser
        •  Specifying XML codec properties
          • Required XML codec properties
          • XML codec transport-related properties
          • Message logging properties
          • Downstream node order suffix properties
          • Additional downstream properties
          • Sequence field properties
          • Upstream properties
          • Performance properties
        • Description of event fields that represent normalized XML
        • Examples of conversions
        • Sequence field example
        • XPath examples
      •  The CSV codec IAF plug-in
        • Multiple configurations and the CSV codec
        • Decoding CSV data from the sink to send to the correlator
        • Encoding CSV data from the correlator for the sink
      •  The Fixed Width codec IAF plug-in
        • Multiple configurations and the Fixed Width codec
        • Decoding fixed width data from the sink to send to the correlator
        • Encoding fixed width data from the correlator for the sink
  •  Developing Custom Clients
    •  The Client Software Development Kits
      • The client libraries
      • Working with event objects
      • Logging
      • Exception handling and thread safety
    • Engine Management API
    • Engine Client API
    • Event Service API
    • Scenario Service API
•  Building and Using Apama Dashboards
  • Overview
  •  Building Dashboard Clients
    •  Introduction to Building Dashboard Clients
      • Web client requirements
      • About dashboards
      •  Starting the Dashboard Builder
        • Starting Builder from the Windows Start menu
        •  Starting Builder from Software AG Designer
          • Specifying Dashboard Builder options
        • Starting Builder from the command line
      • Scenario instance ownership
    •  Using Dashboard Builder
      •  Dashboard Builder layout
        • The menubar
        • The toolbar
        • The canvas
        • The Object Palette
        • The Object Properties panel
      •  Specifying data sources
        • Specifying correlators
        • Specifying XML data sources
        • Activating data source specifications
        • Saving data source specifications
      • Setting the background properties
      •  About resize modes
        • About resize modes and display server deployments
        • About resize modes and composite objects
      •  Working with objects
        • Adding objects to a dashboard
        • Selecting an object
        • Resizing objects
        • Moving objects
        • Copy and pasting objects
        • Deleting objects
      • Setting Builder options
      •  Setting dashboard options
        •  Setting options in the General tab group
          • Setting options in the General tab
          • Setting options in the Substitutions tab
          • Setting options in the data server tab
          • Setting options in the Custom Colors tab
        • Setting options in the Apama tab group
        • Setting options in the SQL tab group
        • Setting options in the XML tab group
        • Saving options
      • Command-line options for the Dashboard Builder
      • Restrictions
    •  Attaching Dashboards to Correlator Data
      •  Dashboard data tables
        • Query instance table
        • Correlator status table
        • Data server status table
        • DataView item table
        • DataView trend table
        • DataView OHLC table
        • SQL-based instance table
        • Definition Extra Params table
        • Setting data options
      • Scenario instance ownership
      •  Creating a data attachment
        • Using the Attach to Apama dialog
        • Selecting display variables or fields
        • Displaying attached data
        • Filtering data
        • Attaching to constraint data
        • About timestamps
        •  Using dashboard variables in attachments
          • About non-substitution variables
        • About drilldown and $instanceId
        • About other predefined substitution variables
        • Using SQL-based instance tables
        •  Working with multiple data servers
          • Builder with multiple data servers
          • Viewer with multiple data servers
          • Display server deployments with multiple data servers
      •  Using table objects
        • Creating an instance summary table
        • Filtering rows of an instance summary table
        • Performing drilldowns on tables
        • Specifying drill-down column substitutions
        • Hiding table columns
        • Using pre-set substitution variables for drill down
        • Formatting table data
        • Colorizing table rows and cells
        • Setting column headers
        • Using rotated tables
      •  Using pie and bar charts
        • Creating a summary pie or bar chart
        • Using series and non-series bar charts
        • Performing drilldowns on pie and bar charts
      •  Using trend charts
        • Creating a trend chart
        • Charting multiple variables
        • Adding thresholds
        • Configuring trend-data caching
        • Rendering trend charts in HTML5
      •  Using stock charts
        • Using OHLC values
        • Creating a stock chart
        •  Adding overlays
          • Recreating the Stock Chart Overlay sample
        • Generating OHLC values
      • Localizing dashboard labels
      • Localizing dashboard messages
    •  Using Dashboard Functions
      • Using built-in functions
      •  Creating custom functions
        •  Developing a custom-function library
          • Implementing getFunctionDescriptors
          • Implementing evaluateFunction
        • Installing a custom-function library
    •  Defining Dashboard Commands
      • Defining commands
      • Using dashboard variables in commands
      • Defining commands for creating an instance
      • Defining commands for editing an instance
      • Supporting deletion of an instance
      • Supporting deletion of all instances
      • Defining commands for creating a query instance
      • Defining commands for editing a query instance
      • Supporting deletion of a query instance
      • Supporting deletion of all instances of a query
      • Using popup dialogs for commands
      • Command options
      • Associating a command with keystrokes
      • Defining multiple commands
      •  Creating custom commands
        • Developing a custom-command library
        • Installing a Custom-Command Library
      • Apama set substitution command
    •  Reusing Dashboard Components
      •  Using Object Grids
        • Configuring Object Grids
        • Recreating the Object Grid sample
      •  Using Composite objects
        • Creating files to display in composite objects
        • Configuring Composite objects
        • Using substitutions with Composite objects
        • Composite object interactivity
        •  Composite object sample
          • Recreating the Composite object sample
      •  Using Composite Grids
        • Configuring Composite Grids
        •  Composite Grid sample
          • Recreating the Composite Grid sample
      •  Using include files
        •  Include File sample
          • Recreating the Include File sample
      •  Working with multiple display panels
        • About the format of the panels-configuration file
        •  Using new tags to configure the panels in a window
          • Configuring panels with accordion controls
          • Configuring static tree navigation panels
          • Configuring tabbed navigation panels
          • Using tab definition files
          • Examples of configuration files for multiple panels
        •  Using tree controls in panel displays
          • Creating tree controls
          • Configuring tree control icons
          • Specifying tree control properties
          • Tree control limitations
        •  Using old tags to configure the panels in a window
          • Using border panels
          • Using card panels
          • Using grid panels
          • Using tabs panels
          • Using tree panels
          • Using the RTViewNavTreePanel tag
          • Using the RTViewPanel tag
        • Tab Control object
    •  Sending Events to Correlators
      •  Using the Define Apama Command dialog
        • Other dialog fields
        • Updating event definitions in Builder
        • Example
      • Send event authorization
    •  Using XML Data
      •  XML data format
        • Scalar data elements
        • Tabular data elements
      • Defining an XML data source
      • Attaching objects to XML data
    •  Using SQL Data
      • SQL system requirements and setup
      •  Attaching visualization objects to SQL data
        • Validation colors
        • Substitutions
        • Select table columns
      •  Defining SQL commands
        • Validation colors
        • Special values
      •  Specifying application options
        • SQL tab
        • Adding a Database
        • Database repository
        •  Entering database information directory into OPTIONS.ini
          • Generating encrypted passwords for SQL data sources
      •  Setting up SQL database connections
        • Direct JDBC connection
      • Setting SQL data source options
  •  Dashboard Property Reference for Graphs, Tables and Trends
    •  Introduction to Dashboard Properties
      • Objects for complex-data visualization
      • About the Object Properties window
      • Editing property values
      • Copying and pasting property values
    •  Graph Objects
      •  Bar graphs
        • Bar graph: Alert group
        • Bar graph: Background group
        • Bar graph: Bar group
        • Bar graph: Column group
        • Bar graph: Data group
        • Bar graph: Data Format group
        • Bar graph: Data Label group
        • Bar graph: Historian group
        • Bar graph: Interaction group
        • Bar graph: Label group
        • Bar graph: Layout group
        • Bar graph: Legend group
        • Bar graph: Marker group
        • Bar graph: Object group
        • Bar graph: Plot Area group
        • Bar graph: Trace group
        • Bar graph: X-Axis group
        • Bar graph: Y-Axis group
      •  Google map
        • Map graph: Data group
        • Map graph: Interaction group
        • Map graph: Map group
        • Map graph: Object group
        • Licensing
      •  Heat map
        • Heat maps with one index column
        • Heat maps with multiple index columns
        • Mapping from possible aggregation results to colors
        • Drill down displays
        • Object class name
        • Heat map property groups
        • Heat map: Background properties
        • Heat map: Data group
        • Heat map: Data format group
        • Heat map: Data Label group
        • Heat map: Historian group
        • Heat map: Interaction group
        • Heat map: Label group
        • Heat map: Layout group
        • Heat map: Node group
        • Heat map: Object group
        • Heat map: Quality group
      •  HTML5 Bar graph
        • HTML5 bar graph behavior
        • HTML5 bar graph issues
        • HTML5 bar graph properties
      •  Legend
        • Legend: Background group
        • Legend: Data group
        • Legend: Historian group
        • Legend: Interaction group
        • Legend: Label group
        • Legend: Legend group
        • Legend: Object group
      •  Pie graph
        • Pie graph: Background group
        • Pie graph: Column group
        • Pie graph: Data group
        • Pie graph: Data Format group
        • Pie graph: Data Label group
        • Pie graph: Historian group
        • Pie graph: Interaction group
        • Pie graph: Label group
        • Pie graph: Legend group
        • Pie graph: Object group
        • Pie graph: Wedge group
      •  HTML5 Pie graph
        • HTML5 pie graph behavior
        • HTML5 pie graph properties
      •  Radar graph
        • Radar graph: Alert group
        • Radar graph: Background group
        • Radar graph: Column group
        • Radar graph: Data group
        • Radar graph: Data Format group
        • Radar graph: Data Label group
        • Radar graph: Historian group
        • Radar graph: Interaction group
        • Radar graph: Label group
        • Radar graph: Legend group
        • Radar graph: Marker group
        • Radar graph: Object group
        • Radar graph: Plot Area group
        • Radar graph: Radial Axis group
        • Radar graph: Trace group
        • Radar graph: Value Axis group
      •  XY graph
        • XY graph: Alert group
        • XY graph: Background group
        • XY graph: Column group
        • XY graph: Data group
        • XY graph: Data Format group
        • XY graph: Data Label group
        • XY graph: Historian group
        • XY graph: Interaction group
        • XY graph: Label group
        • XY graph: Legend group
        • XY graph: Marker group
        • XY graph: Object group
        • XY graph: Plot Area group
        • XY graph: Trace group
        • XY graph: X-Axis group
        • XY graph: Y-Axis group
    •  Table Objects
      •  Standard tables
        • Standard table: Alert group
        • Standard table: Background group
        • Standard table: Cell group
        • Standard table: Column group
        • Standard table: Column Header group
        • Standard table: Data group
        • Standard table: Data Label group
        • Standard table: Grid group
        • Standard table: Historian group
        • Standard table: Interaction group
        • Standard table: Label group
        • Standard table: Object group
        • Standard table: Row Header group
        • Standard table: Sort group
      •  Rotated tables
        • Rotated table: Background group
        • Rotated table: Cell group
        • Rotated table: Column group
        • Rotated table: Data group
        • Rotated table: Grid group
        • Rotated table: Historian group
        • Rotated table: Interaction group
        • Rotated table: Label group
        • Rotated table: Object group
      • HTML5 tables
    •  Trend Objects
      •  Sparkline charts
        • Sparkline chart: Alert group
        • Sparkline chart: Background group
        • Sparkline chart: Data group
        • Sparkline chart: Data Format group
        • Sparkline chart: Historian group
        • Sparkline chart: Interaction group
        • Sparkline chart: Label group
        • Sparkline chart: Legend group
        • Sparkline chart: Marker group
        • Sparkline chart: Object group
        • Sparkline chart: Plot Area group
        • Sparkline chart: Trace group
        • Sparkline chart: X-Axis group
        • Sparkline chart: Y-Axis group
      •  Stock charts
        • Stock chart: Background group
        • Stock chart: Data group
        • Stock chart: Data Format group
        • Stock chart: Interaction group
        • Stock chart: Historian group
        • Stock chart: Label group
        • Stock chart: Legend group
        • Stock chart: Object group
        • Stock chart: Plot Area group
        • Stock chart: Price Trace group
        • Stock chart: Trace group
        • Stock chart: TraceN group
        • Stock chart: X-Axis group
        • Stock chart: Y-Axis group
      •  Trend graphs
        • Trend graph: Alert group
        • Trend graph: Background group
        • Trend graph: Data group
        • Trend graph: Data Format group
        • Trend graph: Interaction group
        • Trend graph: Label group
        • Trend graph: Legend group
        • Trend graph: Marker group
        • Trend graph: Object group
        • Trend graph: Plot Area group
        • Trend graph: Trace group
        • Trend graph: TraceN group
        • Trend graph: Trace Groups group
        • Trend graph: X-Axis group
        • Trend graph: Y-Axis group
    •  Drill-Down Specification
      • Using the Drill Down Properties dialog
      • Activating drill downs
      • About drilldown displays opened in Dashboard Builder
  •  Dashboard Function Reference
    •  Introduction to Dashboard Functions
      • Working with functions
    •  Scalar Functions
      • Add
      • Average
      • Boolean Expression
      • Concatenate
      • Correlator Time Format
      • Date Add
      • Date Ceiling
      • Date Compare
      • Date Difference
      • Date Floor
      • Date Format
      • Date Now
      • Delta
      • Divide
      • Duration
      • Evaluate Expression As Double
      • Evaluate Expression As String
      • Format Number
      • Get Substitution
      • Init Local Variable
      • isWindowsOS
      • Max
      • Min
      • Modulo
      • Multiply
      • Percent
      • Quick Set Sub
      • Replace All
      • Replace Value
      • Set Substitution
      • Set Substitutions By Lookup
      • Subtract
      • Validate Substitutions
    •  Tabular Functions
      • Add All Rows Or Columns
      • Add Columns
      • Average All Rows Or Columns
      • Average Columns
      • Baseline Over Time
      • Buffer Table Rows
      • Combine
      • Concatenate Columns
      • Convert Columns
      • Copy
      • Count
      • Count By Bands
      • Count Unique Values
      • Count Unique Values By Time
      • Create Selector List
      • Delta And Rate Rows
      • Delta Rows
      • Distinct Values
      • Divide Columns
      • Ensure Columns
      • Ensure Timestamp Column
      • Evaluate Expression By Row
      • Filter And Extract Matches
      • Filter By Pattern
      • Filter By Row
      • Filter By Time Range
      • First Table Rows
      • Format Table Columns
      • Get data server connection status
      • Group By Time
      • Group By Time and Unique Values
      • Group by Unique Values
      • Join
      • Join Outer
      • Last Table Rows
      • Mark Time Gaps
      • Max All Rows or Columns
      • Max Columns
      • Min All Rows or Columns
      • Min Columns
      • Modulo Columns
      • Multiply Columns
      • Percent Columns
      • Pivot On Unique Values
      • Reference
      • Rename Columns
      • Select Column
      • Set Column Type
      • Sort Table
      • Split String
      • String to Table
      • Subtotal By Time
      • Subtotal By Unique Values
      • Subtract Columns
      • Table Contains Values
    •  Expression Syntax in Dashboard Functions
      • Operators in dashboard function expressions
      • Arithmetic functions in dashboard function expressions
      • String functions in dashboard function expressions
  •  Dashboard Deployment
    •  Dashboard Deployment Concepts
      •  Deployment options
        • Application installation
        • Authentication
        • Authorization
        • Data protection
        • Refresh latency
        • Scalability
      • Data server and display server
      • Process architecture
      • Builders and administrators
    •  Generating Dashboards
      • Starting the wizard
      • Using the wizard
      • Using the titlebar/toolbar
      • Using the Introduction form
      • Using the Main, Create, Edit, and Details Forms
      • Using the layout configuration forms
    •  Preparing Dashboards for Deployment
      • Dashboard feature checklist
      • Changing correlator definitions for deployment
      •  Choosing among deployment types
        • Application installation
        • Authentication
        • Authorization
        • Data protection
        • Scalability
        •  Choosing among web-based deployment types
          • Served data
          • Refresh latency
      •  Using the Deployment Configuration editor
        • Starting the Configuration editor
        • Rename Deploy Configuration
        • Saving deployment configurations
        • Title bar/Toolbar
        • General Settings
        • Startup and Server
        • Additional JAR Files
        • Using the Dashboard Package wizard
      • Generating a deployment package from the command line
      • Sharing information with the Dashboard Administrator
    •  Deploying Dashboards
      • Generating the dashboard .war file
      • Installing a dashboard .war file
      • Inside a dashboard .war file
      • Additional steps for display server deployments
    •  Managing the dashboard data server and display server
      • Prerequisites
      • Starting and stopping the data server or display server
      • Command-line options for the data server and display server
      • Rotating the log files of the data server and display server
      • Controlling the update frequency
      • Configuring Trend-Data Caching
      • Managing Connect and Disconnect Notification
      •  Working with multiple data servers
        • Builder with multiple data servers
        • Viewer with multiple data servers
        • Display server deployments with multiple data servers
      • Managing and stopping the data server and display server
    •  Administering Dashboard Security
      • Administering authentication
      •  Authentication for local and application server deployments
        • Dashboard Login Modules Provided by Apama
        • Developing custom login modules
        • Installing login modules
        • Installing UserFileLoginModule
        • Installing LdapLoginModule
      •  Administering authorization
        • Users and roles
        • Predefined roles
        • Default DataView access control
        • Customizing DataView access control
        •  Providing a Scenario Authority
          • Developing a custom Scenario Authority
          • Implementing IScenarioAuthority methods
          • Installing a Scenario Authority
        •  Send event authorization
          • Using UserCredential accessor methods
          • Compiling your Event Authority
          • Installing your Event Authority
        • Providing a login module that supports an Event Authority
      • Securing communications
  •  Using the Dashboard Viewer
    •  Concepts Underlying Dashboards
      • About Dashboards
      • Starting the Dashboard Viewer
      • DataView item ownership
    •  Using the Dashboard Viewer
      •  Opening and viewing dashboards
        • Running the Statistical Arbitrage demo
        • Displaying additional dashboards
        • Creating instances visualized by the Statistical Arbitrage main dashboard
      • The Dashboard Viewer menu bar
      • Resizing the Dashboard Viewer
      •  Working with Dashboard Objects
        • Trend charts
        • Stock charts
        • Tables
        • Pie and Bar charts
    • Startup Options for the Dashboard Viewer
    • Time Zone ID Values
•  Deploying and Managing Apama Applications
  • Overview
  • Security Requirements for Apama
  •  Overview of Deploying Apama Applications
    • About deploying components with Command Central
    • About deploying Apama applications with an Ant script
    • About deploying Apama applications with Docker
    • About deploying Apama applications with Kubernetes
    • About Apama command line utilities
    • About deploying dashboards
    • About tuning applications for performance
    • Setting up the environment using the Apama Command Prompt
  •  Deploying Apama Components with Command Central
    • Overview of deploying components with Command Central
    •  Getting started with Command Central
      • Using the Command Central web interface
      • Using the Command Central command line interface
    •  Administering Apama in Command Central
      • Creating and deleting instances using the Command Central web user interface
      • Configuring instances using the Command Central web user interface
      • Creating and deleting instances using the Command Central command line interface
      • Configuring Apama components to use custom C++ plug-ins
      • Commands that Apama components support
      •  Configuration types that Apama components support
        •  Configuration types that the Apama correlator supports
          • The correlator persistence properties
          • The correlator license key
        •  Configuration types that Apama IAF supports
          • The IAF configuration file
        •  Configuration types that the Apama display server and Apama data server support
          • Server modes
          • Additional .jar files
          • Memory configuration
          • Component endpoint configuration
        •  Usage notes
          • Extra arguments
          • Component logging
          • Component ports
          • Apama environment variables
          • Correlator connections
          • Overriding correlator configuration
      • Configuring Digital Event Services for a correlator instance
      • Retrieving configuration data for Apama component instances
      • Lifecycle actions for Apama component instances
    •  Monitoring Apama from Command Central
      • Monitoring the KPIs for the correlator
      • Monitoring the KPIs for EPL applications and connectivity plug-ins
      • Monitoring the KPIs for the IAF
      • Monitoring the KPIs for the dashboard servers
      • Viewing log files
    • Deploying a Designer project to Command Central
  •  Deploying and Managing Queries
    • Overview of deploying and managing query applications
    • Query application architecture
    • Deploying query applications
    •  Running queries on correlator clusters
      • Deploying queries on multiple correlators
      • Deploying a Terracotta Server Array (TSA)
      • Configuring the TCStore driver
      • Configuring the BigMemory Max driver
      • Using JMS to deliver events to queries running on a cluster
      • Mixing queries with monitors
      • Handling node failure and failover
    •  Managing parameterized query instances
      • Creating new query instances by setting parameter values
      • Changing parameter values for queries that are running
    • Monitoring running queries
  •  Deploying Apama Applications with Docker
    • Introduction to Apama in Docker
    • Published Apama container images
    • Licensing Apama in Docker
    • Quick start to using an Apama image
    • Building an Apama image from the current installation
    • Deploying an Apama application in Docker
    • Developing an Apama application using the Docker image
    • Building Apama projects during the Docker build
    • Using Docker Compose with Apama
    • Apama samples for Docker
    • Using the Apama image with the Docker stack
  •  Deploying Apama Applications with Kubernetes
    • Introduction to Apama in Kubernetes
    • Quick start to using Apama in Kubernetes
    • Deploying an Apama application using Kubernetes
    • Apama samples for Kubernetes
  •  Tuning Correlator Performance
    • Scaling up Apama
    • Partitioning strategies
    • Engine topologies
    •  Correlator pipelining
      • Configuring pipelining with engine_connect
      • Connection configuration file
      • Configuring pipelining through the client API
      • Event partitioning
    • Using jemalloc to optimize memory usage
  • Restricting Correlator Resource Usage with Control Groups
  • Managing and Monitoring over REST
  • Monitoring with Prometheus
  •  Correlator Utilities Reference
    •  Starting the correlator
      • Specifying log filenames
      • Examples for specifying log filenames
      • Descriptions of correlator status log fields
      • Text internationalization in the logs
      •  Determining whether to disconnect slow receivers
        • Description of slow receivers
        • How frequently slow receivers occur
        • Correlator behavior when there is a slow receiver
        • Tradeoffs for disconnecting a slow receiver
      • Determining whether to disable the correlator's internal clock
      • Injection time of compiled runtime
    •  Configuring the correlator
      • Using YAML configuration files
      • YAML configuration file for the correlator
      • Including YAML configuration files inside another YAML configuration file
      • Using properties files
      • Runtime parameterization of configuration
      • Specifying the correlator port number
      • Binding server components to particular addresses
      • Ensuring that client connections are from particular addresses
      • Setting environment variables for Apama components
      • Setting EPL log files and log levels in a YAML configuration file
      • Setting correlator and plug-in log files and log levels in a YAML configuration file
      • Configuring persistence in a YAML configuration file
      • Setting up connections between correlators in a YAML configuration file
      • Specifying JVM options
      • Deploying Apama applications with a YAML configuration file
    • Injecting code into a correlator
    • Creating and managing an Apama project from the command line
    • Deploying a correlator
    • Deleting code from a correlator
    • Packaging correlator input files
    • Sending events to correlators
    • Receiving events from correlators
    •  Watching correlator runtime status
      • List of correlator status statistics
    • Inspecting correlator state
    •  Shutting down and managing components
      • Viewing garbage collection and application events information
      • Using the EPL memory profiler
      • Using the CPU profiler
      • Setting EPL log files and log levels dynamically
      • Rotating correlator log files
      • Rotating all correlator log files
      • Rotating specified log files
    •  Using the command-line debugger
      • Obtaining online help for the command-line debugger
      • Enabling and disabling debugging in the correlator
      • Working with breakpoints using the command-line debugger
      •  Controlling execution with the command-line debugger
        • The wait command
      • Command shortcuts for the command-line debugger
      • Examining the stack with the command-line debugger
      • Displaying variables with the command-line debugger
    •  Generating code coverage information about EPL files
      • Recording code coverage information
      • Creating code coverage reports
      • Interpreting the code coverage reports
      • Using EPL code coverage with PySys tests
    •  Replaying an input log to diagnose problems
      • Creating an input log file
      • Rotating an input log file
      • Performance when generating an input log
      • Reproducing correlator behavior from an input log
    •  Event file format
      • Event representation
      • Event timing
      • Event types
      • Event association with a channel
    • Using the Data Player command-line interface
• API Reference for EPL (ApamaDoc)
• API Reference for Java (Javadoc)
• API Reference for C++ (Doxygen)
• API Reference for .NET
• API Reference for Python
• API Reference for Component Management REST APIs
• Copyright

About this Documentation

Copyright

WORKBENCH_PROJECT_VIEW

ApamaPerspective

ResourcesView

OutlineView

ENGINE_STATUS_VIEW

ENGINE_INSPECT_VIEW

WIZARD_NEW_APAMA_PROJECT

WIZARD_NEW_MONITORSCRIPT

WIZARD_NEW_EVENT_DEFINITION

WIZARD_EVENT_GEN_FROM_XML

WIZARD_EVENT_GEN_FROM_XSD

WIZARD_NEW_APAMA_JAVA_CONFIG

WIZARD_NEW_APAMA_JAVA_MONITOR_PAGE

WIZARD_NEW_APAMA_JAVA_EVENT_PAGE

WIZARD_NEW_APAMA_JAVA_EPLPLUGIN_PAGE

DASHBOARD_NEW_CONFIG_WIZARD

WIZARD_NEW_EVENT_FILE

EVENT_BROWSER_DIALOG

APAMA_JAVA_CONFIG_EDITOR

APAMA_JAVA_CONFIG_ADD_CLASSES

APAMA_JAVA_CONFIG_ADD_EXTRA_CONTENT

SELECT_BUNDLE_INSTANCE_DIALOG

SELECT_ADAPTER_INSTANCE_DIALOG

APAMA_DIGITAL_EVENTS_EDITOR

EditorView

OPEN_TYPE_DIALOG

MonitorScriptSearch

MonitorScriptSearchView

ProjectSettings

BuildPathSource

BuildPathProjects

BuildPathExternalDependency

NewVariableDepend

BUNDLES_PROPERTIES_PAGE

WIZARD_EXPORT_EMM_INITIALIZATION_LIST

ANT_EXPORT_PAGE

CDP_WIZARD_PROJECT_SELECTION_PAGE

EPL_OBJECTS_BROWSE_VIEW

ADAPTER_CONFIGURATION_DIALOG

NEW_APAMA_QUERY_FILE_WIZARD

QUERY_DESIGNER_DESIGN_TAB

QUERY_AGGREGATES_NAMESPACE_DIALOG

QUERY_INPUT_DEFINITION_DIALOG

QUERY_EVENT_PALETTE

QUERY_PARAMETER_DIALOG

QUERY_CONDITIONS_WHERE_CLAUSE_DIALOG

QUERY_CONDITIONS_WITHIN_CLAUSE_DIALOG

QUERY_CONDITIONS_WITHOUT_CLAUSE_DIALOG

QUERY_AGGREGATES_SELECT_CLAUSE_DIALOG

QUERY_AGGREGATES_HAVING_CLAUSE_DIALOG

QUERY_ACTION_SEND_DIALOG

QUERY_ACTION_CUSTOM_EPL_DIALOG

QUERY_ACTION_ROUTE_DIALOG

QUERY_DESIGNER_SOURCE_TAB

RunMonitorScript

CorrelatorArguments

PERSISTENCE_CORRELATOR_CONFIGURATION_DIALOG_ARGUMENTS_TAB

CORRELATOR_CONFIGURATION_DIALOG_INITIALIZATION_TAB

CORRELATOR_CONFIGURATION_DIALOG_EVENT_TAB

ENGINE_CONNECT_CONFIGURATION_DIALOG

EXTERNAL_PROCESS_CONFIGURATION_DIALOG

Console

ENGINE_SEND_DIALOG

ENGINE_RECEIVE_VIEW

ENGINE_RECEIVE_OPTIONS_DIALOG

ENGINE_RECEIVE_CHANNEL_SELECTION_DIALOG

SCENARIO_BROWSER_PROJECT_VIEW

INSTANCE_SUMMARY

RemoteRunMonitorScript

debug_view_context

breakpoint_view_context

variable_view_context

ProfileMonitorScript

PROFILER_ConnectionDetailsTab

PROFILER_ProfileLaunchView_View

PROFILER_ExecutionStatisticsView_VIEW_NORMAL_TAB

PROFILER_CHOOSE_COLUMNS

PROFILER_CREATE_FILTER

PROFILER_MANAGE_FILTER

PROFILER_CREATE_SNAPSHOT

PROFILER_MANAGE_SNAPSHOT

DATAPLAYER_EDITOR

DATAPLAYER_VIEW

DATAPLAYER_PREFERENCE_DIALOG

DATAPLAYER_DATE_TIME_CONTROL

DATAPLAYER_PROMPT_RESTART

PrefApamaInstall

CATALOGS_PREFERENCES_PAGE

PrefMonitorScript

PrefColors

PrefFormatting

PrefTemplates

PrefVariables

PROFILE_PREFERENCES_PAGE

PrefQuery

WORKBENCH_PREFERENCES_PAGE

tutorialMSmain

tutorialEventTypes

tutorialMonitors

tutorialSpawnMonitors

tutorialEventProcessOrder

QUERY_METADATA_ENTRY_DIALOG

tutorialComplexEvents

tutorialStreams

tutorialStreamsCrossJoin

tutorialRouteEvents

tutorialEmitEvents

tutorialConditionalLogic

tutorialMultipleMonitors

tutorialDictionary

tutorialPersistData

AddNewDistMemStore

DistMemStoreAdapterEditor

tutorialDataViews

WIZARD_EXPORT_APAMADOC

tutorialJavamain

tutorialJavaEventTypes

tutorialJavaMonitors

tutorialJavaMonitorTemplates

tutorialJavaComplexEvents

tutorialJavaRouteEvents

JMSResiliencyAdapterEditor

JMS_CONFIG_WIZARD

CONDITIONAL_EXPRESSION_DIALOG

ADD_CLASSPATH_VARIABLE_DIALOG

SourceTargetDialog

JMS_BODY_INPUT_TREAT_AS_DIALOG

JMS_BODY_OUTPUT_TREAT_AS_DIALOG

TYPE_CHOOSER_DIALOG

XPathDialog

VariableDialog

ADD_COMPUTED_NODE_DIALOG

CONNECTION_PROPERTIES_DIALOG

ADBCAdapterEditor

EVENT_PERSISTENCE_SELECTION_DIALOG

GenericAdapterEditor

dashboard_builder_context

tutorialDashboard

DashboardBuilderOptions

DASHBOARD_GENERATION_EDITOR

DASHBOARD_GENERATION_MAINPAGE

DASHBOARD_GENERATION_LAYOUT_CONFIGURATION_FORMS

DASHBOARD_DEPLOY_CONFIG_EDITOR

DASHBOARD_NEW_DEPLOY_CONFIG_WIZARD

DASHBOARD_DEPLOY_RENAME_CONFIG_DIALOG

DASHBOARD_DEPLOY_ADD_JAR_FILES_DIALOG

DASHBOARD_PACKAGING_WIZARD_PAGE

dashboard_viewer_context

cce.apama.about.administering.apama

cce.configuring.instances

cce.apama.creating.deleting.apama.component.instance

cce.apama.configuring.apama.component.instance

cce.apama.starting.stopping.apama.component.instance

cce.apama.viewing.log.files