Query-Objects
Query-Objects Webject は、Windchill オブジェクトをフェッチまたは照会します。オブジェクトは、OBJECT_REF パラメータを指定し、ATTRIBUTE パラメータで読み込む属性のリストを指定することによって、明示的に読み込むことができます。
TYPE パラメータでオブジェクトのタイプを指定し、WHERE パラメータで 1 つまたは複数のサーチ基準 (サーチを制限するため) を指定し、ATTRIBUTE パラメータで結果に返す属性を指定することによって、オブジェクトを検索できます。
WHERE パラメータの使用の詳細については、
TYPE および WHERE パラメータの指定を参照してください。
構文
<ie:webject name="Query-Objects" type="OBJ">
<ie:param name="ACCEPT_LANGUAGE"
data="$(@SERVER[]accept_language[])"/>
<ie:param name="ATTRIBUTE" data="attribute"/>
<ie:param name="AUTHORIZATION"
data="$(@SERVER[]authorization[0])"/>
<ie:param name="CASE_IGNORE" data="[TRUE | FALSE]"/>
<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="DESCRIPTOR" data="attribute_name"/>
<ie:param name="FORMAT" data="[TRUE | FALSE]"/>
<ie:param name="GROUP_FILTER" data="group_name"/>
<ie:param name="GROUP_IN" data="group_in" />
<ie:param name="GROUP_OUT" data="group_out"/>
<ie:param name="INCLUDE_ARGS" data="[TRUE | FALSE]"/>
<ie:param name="INCLUDE_CONSTRAINTS" data="[TRUE | FALSE]"/>
<ie:param name="INCLUDE_DESCRIPTORS" data="[TRUE | FALSE]"/>
<ie:param name="INSTANCE" data="appl_name"/>
<ie:param name="NEXT_OP" data="operation_name"/>
<ie:param name="OBJECT_REF" data="ufid"/>
<ie:param name="PAGE_COUNT" data="pageCount"/>
<ie:param name="PAGE_OFFSET" data="pageOffset"/>
<ie:param name="PAGING_SESSION_ID" data="pagingSessionId"/>
<ie:param name="PASSWD" data="password"/>
<ie:param name="PURGE_DEFAULT" data="[TRUE | FALSE]"/>
<ie:param name="REFERENCE_DELIMITER" data="^" />
<ie:param name="REFERENCE_EXCEPTIONS" data="[TRUE | FALSE]"/>
<ie:param name="REFERENCE_OUTPUT_DELIMITER" data="^" />
<ie:param name="SESSION_ID" data="$(session[]session_id[])"/>
<ie:param name="SORTBY" data="sortBy"/>
<ie:param name="SORTED" data="sorted"/>
<ie:param name="TYPE" data="type_name"/>
<ie:param name="UNFORMATTED" data="dataType" />
<ie:param name="WHERE" data="where_clause"/>
<ie:param name="WHERE_CASE_SENSITIVITY" data="[TRUE | FALSE]"/>
</ie:webject>
パラメータ
|
必須
|
相互依存
|
オプション
|
|
INSTANCE
|
AUTHORIZATION
|
ACCEPT_LANGUAGE
|
|
CASE_IGNORE
|
ATTRIBUTE
|
|
CONTAINER_REF
|
CONNECTION_ATTEMPTS
|
|
DBUSER
|
CONNECTION_ATTEMPT_INTERVAL
|
|
DESCRIPTOR
|
FORMAT
|
|
GROUP_FILTER
|
GROUP_IN
|
|
INCLUDE_ARGS
|
GROUP_OUT
|
|
INCLUDE_CONSTRAINTS
|
PAGE_OFFSET
|
|
INCLUDE_DESCRIPTORS
|
PAGING_SESSION_ID
|
|
NEXT_OP
|
PURGE_DEFAULT
|
|
OBJECT_REF
|
REFERENCE_DELIMITER
|
|
PAGE_COUNT
|
REFERENCE_OUTPUT_DELIMITER
|
|
PASSWD
|
SESSION_ID
|
|
REFERENCE_EXCEPTIONS
|
SORTBY
|
|
TYPE
|
SORTED
|
|
WHERE
|
UNFORMATTED
|
|
WHERE_CASE_SENSITIVITY
|
|
|
|
表に記載されているパラメータの定義が以下にない場合、そのパラメータは共通の定義を持っています。これらのパラメータの説明については、 アダプタ Webject の概要の「一般 Webject パラメータ」セクションを参照してください。 |
CASE_IGNORE
並べ替えで大文字と小文字を区別するかどうかを決定します。
CONTAINER_REF
Webject を適用する対象となる Windchill コンテキスト。このパラメータは以下のタイプの入力を受け取ります。
• Windchill コンテキストの UFID。このパラメータには複数の UFID を指定できます。
• MEMBERSHIP - ユーザーがメンバーになっているコンテキストのみが照会されます。
GROUP_IN
エレメントごとに 1 つの UFID が含まれている入力グループの名前 (OBID 属性)。このパラメータはオプションです。
GROUP_OUT
結果を含む出力グループの名前。このパラメータが省略されると、出力グループの名前は文字列 "_Output" を Webject 名に追加することで構築されます。このパラメータはオプションです。
OBJECT_REF
Windchill オブジェクトの Unique Federation Identifier (UFID)。複数の値を指定して複数のオブジェクトを識別できます。
このパラメータは、WHERE の代わりに、または WHERE と組み合わせて使用できます。WHERE を指定しない場合は、OBJECT_REF を指定する必要があります。
PAGE_COUNT
ページごとの照会で、1 ページあたり返すオブジェクトの数を指定します。PAGING_SESSION_ID なしで PAGE_COUNT を指定すると新しいページングセッションが設定されます。ページングセッションでの続きのページは、PAGING_SESSION_ID、PAGE_COUNT、PAGE_OFFSET を指定することによって読み取ることができます。
SORTED および SORTBY はページごとの照会コンテキストでのみ使用できます。したがって、PAGE_COUNT が指定されていなければ無視されます。
PAGE_OFFSET
次の結果セットをページングセッションのどこから取得するかを指定します。このパラメータはオプションです。
PAGING_SESSION_ID
現在のページングセッションの一意の識別子。このパラメータの結果全体の値とサイズは、GROUP_OUT パラメータのメタデータから取得できます。
メタデータのキーは com.ptc.windchill.pagingSession.id および com.ptc.windchill.pagingSession.size です。
このパラメータが存在する場合、結果の次のページがページングセッションから呼び出されます。存在しない場合は、新しい照会が実行されます。このパラメータはオプションです。
PURGE_DEFAULT
返されるグループから推奨値をパージするかどうかを指定します。TRUE または FALSE を指定します。このパラメータのデフォルト値は FALSE です。パラメータを TRUE に設定すると、返されるグループから推奨値がパージされます。このパラメータはオプションです。
SORTBY
照会で並べ替えて返される一連の属性を指定します。属性の並べ替え順は SORTED パラメータで指定されます。
このパラメータには複数の値を指定できます。複数の値が指定された場合、第 1 の値が最初の並べ替え属性、第 2 の値がその次の並べ替え属性になります。
複数の値が含まれており、SORTED パラメータのリストが SORTBY パラメータのリストより短い場合、最後の SORTED は差に使用されます。
例:
SORTBY=a SORTED=ASC
SORTBY=b SORTED=DESC
SORTBY=c
SORTBY=d
c と d の両方で降順の並べ替えが使用されます。SORTED を指定しない場合、すべての SORTBY の値でデフォルト値の昇順が使用されます。このパラメータはオプションです。
SORTED
現在の属性を降順 (DESC) で並べ替えるか、昇順 (ASC) で並べ替えるかを指定します。このパラメータには複数の値を指定できます。デフォルト値は ASC です。このパラメータはオプションです。
SORTBY パラメータが指定されている場合にのみ、SORTED で出力の並べ替えが行われます。
TYPE
Windchill オブジェクトタイプの名前。WHERE を指定した場合、TYPE も指定する必要があります。
WHERE を指定するか、PAGING_SESSION_ID および ATTRIBUTE を一緒に指定しないと、TYPE は無視されます。ページング照会結果から後続のページを呼び出して、ATTRIBUTE パラメータを指定する場合、返す正しい基本属性のコンテキストを適切に検索するために TYPE パラメータが必要です。
WHERE
照会するオブジェクトを識別する照会定義式。詳細については、
TYPE および WHERE パラメータの指定を参照してください。
OBJECT_REF パラメータまたは TYPE および WHERE のいずれかが必要です。
