Configuring Notifications for Asset Life-Cycle Transitions

In WSO2 ES the assets created have a defined lifecycle and will transition through different lifecycle states. If a specific user role requires to be notified when an asset moves from one state to another, you could do so by configuring the notifications. In ES, this is disabled by default. The admin needs to provide the required configuration details to enable it.

The following sub-sections describe how to configure notifications for asset lifecycle transitions:

Configuring notifications for asset lifecycle transitions

Follow the instructions below:

1. Create an email account that will be specifically used for WSO2 ES asset lifecycle transition notification emails (e.g., no-reply@foo.com).

2. Navigate to the <ES_HOME>/repository/conf/axis2/axis2.xml file. 

   1. Uncomment the mailto transportSender section and configure the ES email account.

      <transportSender name="mailto" class="org.apache.axis2.transport.mail.MailTransportSender">
            <parameter name="mail.smtp.from">esmailsample@gmail.com</parameter>
            <parameter name="mail.smtp.user">esmailsample</parameter>
            <parameter name="mail.smtp.password">esMailTest</parameter>
            <parameter name="mail.smtp.host">smtp.gmail.com</parameter>
            <parameter name="mail.smtp.port">587</parameter>
            <parameter name="mail.smtp.starttls.enable">true</parameter>
            <parameter name="mail.smtp.auth">true</parameter>
      </transportSender>

      Use the email address, username and password of the mail account you have set up, as the values for {email-address}, {username}, {password} respectively.

      Example:

      <transportSender name="mailto" class="org.apache.axis2.transport.mail.MailTransportSender">
              <parameter name="mail.smtp.from">foo@gmail.com</parameter>
              <parameter name="mail.smtp.user">foo</parameter>
              <parameter name="mail.smtp.password">$foo1234</parameter>
              <parameter name="mail.smtp.host">smtp.gmail.com</parameter>
              <parameter name="mail.smtp.port">587</parameter>
              <parameter name="mail.smtp.starttls.enable">true</parameter>
              <parameter name="mail.smtp.auth">true</parameter>
      </transportSender>

   2. Replace  <phase name="MessageOut"/> in the OutFlow phaseOrder type with the following configurations:

      The default email being sent includes HTML tags, therefore to support the HTML content the following configuration is required.

      <phase name="MessageOut">           
           <handler name="EmailTransformHandler" class="org.wso2.carbon.store.notifications.handler.EmailTransformHandler"/>
      </phase>

After the above configurations are enabled the authors of the respective assets will receive notifications when the assets moves from one lifecycle state to another.