Platform Explorer / Nuxeo Platform 5.6

Extension point notifications

This extension point can be used to configure available notifications. A given notification has the form:

    <notification autoSubscribed="false"
        availableIn="Section, Workspace" channel="email"
        name="Publication" template="publishContent">
        <event name="sectionContentPublished"/>
        <event name="myContentPublished"/>
    </notification>

The name

is the identifier for this notification.

The channel

is always "email".

The autoSubscribed

flag can be true if this notification is aways taken into account, or false if you want to allow users to enable/disable this notification by themselves.

The template

refers to the body template, which can be configured through the "templates" extension point.

The availableIn

attribute specifies in which types of superspaces the notification is active, it can be a comma-separated lists of types, or "*" or "all" to make the notification active in any container.

To disable an existing notification:

    <notification enabled="false" name="Publication"/>

Contribution Descriptor

Existing Contributions

  • nuxeo-social-workspace-core-5.6.jar
    <extension point="notifications" target="org.nuxeo.ecm.platform.ec.notification.service.NotificationService">
    
        <notification autoSubscribed="true" availableIn="SocialWorkspace" channel="email" enabled="true" label="label.nuxeo.notifications.subscriptions.updated" name="Subscriptions updated" subject="New subscription" template="subscriptionsUpdated">
          <event name="subscriptionAssigned"/>
        </notification>
    
        <notification autoSubscribed="false" availableIn="SocialWorkspace" channel="email" enabled="true" label="label.nuxeo.notifications.modif" name="Modification" subject="${docTitle} has been modified by ${author}" template="modif">
          <event name="documentModified"/>
        </notification>
    
        <notification autoSubscribed="false" availableIn="SocialWorkspace" channel="email" enabled="true" label="label.nuxeo.notifications.create" name="Creation" subject="${docTitle} has been created by ${author}" template="modif">
          <event name="documentCreated"/>
        </notification>
    
        <notification autoSubscribed="false" availableIn="SocialWorkspace" channel="email" enabled="true" label="label.nuxeo.notifications.workflow" name="Workflow Change" subject="Workflow event" template="workflow">
          <event name="workflowNewProcessStarted"/>
          <event name="workflowProcessEnded"/>
          <event name="workflowProcessCanceled"/>
          <event name="workflowAbandoned"/>
          <event name="workflowTaskCompleted"/>
          <event name="workflowTaskRejected"/>
          <event name="workflowTaskAssigned"/>
        </notification>
    
        <notification autoSubscribed="false" availableIn="SocialWorkspace" channel="email" enabled="true" label="label.nuxeo.notifications.appReviewStarted" name="Approbation review started" subject="Review started for ${docTitle}" template="aprobationWorkflowStarted">
          <event name="workflowNewProcessStarted"/>
        </notification>
    
        <notification autoSubscribed="true" availableIn="SocialWorkspace" channel="email" enabled="true" label="label.nuxeo.notifications.appReviewStarted" name="Task assigned" subject="Task Assigned for ${docTitle}" template="workflowTaskAssigned">
          <event name="workflowTaskAssigned"/>
        </notification>
    
        <notification autoSubscribed="false" availableIn="SocialWorkspace" channel="email" enabled="true" label="notifications.name.Comments" name="CommentPublication" subject="Comment published" template="comment">
          <event name="commentPublished"/>
        </notification>
    
      </extension>
  • nuxeo-platform-comment-workflow-5.6.jar
    <extension point="notifications" target="org.nuxeo.ecm.platform.ec.notification.service.NotificationService">
    
        <notification autoSubscribed="false" availableIn="Workspace" channel="email" enabled="true" label="notifications.name.Comments" name="CommentPublication" subject="Comment published" template="comment">
          <event name="commentPublished"/>
        </notification>
        
      </extension>
  • nuxeo-platform-notification-core-5.6.jar
    <extension point="notifications" target="org.nuxeo.ecm.platform.ec.notification.service.NotificationService">
    
        <notification autoSubscribed="true" availableIn="Workspace" channel="email" enabled="true" label="label.nuxeo.notifications.subscriptions.updated" name="Subscriptions updated" subject="New subscription" template="subscriptionsUpdated">
          <event name="subscriptionAssigned"/>
        </notification>
    
        <notification autoSubscribed="false" availableIn="Workspace" channel="email" enabled="true" label="label.nuxeo.notifications.modif" name="Modification" subject="${docTitle} has been modified by ${author}" template="modif">
          <event name="documentModified"/>
        </notification>
    
        <notification autoSubscribed="false" availableIn="Workspace" channel="email" enabled="true" label="label.nuxeo.notifications.create" name="Creation" subject="${docTitle} has been created by ${author}" template="modif">
          <event name="documentCreated"/>
        </notification>
    
        <notification autoSubscribed="true" availableIn="Section" channel="email" enabled="true" label="label.nuxeo.notifications.publication" name="Publication" subject="Document published" template="publish">
          <event name="documentPublicationApproved"/>
          <event name="documentPublicationRejected"/>
          <event name="documentPublished"/>
        </notification>
    
        <notification autoSubscribed="false" availableIn="Section" channel="email" enabled="true" label="label.nuxeo.notifications.publication" name="PublicationOnClient" subject="Document published" template="publish">
          <event name="documentPublicationApproved"/>
          <event name="documentPublished"/>
        </notification>
    
        <notification autoSubscribed="false" availableIn="Workspace" channel="email" enabled="true" label="label.nuxeo.notifications.workflow" name="Workflow Change" subject="Workflow event" template="workflow">
          <event name="workflowNewProcessStarted"/>
          <event name="workflowProcessEnded"/>
          <event name="workflowProcessCanceled"/>
          <event name="workflowAbandoned"/>
          <event name="workflowTaskCompleted"/>
          <event name="workflowTaskRejected"/>
          <event name="workflowTaskAssigned"/>
        </notification>
    
        <notification autoSubscribed="false" availableIn="Workspace" channel="email" enabled="true" label="label.nuxeo.notifications.appReviewStarted" name="Approbation review started" subject="Review started for ${docTitle}" template="aprobationWorkflowStarted">
          <event name="workflowNewProcessStarted"/>
        </notification>
    
        <notification autoSubscribed="true" availableIn="Workspace" channel="email" enabled="true" label="label.nuxeo.notifications.appReviewStarted" name="Task assigned" subject="Task Assigned for ${docTitle}" template="workflowTaskAssigned">
          <event name="workflowTaskAssigned"/>
        </notification>
    
        <notification autoSubscribed="true" availableIn="all" channel="email" enabled="true" label="label.nuxeo.notifications.email.document" name="Email document" subject="${subject}" template="emailDocument">
          <event name="emailDocumentSend"/>
        </notification>
    
      </extension>
  • nuxeo-platform-document-routing-core-5.6.jar
    <extension point="notifications" target="org.nuxeo.ecm.platform.ec.notification.service.NotificationService">
    
        <notification enabled="false" name="Task assigned">
          <event name="workflowTaskAssigned"/>
        </notification>
        <notification autoSubscribed="true" availableIn="Workspace" channel="email" enabled="true" label="label.nuxeo.notifications.appReviewStarted" name="Task assigned" subject="Task Assigned for ${docTitle}" template="workflowTaskAssigned" templateExpr="NotificationContext['taskInstance'].getVariable('taskNotificationTemplate')">
          <event name="workflowTaskAssigned"/>
        </notification>
    
      </extension>