Unsubscribe-Event
DESCRIPTION
Causes Info*Engine to cease listening for a particular event that is currently being monitored. When the execution of the webject completes successfully, an empty status group with the status of 0 is returned with a message relaying successful unsubscription from the event. If the execution of the webject completes unsuccessfully, an appropriate exception is thrown.
SYNTAX
<ie:webject name="Unsubscribe-Event" type="WES">
<ie:param name="EVENT" data="event_name"/>
<ie:param name="GROUP_OUT" data="results"/>
</ie:webject>
PARAMETERS
|
Required
|
Select
|
Optional
|
|
EVENT
|
|
GROUP_OUT
|
|
|
SERVICE
|
EVENT
Specifies the LDAP distinguished name of the event from which to unsubscribe. The value is an LDAP distinguished name relative to a configured base URI. A syntax of <event_name>@<domain> is recommended to give additional meaning and avoid name conflicts. If relative, the cn= (common name attribute) is implicit if not explicitly specified.
This parameter is required if GROUP_IN is not supplied.
GROUP_OUT
Specifies the name of the status group to create upon success. The default behavior for this parameter is to create a group named unsubscribe-results.
This parameter is optional.
SERVICE
Specifies the name of the Info*Engine property set that is configured for connectivity to a specific JMS service. This allows you to configure more than one JMS service per Info*Engine Virtual Machine (VM).
This parameter is optional.
EXAMPLE
The following example unsubscribes the current Info*Engine process to the specified event:
<%@page language="java" session="false"%>
<%@taglib uri="http://www.ptc.com/infoengine/taglib/core"
prefix="ie"%>
<ie:webject name="Unsubscribe-Event" type="WES">
<ie:param name="EVENT" data="$(@FORM[]event[])"/>
<ie:param name="GROUP_OUT" data="$(@FORM[]group_out[])"/>
</ie:webject>
To actually run this example, you need to provide a form where the EVENT and GROUP_OUT variables are identified.