Complex Event Processor - Buckets

Deployed Buckets

Figure 1: Deployed Buckets

Complex Event Processor's deployed buckets page shows you a table of all the deployed buckets in the server. You can have four operations on available buckets in this page.The three basic features provided in this page are; "Removing Bucket", "Viewing a bucket", "Edit Bucket" and "Search Bucket". You can delete multiple buckets at once by checking the check box against each bucket and clicking on delete button.

Add Bucket

Figure 5: Add Bucket

Once you click on the 'Add' menu item under 'CEP Buckets' Sub menu in left panel, you will be directed to Add Bucket page. Adding bucket to the server can be done in three states.

  • Adding Basic Information
  • Here you can provide the name of the bucket , Description for the bucket (Optional), choose the Engine provider that you are going to use for the bucket and provide Backend Runtime Configurations. Once you click on 'Save', this information will be saved in the server and you can add inputs and queries to the bucket by editing the bucket.

  • Adding Basic Information and Inputs
  • Other than the above basic information, you can add inputs to the bucket and save the bucket.

  • Adding Basic Information, Inputs and Queries
  • In this state you are adding all the required information for the bucket.

    You can find more information about the bucket in the User guide of CEP.

    Add Input

    Complex Event Processor is triggered by events. When some event source publish event or stream of events, there should be a topic to publish the events to be received by the CEP Server. By defining inputs, we are defining a topic to which an event source can publish to. Input consists of five main elements

    Figure 6: Add Input

  • Topic
  • Topic which an event source should publish events to be received by the CEP Server

  • Broker Name
  • Name of the broker in which, events are used to send through. You need to create a broker if any thing is not listed in this drop down. To create a broker , Click on 'Add' menu item under Broker sub menu which exists under 'Configure' menu in left panel

  • Stream
  • Name of the stream of the events

  • Query Event Type
  • Input event type. This can be chosen from the drop-down menu.

  • Input Mapping Type
  • Mapping type for the input stream. This can be chosen from the drop-down menu. There are three options available. XML Mapping, Tuple Mapping and Map Mapping.In XML mapping user have to provide XPath prefixes and properties. In tuple mapping user have to provide properties of tuple data. Also in map mapping user have to define properties of the input stream

    Once you provide the above information and click on 'Add Input' button, it will listed in the inputs table and you will be able to see details of the topic once you click on the input name listed in the table. If you have added wrong values you can simply delete the input from the table by selecting the check bix provided for the particular input and click on delete button.

    NOTE : Inputs will not be save to the server until you click on the 'Save' button for the bucket.

    Add Query

    Filtering and triggering new events on received events is the basic idea of the CEP Server. To filter events there should be some criteria specified in the CEP Engine. This criteria which is needed to filter events is provided with the query of the CEP Bucket. There can be one or more queries and user can decide the number of queries required to perform the expected task.

    Figure 7: Add Query

    Query consists of three elements.

  • Query Name
  • Name of the query which is used to identify

  • Expression
  • Actual CEP query.

  • Output
  • When an event is triggered or filtered from the input events, that event need to be publish to a topic to be received by another event listener. In configuring output we are providing the topic which the new event to be published and the format of the output event.

    Figure 8: Add Output

    User has to provide three things when defining an output

  • Topic
  • Topic which a filtered event should be published. Any one interested in receiving filtered events need to be subscribed to this topic

  • Broker name
  • Name of the broker in which, events are used to send through. You need to create a broker if anything is not listed in this drop down. To create a broker, Click on 'Add' menu item under Broker sub menu which exists under 'Configure' menu in left panel

  • Output Mapping
  • Scheme which, events will be mapped before firing the output. There are three choices to select from depending on user requirement.

  • XML Mapping
  • User can provide the full output xml element to be fired. When there are required fields to be filled with filtered values, names of those values should be provided within curly brackets and CEP Server will identify them and replace with the filtered values

  • Text Mapping
  • User can provide the full output text message to be fired. When there are required fields to be filled with filtered values, names of those values should be provided within curly brackets and CEP Server will identify them and replace with the filtered values

  • Tuple Mapping
  • User can define the full tuple element to be fired including meta, correlation and payload data.

  • Map Mapping
  • User can define name value pairs to be fired.

    Note: After filling all the required fields of the Query , click on add query button to add Query to the bucket. Once you clicked it will disappear the query form and added query will be appeared in Queries table.

    Note: As the last step of adding a bucket , click on save button. Once you clicked it will redirect to the deployed buckets page and deployed bucket will be appeared in buckets table. Further to check whether you have entered the details correctly you can click on the link with the defined bucket and it will show added details. You can come back to the previous adding bucket page by clicking on the back button provided or if needed to edit the bucket you can click on the "Edit" link on the top of the View bucket Page.