IPP-send-alert

Description

This handler sends the alert to the logged user. These alerts can be viewed in the Alerts section of the Active Workspace. Alert messages are configured in the handler argument.

Syntax

IPP-send-alert

Arguments

-subject The subject text for the alert.

-msg_text The message body text for the alert.

-object_from_attach Specifies the type of attachment (TARGET or REFERENCE) from which the attached object should be selected.

-object_type Specifies the object type which should be selected. Alert message will be sent with reference to this object.

Placement

Requires no specific placement.

Restrictions

None.

Examples

Argument	Value
-subject	Clone WBS Root
-msg_text	Clone WBS Root completed
-object_from_attach	REFERENCE
-object_from_attach	Wbs0RootRevision

In this example, the handler will find the Wbs0RootRevision objects from the REFERENCE attachments and send an alert with reference to this object with the alert subject Clone WBS Root and alert body text Clone WBS Root completed.

(Note: the source documentation lists -object_from_attach twice in this example table; the second occurrence likely corresponds to the -object_type argument, e.g. Wbs0RootRevision.)