Unsubscribe-Objects
The Unsubscribe-Objects webject unsubscribes participants (users or groups) from a Windchill event for the specified instance or instances of the class.
Syntax
<ie:webject name="Unsubscribe-Objects" type="ACT">
<ie:param name="ACCEPT_LANGUAGE"
data="$(@SERVER[]accept_language[])"/>
<ie:param name="AUTHORIZATION"
data="$(@SERVER[]authorization[0])"/>
<ie:param name="CONNECTION_ATTEMPTS" data="attempts"/>
<ie:param name="CONNECTION_ATTEMPT_INTERVAL" data="interval"/>
<ie:param name="CONTAINER_REF" data="[ufid | MEMBERSHIP]"/>
<ie:param name="DBUSER" data="username"/>
<ie:param name="EVENT_KEY" data="event key"/>
<ie:param name="GROUP_IN" data="group_in"/>
<ie:param name="GROUP_OUT" data="group_out"/>
<ie:param name="INSTANCE" data="appl_name"/>
<ie:param name="OBJECT_REF" data="ufid"/>
<ie:param name="PASSWD" data="password"/>
<ie:param name="SESSION_ID" data="$(session[]session_id[])"/>
<ie:param name="SUBSCRIBER_REF" data="subscriber_obid"/>
<ie:param name="TYPE" data="type_name"/>
<ie:param name="WHERE" data="where_clause"/>
<ie:param name="WHERE_CASE_SENSITIVITY" data="[TRUE | FALSE]"/>
</ie:webject>
Parameters
|
Required
|
Interdependent
|
Optional
|
|
EVENT_KEY
|
AUTHORIZATION
|
ACCEPT_LANGUAGE
|
|
INSTANCE
|
CONTAINER_REF
|
CONNECTION_ATTEMPTS
|
|
DBUSER
|
CONNECTION_ATTEMPT_INTERVAL
|
|
OBJECT_REF
|
GROUP_IN
|
|
PASSWD
|
GROUP_OUT
|
|
SUBSCRIBER_REF
|
SESSION_ID
|
|
TYPE
|
|
|
WHERE
|
|
|
WHERE_CASE_SENSITIVITY
|
|
|
|
If a parameter is listed in the table but is not defined below, then it has a common parameter definition. For descriptions of those parameters, see the Common Webject Parameters section in Adapter Webjects Overview. |
CONTAINER_REF
A Windchill context to apply the webject against. This parameter accepts the following types of input:
• The UFID of a Windchill context. Multiple UFIDs can be specified for this parameter.
• MEMBERSHIP—The query finds only those contexts of which the user is a member.
When this parameter is specified, the scope of queries executed against the TYPE and WHERE parameters are restricted to the associated context.
EVENT_KEY
The Windchill event to unsubscribe from. See notify.properties for a list of possible events.
For example, for a wt.part.WTPart you can use the following event:
*/wt.vc.wip.WorkInProgressServiceEvent/POST_CHECKOUT
The format to specify an event key starts with an asterisk (*), then the class name, followed by a slash (/), and then the event marker. For example, */classroom/event-marker. This parameter is required.
GROUP_IN
Specifies a group containing unsubscribers. The GROUP_IN parameter value is obtained from Query-Objects webject specified within the same task file.
This parameter can be used instead of or in combination with SUBSCRIBER_REF to specify unsubscribers. If both SUBSCRIBER_REF and GROUP_IN parameters are specified, the unsubscribers are the union of the two. If neither of them is specified, the unsubscribers is all. This parameter is optional.
GROUP_OUT
The name of the output group containing the results. If this parameter is omitted, then the name of the output group is constructed by appending the string “-Output” to the webject name. This parameter is optional.
OBJECT_REF
The Unique Federation Identifier (UFID) of a Windchill object. Multiple values can be specified for this parameter to identify multiple objects.
This parameter can be used instead of or in combination with WHERE. If WHERE is not specified, then OBJECT_REF must be specified.
SUBSCRIBER_REF
The UFID of the subscriber who is unsubscribing. The SUBSCRIBER_REF can be a user, group, team, or any class that implements wt.notify.ObjectSubscriptionListener.
This parameter can be used instead of or in combination with GROUP_IN to specify unsubscribers. If both SUBSCRIBER_REF and GROUP_IN parameters are specified, the unsubscribers are the union of the two. If neither of them is specified, the unsubscribers are all. This parameter is optional.
TYPE
Specifies the name of the notifiable Windchill type of the objects to be queried for. If WHERE is specified, then TYPE must also be specified. OBJECT_REF can be specified instead of, or in addition to, this parameter.
WHERE
A query expression identifying the objects for which to query. This parameter can be used instead of or in combination with OBJECT_REF.
If OBJECT_REF is not specified, WHERE must be specified. If WHERE is specified, TYPE must also be specified. For more information, see
Specifying the TYPE and WHERE Parameters.
