Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This will convert Map event formatter converts the events which coming from Siddhi in to Map Events events according to the output mapping configurations. Here, each output event is considered as a map object. 

Configuring through the Management Console UI

1. Log in to the CEP management console and select the Main menu in the left hand side of the screen. Then select the Add menu item under Event Formatter menu.

Image Removed

2. The Create a New Event Formatter window opens, using which you can configure new event formatters. Enter the following details in the form to create a Map based event formatter as shown in the screenshot below.

Image Removed

Here, there are several properties that need to be filled when creating a event formatter. User interface is divided in to 3 main components (From, Mapping and To) except the event formatter name to give more understanding to the user.

...

Y ou can configure through the management console as explained below or by manually adding an XML file as explained in step 5.

  1. Start the CEP, log in to its management console, select Event Formatters and click Add Event Formatter .
  2. Enter details in the form that appears and click the Add Event Formatter button at the end of the form. For example,Image Added
    The fields in the above configuration are as follows:

    • Event Formatter Name : Property to uniquely identify an event formatter configuration
    • Event Stream (marked as 1 in the screenshot) : Select an event stream (stream name with version) to listen for events.
    • Stream Attributes : Based on the event stream selected earlier,

...

    • this shows what

...

    • the attributes available in the stream are. This field is only for reference

...

    • .
    • Output Event

...

    • Adapter Name (marked as 2 in the screenshot) : Select the event adapter used to publish events from the CEP. This drop-down list shows the output event adapters already created.
    • Output Mapping Type (marked as 3 the screenshot) : Select map mapping type. This drop-down list is populated based on the event adapter selected earlier. It lists only the mapping types supported by a particular event adapter. Some event adapters support multiple types of mappings.
      Map Mapping

      Map event is simply

...

    • a map object,

...

    • a <key,value> pair.

...

    • Name

...

    • is used as a key in the event and the actual value is used as value attribute.

      • Name

...

      • : The attribute name to which the event data

...

      • is mapped when creating the output Map Event
      • Value Of

...

      • : The attribute/property name from which the data element

...

3. After adding details click the Add Event Formatter button. The Available Event Formatter page will open. To view event formatter configurations, click on the event formatter name. To delete event formatter, click the Delete button.

Image Removed

...

By Clicking the Edit button of the relevant event formatter, you will able to edit the event formatter configuration and redeploy it. When you click the Edit button, it will redirect to a xml based editor window which allow you to edit the event formatter configuration from UI without opening the configuration file in the file system.

Image Removed

Configuring through a xml File

...

      • is mapped
    • Stream Name/Version : Since you selected a JMS type event adapter here, you need a destination to send events to, from the CEP.
  1. After an event formatter is successfully created, you can change its configuration and redeploy it. To do this, click the Edit link associated with it.
  2. An XML based editor opens allowing you to edit the event builder configuration from the UI itself, without having to edit the file in the file system. Do your modifications and click Update.
  3. Alternatively,

    Anchor
    step5
    step5
    you can specify an event formatter configuration using an XML file and save it in <PRODUCT_HOME>/repository/deployment/server/eventformatters

...

  1. directory, which is the event formatter deployment directory. Since hot deployment is enabled, you can simply add/remove files to deploy/undeploy from the server.

    Create the XML file with the following Map mapping event formatter configurations

...

  1. . Event formatter implementation

...

  1. must start with

...

  1. <eventformatter> root element as in the example below.

    Code Block
    languagehtml/xml
    <eventFormatter name="StatisticsFormatter" xmlns="http://wso2.org/carbon/eventformatter">
      <from streamName="statisticsStream" version="1.0.0"/>
      <mapping type="map">
        <property>
          <from name="ipAddress"/>
          <to name="ipAddress"/>
        </property>
        <property>
          <from name="user"/>
          <to name="username"/>
        </property>
      </mapping>
      <to eventAdaptorName="jmsTransportAdaptor" eventAdaptorType="jms">
        <property name="transport.jms.Destination">statisticInfo</property>
      </to>
    </eventFormatter>

...

  1.