Personnalisation avancée > Adaptateur Windchill > Windchill Adapter Webject Library > Action Webjects > Subscribe-Objects
  
Subscribe-Objects
The Subscribe-Objects webject subscribes the specified participants (users or groups) to a modeled Windchill event for the specified instance or instances of the class. A subscription can be applied to a single iteration or version of an object.
Syntax
<ie:webject name="Subscribe-Objects" type="ACT">
<ie:param name="ACCEPT_LANGUAGE
data="$(@SERVER[]accept_language[])"/>
<ie:param name="ALL_VERSIONS" data="[True | False]"/>
<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="user"/>
<ie:param name="EVENT_FILTER" data="event_filter"/>
<ie:param name="EVENT_KEY" data="event_key"/>
<ie:param name="EXPIRATION" data="yyyy-mm-dd"/>
<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="MESSAGE_BODY" data="message"/>
<ie:param name="NAME" data="subscription_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="SUBJECT" data="subject"/>
<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
ALL_VERSIONS
DBUSER
CONNECTION_ATTEMPTS
GROUP_IN
CONNECTION_ATTEMPT_INTERVAL
OBJECT_REF
EVENT_FILTER
PASSWD
EXPIRATION
SUBSCRIBER_REF
GROUP_OUT
TYPE
MESSAGE_BODY
WHERE
NAME
WHERE_CASE_SENSITIVITY
SESSION_ID
SUBJECT
* 
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 section Common Webject Parameters in Adapter Webjects Overview.
ALL_VERSIONS
Represents whether or not the subscription should be applied to all versions or an object. The default value is FALSE. This parameter is optional.
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_FILTER
A filter for the event. The format of this parameter is name=value.
name is a property name from <Model>RB.rbinfo. For example state from lifecycleModelRB.rbInfo
value is the database value that the named attribute must have in order for the notification to occur. For example RELEASED for the example above.
This parameter can be specified more than once. This parameter is optional.
EVENT_KEY
Specifies the Windchill event to subscribe to. See notify.properties for a list of possible events.
For example, for a wt.part.WTPart you can subscribe to 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.
EXPIRATION
The expiration of the subscription. The date specified must be a time in the future. The syntax for the expiration is yyyy-mm-dd. If this parameter is not specified, then the subscription does not expire. This parameter is optional.
GROUP_IN
Specifies a group containing subscribers. The GROUP_IN parameter value is obtained from Query-Objects webject specified within the same task file. One or both of SUBSCRIBER_REF or GROUP_IN parameters are required. If both SUBSCRIBER_REF and  GROUP_IN parameters are specified, the subscribers are the union of the two.
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.
MESSAGE_BODY
The message body of the email notification sent out as a result of a subscription to an object event. If this parameter is not specified, then the message body is empty. This parameter is optional.
NAME
Identifies the name of the subscription. 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.
SUBJECT
The subject of the email notification sent out as a result of a subscription to an object event. If this parameter is not specified, then the subject is empty. This parameter is optional.
SUBSCRIBER_REF
The UFID of the subscriber who is subscribing. The SUBSCRIBER_REF can be a user, group, team, or any class that implements wt.notify.ObjectSubscriptionListener. One or both of SUBSCRIBER_REF or GROUP_IN parameters are required.
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.