Activity - notification

Activity Type: Notification

Description

Produces a notification message when the output stream of an activity has completed or commenced.

Example

<notification name="notify">
  <notify type="complete"/>
  <dataInput from="queryResults"/>
  <dataOutput name="dataOutput"/>
  <notificationOutput name="notifyOutput"/>
  <message>SQL query activity is complete</message>
</notification>

Specification

Element notification:

• Attribute name (required) - unique name for the activity within the scope of a request.
• Element notify - specify the time when the notification message is sent: at completion of the input stream or when it commences
  • Attribute type (required) - one of the following strings:
    • complete - message is sent when the input stream has completed
    • commenced - message is sent when the input stream has commenced
    • none - default: no notification message will be sent.
• Element dataInput (required) - input stream. The data is piped straight through to the output stream without modifications.
• Element dataOutput (required) - output stream.
• Element message (required) - The notification message of this activity.
• Element notificationOutput (required) - output stream. This output stream can be piped to a delivery activity such as deliverToSMTP in order to send out notification messages by email. If no other activity is connected to this output stream the message will be delivered in the response document.

Data Resource Accessor

This activity can operate with any data resource accessor.

Input and Output Types

• Input: dataInput — Object blocks - this input will not be modified by the activity and can therefore be of any format
• Output: dataOutput — Object blocks
• Output: notificationOutput — a single String block

XML Schema

OGSA-DAI/schema/ogsadai/xsd/activities/notification.xsd

Class

uk.org.ogsadai.activity.delivery.NotificationActivity

Client Toolkit Class

uk.org.ogsadai.client.toolkit.activity.misc.Notification