Indexed-Search
Indexed-Search Webject は、Windchill オブジェクトのインデックシングコンテンツについてインデックシングエンジンを照会します (インデックスサーチがインストールされている場合)。
キーワード文字列を入力として受け取り、XML フォーマットの結果を返します。そのオブジェクトに関連付けられた各コンテンツアイテムには、UFID (obid)、オブジェクトクラス、探索が含まれます。1 つ以上の修正候補が含まれる場合もあります。
構文
<ie:webject name="Indexed-Search" type="OBJ">
<ie:param name="ACCEPT_LANGUAGE"
data="$(@SERVER[]accept_language[])"/>
<ie:param name="AND_OR_OPERATOR" data="[SIMPLEANY | SIMPLEALL]"/>
<ie:param name="ATTRIBUTE_TYPE_CONTEXT" data="attributes"/>
<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"/>
<ie:param name="FETCH_FIELDS" data="fields"/>
<ie:param name="FILTER_ACCESS" data="[TRUE | FALSE]"/>
<ie:param name="GROUP_OUT" data="group_out"/>
<ie:param name="INSTANCE" data="appl_name"/>
<ie:param name="KEYWORD" data="keyword"/>
<ie:param name="LIBRARIES" data="libraries"/>
<ie:param name="MAX_DOCS" data="number"/>
<ie:param name="QUERY_TYPE" data="query"/>
<ie:param name="SEARCH_TIME" data="time"/>
<ie:param name="SESSION_ID" data="$(session[]session_id[])"/>
<ie:param name="SPELL_CHECK" data="[TRUE | FALSE]"/>
<ie:param name="SORTBY" data="attribute"/>
<ie:param name="SORTED" data="[ASC | DESC]"/>
<ie:param name="TYPE" data="type_name"/>
<ie:param name="TYPE_CONTAINER" data="context"/>
<ie:param name="UNFORMATTED" data="javaClass"/>
<ie:param name="WHERE" data="where_clause"/>
</ie:webject>
パラメータ
|
必須
|
相互依存
|
オプション
|
|
AND_OR_OPERATOR
|
AUTHORIZATION
|
ACCEPT_LANGUAGE
|
|
INSTANCE
|
ATTRIBUTE_TYPE_CONTEXT
|
CONNECTION_ATTEMPTS
|
|
KEYWORD
|
CONNECTION_ATTEMPT_INTERVAL
|
|
LIBRARIES
|
CONTAINER_REF
|
|
TYPE_CONTAINER
|
FETCH_FIELDS
|
|
|
FILTER_ACCESS
|
|
|
GROUP_OUT
|
|
|
MAX_DOCS
|
|
|
QUERY_TYPE
|
|
|
SEARCH_TIME
|
|
|
SPELL_CHECK
|
|
|
SORTED
|
|
|
SORTBY
|
|
|
TYPE
|
|
|
UNFORMATTED
|
|
|
WHERE
|
|
|
表に記載されているパラメータの定義が以下にない場合、そのパラメータは共通の定義を持っています。これらのパラメータの説明については、 アダプタ Webject の概要の「一般 Webject パラメータ」セクションを参照してください。 |
AND_OR_OPERATOR
InStream 照会で SIMPLEANY (OR) または SIMPLEALL (AND) を使用するかどうかを決定します。このパラメータは必須です。
ATTRIBUTE_TYPE_CONTEXT
複数のタイプを指定する場合、このタイプによって、属性定義を検索するためにコンテキストとして使用するタイプを指定します。
CONTAINER_REF
サーチ結果をフィルタリングして、コンテキスト参照内のオブジェクトのみを表示します。このパラメータはオプションです。
FETCH_FIELDS
インデックスサーチに保存され照会の一部として読み取られるフィールドのセットを指定します。
リクエストされるデフォルトのフィールドは PersistInfoOID です。このフィールドは、Search-Objects が Indexed-Search Webject の結果から結果を読み取るときに使用します。このパラメータはオプションです。
FILTER_ACCESS
TRUE に設定すると、インデックシングエンジンは結果をフィルタ処理し、"ポテンシャル" 読み取りリストにします。このパラメータはオプションです。
GROUP_OUT
結果を含む出力グループの名前。このパラメータが省略されると、出力グループの名前は文字列 "_Output" を Webject 名に追加することで構築されます。このパラメータはオプションです。
KEYWORD
インデックスサーチで照会するキーワード文字列を識別する照会定義式。
LIBRARIES
サーチ対象とするインデックスサーチライブラリ (インデックス) のセット。
MAX_DOCS
サーチ時に返されるドキュメントの最大数。このパラメータはオプションです。
QUERY_TYPE
サーチでアドバンスを使用するか、単純なサーチ機能を使用するかを決定します。このパラメータはオプションです。
SEARCH_TIME
タイムアウトする前にインデックスエンジンがサーチを実行する必要がある秒数。このパラメータはオプションです。
SPELL_CHECK
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 オブジェクトタイプ。たとえば、wt.part.WTPart や wt.doc.WTDocument です。
TYPE_CONTAINER
受信タイプパラメータからサーチで使用される基本タイプのセットを決定します。
WHERE
指定すると、インデックシングツールは where 節に基づいて結果のフィルタ処理を試みます。
