Unsubscribe-Objects
Unsubscribe-Objects Webject は、クラスの特定のインスタンスのモデル化された Windchill イベントから、参加者 (ユーザーまたはグループ) の購読を解除します。
構文
<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>
パラメータ
|
必須
|
相互依存
|
オプション
|
|
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
|
|
|
|
表に記載されているパラメータの定義が以下にない場合、そのパラメータは共通の定義を持っています。これらのパラメータの説明については、 アダプタ Webject の概要の「一般 Webject パラメータ」セクションを参照してください。 |
CONTAINER_REF
Webject を適用する対象となる Windchill コンテキスト。このパラメータは以下のタイプの入力を受け取ります。
• Windchill コンテキストの UFID。このパラメータには複数の UFID を指定できます。
• MEMBERSHIP - ユーザーがメンバーになっているコンテキストのみが照会されます。
このパラメータを指定した場合、TYPE および WHERE パラメータに対して実行される照会の範囲は、関連付けられたコンテキストに限られます。
EVENT_KEY
購読を解除する Windchill イベント。発生するイベントの一覧については、notify.properties を参照してください。
たとえば、wt.part.WTPart の場合、次のイベントを使用できます。
*/wt.vc.wip.WorkInProgressServiceEvent/POST_CHECKOUT
イベントキーを指定するフォーマットは、アスタリスク (*) で始まり、クラス名、スラッシュ (/)、イベントマーカーの順になります。以下に例を示します。*/classroom/event-markerこのパラメータは必須です。
GROUP_IN
購読解除ユーザーのいるグループを指定します。GROUP_IN パラメータ値は、同じタスクファイル内で指定されている Query-Objects Webject から取得します。
このパラメータを SUBSCRIBER_REF の代わりに、または SUBSCRIBER_REF と組み合わせて使用して、購読解除ユーザーを指定できます。SUBSCRIBER_REF パラメータと GROUP_IN パラメータの両方を指定した場合、購読解除ユーザーは 2 つの和集合になります。いずれも指定しない場合、購読解除ユーザーはすべてになります。このパラメータはオプションです。
GROUP_OUT
結果を含む出力グループの名前。このパラメータが省略されると、出力グループの名前は文字列 "_Output" を Webject 名に追加することで構築されます。このパラメータはオプションです。
OBJECT_REF
Windchill オブジェクトの Unique Federation Identifier (UFID)。複数の値を指定して複数のオブジェクトを識別できます。
このパラメータは、WHERE の代わりに、または WHERE と組み合わせて使用できます。WHERE を指定しない場合は、OBJECT_REF を指定する必要があります。
SUBSCRIBER_REF
購読を解除する購読ユーザーの UFID。SUBSCRIBER_REF は、wt.notify.ObjectSubscriptionListener を実装するユーザー、グループ、チーム、または任意のクラスです。
このパラメータを GROUP_IN の代わりに、または GROUP_IN と組み合わせて使用して、購読解除ユーザーを指定できます。SUBSCRIBER_REF パラメータと GROUP_IN パラメータの両方を指定した場合、購読解除ユーザーは 2 つの和集合になります。いずれも指定しない場合、購読解除ユーザーはすべてになります。このパラメータはオプションです。
TYPE
照会するオブジェクトの通知可能な Windchill タイプの名前を指定します。WHERE を指定した場合、TYPE も指定される必要があります。OBJECT_REF はこのパラメータの代わり、または追加として指定できます。
WHERE
照会するオブジェクトを識別する照会定義式。このパラメータは、OBJECT_REF の代わりに、または OBJECT_REF と組み合わせて使用できます。
OBJECT_REF が指定されていない場合、WHERE を指定する必要があります。WHERE を指定した場合、TYPE も指定する必要があります。詳細については、
TYPE および WHERE パラメータの指定を参照してください。
