Search-Objects
Search-Objects Webject は、モデル属性値とグローバル属性値の両方に基づいて 1 回の照会で複数のタイプの検索を行う、フェデレーションサーチ機能を提供します。グローバル属性、モデル属性、および派生属性を結果セットに返すことができます。
構文
<ie:webject name="Search-Objects" type="OBJ">
<ie:param name="ACCEPT_LANGUAGE"
data="$(@SERVER[]accept_language[])"/>
<ie:param name="ATTRIBUTE" data="attribute"/>
<ie:param name="ATTRIBUTE_TYPE_CONTEXT"
data="attributeTypeContext"/>
<ie:param name="AUTHORIZATION"
data="$(@SERVER[]authorization[0])"/>
<ie:param name="COMPONENT_ID" data="componentId"/>
<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="CONTAINER_TYPE" data="containerType"/>
<ie:param name="DBUSER" data="username"/>
<ie:param name="FORMAT" data="[TRUE | FALSE]"/>
<ie:param name="GROUP_OUT" data="group_out"/>
<ie:param name="INSTANCE" data="appl_name"/>
<ie:param name="ITERATION" data="[ALL | LATEST]"/>
<ie:param name="MEMBER_OF" data="memberOf"/>
<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="SORTBY" data="sortBy"/>
<ie:param name="SORTED" data="sorted"/>
<ie:param name="TYPE" data="type"/>
<ie:param name="UNFORMATED" data="dataType" />
<ie:param name="VERSION" data="[ALL | LATEST]"/>
<ie:param name="WHERE" data="where_clause"/>
</ie:webject>
パラメータ
|
必須
|
相互依存
|
オプション
|
|
INSTANCE
|
ATTRIBUTE_TYPE_CONTEXT
|
ACCEPT_LANGUAGE
|
|
WHERE
|
AUTHORIZATION
|
ATTRIBUTE
|
|
CONTAINER_REF
|
COMPONENT_ID
|
|
DBUSER
|
CONNECTION_ATTEMPTS
|
|
PASSWD
|
CONNECTION_ATTEMPT_INTERVAL
|
|
TYPE
|
CONTAINER_TYPE
|
|
|
FORMAT
|
|
|
GROUP_OUT
|
|
|
ITERATION
|
|
|
MEMBER_OF
|
|
|
PAGE_COUNT
|
|
|
PAGE_OFFSET
|
|
|
PAGING_SESSION_ID
|
|
|
SORTBY
|
|
|
SORTED
|
|
|
UNFORMATTED
|
|
|
VERSION
|
|
|
表に記載されているパラメータの定義が以下にない場合、そのパラメータは共通の定義を持っています。これらのパラメータの説明については、 アダプタ Webject の概要の「一般 Webject パラメータ」セクションを参照してください。 |
ATTRIBUTE_TYPE_CONTEXT
指定された属性がサーチされるコンテキストのタイプを指定します。
TYPE が 1 つだけ指定され、それが空白になっている場合、ATTRIBUTE_TYPE_CONTEXT の値はデフォルトの TYPE になります。
複数のタイプが指定されている場合、このパラメータを指定する必要があります。指定しないと例外が発生します。ほとんどの複数タイプサーチでは、これは wt.fc.Persistable に設定しておきます。
COMPONENT_ID
検索を呼び出すクライアントコンポーネントを指定する文字列。com/ptc/windchill/enterprise/search/server/SearchableTypes.properties で定義されたとおり、照会の対象となるクラスのリストの選択に使用します。
このパラメータはオプションです。
CONTAINER_REF
Webject を適用する対象となる Windchill コンテキスト。このパラメータは以下のタイプの入力を受け取ります。
• Windchill コンテキストの UFID。このパラメータには複数の UFID を指定できます。
• MEMBERSHIP - ユーザーがメンバーになっているコンテキストのみが照会されます。
このパラメータを指定した場合、TYPE および WHERE パラメータに対して実行される照会の範囲は、関連付けられたコンテキストに限られます。
CONTAINER_TYPE
照会対象を制約するために 1 つのコンテキストタイプ。このパラメータはオプションです。
GROUP_OUT
結果を含む出力グループの名前。このパラメータが省略されると、出力グループの名前は文字列 "_Output" を Webject 名に追加することで構築されます。このパラメータはオプションです。
ITERATION
作業版数が適用されたオブジェクトのすべてまたは最新の作業版数が結果のどこに返されるかを指定します。使用可能な値は ALL または LATEST です。このパラメータのデフォルトは LATEST です。このパラメータはオプションです。
MEMBER_OF
現在のユーザーがメンバーであるコンテキストに対する照会を制約するかどうかを指定します。このパラメータはオプションです。
PAGE_COUNT
照会結果で、ページごとに返されるオブジェクトの数。このパラメータはオプションです。
PAGE_OFFSET
ページごとの照会結果について、オフセットを行うオブジェクトの数。このパラメータはオプションです。
PAGING_SESSION_ID
現在のページングセッションの一意の識別子。これは、システムによって生成される値で、照会結果の出力グループに追加されます。
PAGING_SESSION_ID を指定する場合は、結果の次のページがフェッチされます。存在しない場合は、新しい照会が実行されます。
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 オブジェクトタイプ。たとえば、wt.part.WTPart や wt.doc.WTDocument です。複数のタイプを指定する場合は、ATTRIBUTE_TYPE_CONTEXT も指定する必要があります。
VERSION
この結果のバージョン付きオブジェクトのすべて、最後、または指定されたバージョンをどこに返すかを指定します。使用可能な値は ALL、LATEST、SPECIFIC です。このパラメータのデフォルトは ALL です。このパラメータはオプションです。
WHERE
(attribute name = 'value') ペアのように、where 節を指定します。属性は、TYPE パラメータで指定したオブジェクトタイプの有効な属性にする必要があります。
where 節を指定するときは、以下の点に注意して適切な構文を入力します。
• 属性構文:
1 つの属性ケースに対して where 節を作成する場合、以下が適切な構文です。
<ie:param name="WHERE" data="(name='1660043')"/>
複数の属性ケースに対して where 節を作成する場合、以下が適切な構文です。
◦ OR の場合:
<ie:param name="WHERE" data="((name='1660043')|(number="1"))"/>
◦ AND の場合:
<ie:param name="WHERE" data="((name='1660043')&(number="1"))"/>
• ワイルドカード構文:
この節で使用するワイルドカードは、アスタリスク (*) です。ワイルドカードを使用する場合の適切な構文は以下のとおりです。
<ie:param name="WHERE" data="(name='*abc*')"/>
• バックスラッシュ
属性名フィールドでバックスラッシュ (\) を使用する場合、最初のバックスラッシュの前に 3 つのバックスラッシュを付けることで \ をエスケープします。たとえば、この Webject を使用して test\part0 という名前の部品を検索する場合、where 節の適切な構文は以下のようになります。
<ie:param name="WHERE" data="(name='test\\\\part0')"/>
ワイルドカードを使用して、属性名フィールドにバックスラッシュ (\) を含むオブジェクトをサーチする場合も、最初のバックスラッシュの前に 3 つのバックスラッシュを付けるという同じ手順を使用します。たとえば、以下の構文では、属性名に \ を含むすべてのオブジェクトを検索します。
<ie:param name="WHERE" data="(name='*\\\\*')"/>
このパラメータは必須です。where 節で指定する属性がない場合、"()" にする必要があります。
