Eventing Sample

Eventing is used to send notifications when a particular action is completed, such as when an operation with particular arguments is invoked or when a specific response is returned. Notifications are enabled in WSO2 DSS using input and output event triggers.

About the sample data service

The EventingSample data service used here is based on the functionality of managing the inventory of a car/motorcycle dealership. It contains the following queries:

• addProduct: A new product is added to the catalog using the addProductQuery query.
• updateProductQuantity: The availability of a certain product is updated using the updateProductQuantityQuery query. This is linked with an input event trigger, which monitors whether the stock of this product is critically low. If so, if fires an event notifying the subscribers that this product's stock needs to be updated.
• getProductByCode: When the product code is given, the getProductByCodeQuery query retrieves product information. The company gives special attention to people querying the database for motocycles. So when a query is made where the product type is "motorcycle", an output trigger associated with this query sends messages to the respective subscribers, which is our email address in this sample. 

Pre-requisites

1. In the sample, we define a specific topic for events to be published, and an email address is added as a subscription for that topic. In order to allow mails to be sent, we have to configure the mail sender in the client Axis2 configuration. A sample axis2.xml file for the client configuration is stored in <DSS_HOME>/samples/resources/sample_axis2_client.xml. Use it to replace the <DSS_HOME>/repository/conf/axis2/axis2_client.xml file. The axis2_client.xml file contains an already configured mail sender section and is ready to be used.
2. Edit the data service by adding a valid email address: Here we use the XML Edit option to edit the dataservice. In the XML view, replace all occurences of "test@test.com" with your own email address and restart the server.

Building the sample

The .dbs file of this sample data service should be manually deployed in your server as explained below. 

1. Log in to the management console and select Upload under Data Service menu.
2. Select the EventingSample.dbs file from the <DSS_HOME>/samples/dbs/rdbms/ folder and click Upload. 
3. If the file is deployed successfully, the Deployed Services window appears with the new data service listed. Alternatively, copy the file to the <DSS_HOME>/repository/deployment/server/dataservices folder. It will be deployed instantly as hot deployment, which is enabled in Data Services Server by default.

See Creating Data Service using a Configuration File.

Running the Sample

The sample service can be run using the TryIt   tool, which is bundled with the WSO2 Data Services Server, or a code-generated java client sample as discussed in the Data Services Clients section.

Follow the steps below to demonstrate this functionality using the TryIt tool:

1. Log in to the management console of your server and click List under Services in the navigator. The EventingSample will be listed here.
2. Click Try this service to open the TryIt tool.
3. Select the relevant operation and click Send to execute the command as shown below.

1. • We will first add a new product into the inventory by executing the "addProduct" operation:
      
   • After adding the product, we will update the availability of it by changing the product quantity in stock. Execute the "updateProductQuantity" operation:
     Here we are setting the "quantityInStock" to 5. Because of the event trigger, when the stock is less than 10, an event is fired. Soon you will receive an event notification to your mail inbox. Figure below shows the contents of the email attachment.
      
     
   • Here we are querying the inventory system for a specific motorcycle model by executing the "getProductByCode" operation.
     By making a request with the motorcycle product line, we are triggering an event associated with it. An email will be sent regarding this query. The contents of the email is as follows: