This documentation is for WSO2 CEP 3.0.0. View the home page of the latest release.

Skip to end of metadata
Go to start of metadata

WSO2Event event formatter converts events coming from Siddhi in to wso2Event, according to the mapping configurations. Therefore, WSO2Event has three data types such as meta, correlation and payload. You can map the CEP back-end runtime event attributes to any one of the three data types by adding the mapping configuration under their type names.

You 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,
    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 WSO2Event 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.
      WSO2Event Mapping

      WSO2Event mapping, which you selected here, contains three types of data properties as meta data, correlation data and payload data. Each data property needs to have the following:

      • Name : The attribute name to which the event data is mapped when creating the output WSO2Event
      • Value Of : The attribute/property name from which the data element is mapped
      • Type : Type of the element that is mapped. This can be java.lang.String, java.lang.Integer, java.lang.Long, or java.lang.Double.
    • Stream Name/Version : Since, you have selected a WSO2Event type event adapter here, you need a stream to send events from CEP. Enter the stream name/version here.
  3. 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.
  4. 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.
  5. Alternatively, you can specify an event formatter configuration using an XML file and save it in <PRODUCT_HOME>/repository/deployment/server/eventformatters 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 WSO2Event mapping event formatter configurations. Event formatter implementation must start with <eventformatter> root element as in the example below.

    <eventFormatter name="StatisticsFormatter" xmlns="">
      <from streamName="statisticsStream" version="1.0.0"/>
      <mapping type="wso2event">
            <from name="ipAddress"/>
            <to name="ipAdd" type="string"/>
            <from name="user"/>
            <to name="username" type="string"/>
      <to eventAdaptorName="wso2EventSender" eventAdaptorType="wso2event">
        <property name="stream">statisticsOutStream</property>
        <property name="version">1.0.0</property>
  • No labels