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