Text Event Formatter

Text event mapping converts the events coming from Siddhi to text events according to mapping configurations. you can inject the CEP's back-end runtime event data to the output as text, by adding the appropriate back-end runtime event attribute names in double curly braces (e.g., {{price}}) to the output text template.

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 xml 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. Also, see Text mapping section below.
   • Topic : Since you selected ws-event-local type event adapter, you need a Topic to be used when subscribing the events by the receiver.
     

     Text mapping

     Here when you select the text mapping, you will see a textarea which let you to define the template of the output Text event. Here you can define the template in two manner, they are In-Line and registry based.

     In-Line

     By-default text mapping is enabled for In-Line, Users just need to add the template of the output Text event  as shown in number "5". 

     Please note any attribute name need to be mentioned in double curly braces. eg : {{symbol}}

     Registry Based 

     1. Create a plain text content file(resource) with the name "quotationTemplate" in the "governance" directory of registry, (You can create the resource in "config" directory also)

     

     2. Then select the resource that you created in registry. First click on the Pick from registry option , then you can see options (Configuration Registry and Governance Registry) to select the registry resource.

     

     3. Then click on Governance Registry link, since we have create the resource in governance directory, select the specific resource as shown below and click on OK button.

     

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 Text mapping event formatter configurations. Event formatter implementation must start with <eventformatter> root element as in the example below.

   <eventFormatter name="emailEventFormatter" xmlns="http://wso2.org/carbon/eventformatter">
     <from streamName="stockStream" version="1.0.0"/>
     <mapping type="text">
       <inline>Hi,You have received a quotation for Brand {{symbol}}at the price at {{price}}Thanks</inline>
     </mapping>
     <to eventAdaptorName="emailAdaptor" eventAdaptorType="email">
       <property name="email.address">wso2cep@demo.com</property>
       <property name="email.subject">Quotation Details</property>
     </to>
   </eventFormatter>